Skip to content

Commit 2981d28

Browse files
authored
docs: update blas/ext/base/dfill to follow current project conventions
PR-URL: #5171 Reviewed-by: Athan Reines <[email protected]>
1 parent 52b4dad commit 2981d28

File tree

8 files changed

+32
-32
lines changed

8 files changed

+32
-32
lines changed

lib/node_modules/@stdlib/blas/ext/base/dfill/README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var dfill = require( '@stdlib/blas/ext/base/dfill' );
3232

3333
#### dfill( N, alpha, x, strideX )
3434

35-
Fills a double-precision floating-point strided array `x` with a specified scalar constant `alpha`.
35+
Fills a double-precision floating-point strided array with a specified scalar constant.
3636

3737
```javascript
3838
var Float64Array = require( '@stdlib/array/float64' );
@@ -48,9 +48,9 @@ The function has the following parameters:
4848
- **N**: number of indexed elements.
4949
- **alpha**: scalar constant.
5050
- **x**: input [`Float64Array`][@stdlib/array/float64].
51-
- **strideX**: index increment.
51+
- **strideX**: stride length.
5252

53-
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element
53+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element:
5454

5555
```javascript
5656
var Float64Array = require( '@stdlib/array/float64' );
@@ -79,7 +79,7 @@ dfill( 3, 5.0, x1, 2 );
7979

8080
#### dfill.ndarray( N, alpha, x, strideX, offsetX )
8181

82-
Fills a double-precision floating-point strided array `x` with a specified scalar constant `alpha` using alternative indexing semantics.
82+
Fills a double-precision floating-point strided array with a specified scalar constant using alternative indexing semantics.
8383

8484
```javascript
8585
var Float64Array = require( '@stdlib/array/float64' );
@@ -94,7 +94,7 @@ The function has the following additional parameters:
9494

9595
- **offsetX**: starting index.
9696

97-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`
97+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements:
9898

9999
```javascript
100100
var Float64Array = require( '@stdlib/array/float64' );
@@ -170,7 +170,7 @@ console.log( x );
170170

171171
#### stdlib_strided_dfill( N, alpha, \*X, strideX )
172172

173-
Fills a double-precision floating-point strided array `X` with a specified scalar constant `alpha`.
173+
Fills a double-precision floating-point strided array with a specified scalar constant.
174174

175175
```c
176176
double x[] = { 1.0, 2.0, 3.0, 4.0 };
@@ -183,15 +183,15 @@ The function accepts the following arguments:
183183
- **N**: `[in] CBLAS_INT` number of indexed elements.
184184
- **alpha**: `[in] double` scalar constant.
185185
- **X**: `[out] double*` input array.
186-
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
186+
- **strideX**: `[in] CBLAS_INT` stride length.
187187
188188
```c
189189
void stdlib_strided_dfill( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX );
190190
```
191191

192192
#### stdlib_strided_dfill_ndarray( N, alpha, \*X, strideX, offsetX )
193193

194-
Fills a double-precision floating-point strided array `X` with a specified scalar constant `alpha` using alternative indexing semantics.
194+
Fills a double-precision floating-point strided array with a specified scalar constant using alternative indexing semantics.
195195

196196
```c
197197
double x[] = { 1.0, 2.0, 3.0, 4.0 };
@@ -204,8 +204,8 @@ The function accepts the following arguments:
204204
- **N**: `[in] CBLAS_INT` number of indexed elements.
205205
- **alpha**: `[in] double` scalar constant.
206206
- **X**: `[out] double*` input array.
207-
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
208-
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
207+
- **strideX**: `[in] CBLAS_INT` stride length.
208+
- **offsetX**: `[in] CBLAS_INT` starting index.
209209
210210
```c
211211
void stdlib_strided_dfill_ndarray( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );

lib/node_modules/@stdlib/blas/ext/base/dfill/docs/repl.txt

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( N, alpha, x, strideX )
33
Fills a double-precision floating-point strided array with a specified
4-
scalar value.
4+
scalar constant.
55

66
The `N` and stride parameters determine which elements in the strided array
77
are accessed at runtime.
@@ -17,13 +17,13 @@
1717
Number of indexed elements.
1818

1919
alpha: number
20-
Constant.
20+
Scalar constant.
2121

2222
x: Float64Array
2323
Input array.
2424

2525
strideX: integer
26-
Index increment for `x`.
26+
Stride length.
2727

2828
Returns
2929
-------
@@ -53,7 +53,7 @@
5353

5454
{{alias}}.ndarray( N, alpha, x, strideX, offsetX )
5555
Fills a double-precision floating-point strided array with a specified
56-
scalar value using alternative indexing semantics.
56+
scalar constant using alternative indexing semantics.
5757

5858
While typed array views mandate a view offset based on the underlying
5959
buffer, the offset parameter supports indexing semantics based on a starting
@@ -65,16 +65,16 @@
6565
Number of indexed elements.
6666

6767
alpha: number
68-
Constant.
68+
Scalar constant.
6969

7070
x: Float64Array
7171
Input array.
7272

7373
strideX: integer
74-
Index increment for `x`.
74+
Stride length.
7575

7676
offsetX: integer
77-
Starting index of `x`.
77+
Starting index.
7878

7979
Returns
8080
-------

lib/node_modules/@stdlib/blas/ext/base/dfill/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface Routine {
2626
* Fills a double-precision floating-point strided array with a specified scalar value.
2727
*
2828
* @param N - number of indexed elements
29-
* @param alpha - constant
29+
* @param alpha - scalar constant
3030
* @param x - input array
3131
* @param strideX - stride length
3232
* @returns input array
@@ -45,7 +45,7 @@ interface Routine {
4545
* Fills a double-precision floating-point strided array with a specified scalar value using alternative indexing semantics.
4646
*
4747
* @param N - number of indexed elements
48-
* @param alpha - constant
48+
* @param alpha - scalar constant
4949
* @param x - input array
5050
* @param strideX - stride length
5151
* @param offsetX - starting index
@@ -66,7 +66,7 @@ interface Routine {
6666
* Fills a double-precision floating-point strided array with a specified scalar value.
6767
*
6868
* @param N - number of indexed elements
69-
* @param alpha - constant
69+
* @param alpha - scalar constant
7070
* @param x - input array
7171
* @param strideX - stride length
7272
* @returns input array

lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ var ndarray = require( './ndarray.js' );
3030
* Fills a double-precision floating-point strided array with a specified scalar constant.
3131
*
3232
* @param {PositiveInteger} N - number of indexed elements
33-
* @param {number} alpha - scalar
33+
* @param {number} alpha - scalar constant
3434
* @param {Float64Array} x - input array
35-
* @param {integer} strideX - index increment
35+
* @param {integer} strideX - stride length
3636
* @returns {Float64Array} input array
3737
*
3838
* @example

lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.native.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ var addon = require( './../src/addon.node' );
2929
* Fills a double-precision floating-point strided array with a specified scalar constant.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
32-
* @param {number} alpha - scalar
32+
* @param {number} alpha - scalar constant
3333
* @param {Float64Array} x - input array
34-
* @param {integer} strideX - index increment
34+
* @param {integer} strideX - stride length
3535
* @returns {Float64Array} input array
3636
*
3737
* @example

lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ var M = 8;
2929
* Fills a double-precision floating-point strided array with a specified scalar constant.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
32-
* @param {number} alpha - scalar
32+
* @param {number} alpha - scalar constant
3333
* @param {Float64Array} x - input array
34-
* @param {integer} strideX - index increment
34+
* @param {integer} strideX - stride length
3535
* @param {NonNegativeInteger} offsetX - starting index
3636
* @returns {Float64Array} input array
3737
*

lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.native.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ var addon = require( './../src/addon.node' );
2929
* Fills a double-precision floating-point strided array with a specified scalar constant.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
32-
* @param {number} alpha - scalar
32+
* @param {number} alpha - scalar constant
3333
* @param {Float64Array} x - input array
34-
* @param {integer} strideX - index increment
34+
* @param {integer} strideX - stride length
3535
* @param {NonNegativeInteger} offsetX - starting index
3636
* @returns {Float64Array} input array
3737
*

lib/node_modules/@stdlib/blas/ext/base/dfill/src/main.c

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424
* Fills a double-precision floating-point strided array with a specified scalar constant.
2525
*
2626
* @param N number of indexed elements
27-
* @param alpha scalar
27+
* @param alpha scalar constant
2828
* @param X input array
29-
* @param strideX index increment
29+
* @param strideX stride length
3030
*/
3131
void API_SUFFIX(stdlib_strided_dfill)( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX ) {
3232
CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX );
@@ -37,9 +37,9 @@ void API_SUFFIX(stdlib_strided_dfill)( const CBLAS_INT N, const double alpha, do
3737
* Fills a double-precision floating-point strided array with a specified scalar constant using alternative indexing semantics.
3838
*
3939
* @param N number of indexed elements
40-
* @param alpha scalar
40+
* @param alpha scalar constant
4141
* @param X input array
42-
* @param strideX index increment
42+
* @param strideX stride length
4343
* @param offsetX starting index
4444
*/
4545
void API_SUFFIX(stdlib_strided_dfill_ndarray)( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) {

0 commit comments

Comments
 (0)