diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/README.md b/lib/node_modules/@stdlib/blas/ext/base/dfill/README.md index 58669f28d7b7..543b86c8e9b5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/README.md @@ -32,7 +32,7 @@ var dfill = require( '@stdlib/blas/ext/base/dfill' ); #### dfill( N, alpha, x, strideX ) -Fills a double-precision floating-point strided array `x` with a specified scalar constant `alpha`. +Fills a double-precision floating-point strided array with a specified scalar constant. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -48,9 +48,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **strideX**: index increment. +- **strideX**: stride length. -The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element: ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -79,7 +79,7 @@ dfill( 3, 5.0, x1, 2 ); #### dfill.ndarray( N, alpha, x, strideX, offsetX ) -Fills a double-precision floating-point strided array `x` with a specified scalar constant `alpha` using alternative indexing semantics. +Fills a double-precision floating-point strided array with a specified scalar constant using alternative indexing semantics. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -94,7 +94,7 @@ The function has the following additional parameters: - **offsetX**: starting index. -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` +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: ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -170,7 +170,7 @@ console.log( x ); #### stdlib_strided_dfill( N, alpha, \*X, strideX ) -Fills a double-precision floating-point strided array `X` with a specified scalar constant `alpha`. +Fills a double-precision floating-point strided array with a specified scalar constant. ```c double x[] = { 1.0, 2.0, 3.0, 4.0 }; @@ -183,7 +183,7 @@ The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] double` scalar constant. - **X**: `[out] double*` input array. -- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **strideX**: `[in] CBLAS_INT` stride length. ```c void stdlib_strided_dfill( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX ); @@ -191,7 +191,7 @@ void stdlib_strided_dfill( const CBLAS_INT N, const double alpha, double *X, con #### stdlib_strided_dfill_ndarray( N, alpha, \*X, strideX, offsetX ) -Fills a double-precision floating-point strided array `X` with a specified scalar constant `alpha` using alternative indexing semantics. +Fills a double-precision floating-point strided array with a specified scalar constant using alternative indexing semantics. ```c double x[] = { 1.0, 2.0, 3.0, 4.0 }; @@ -204,8 +204,8 @@ The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] double` scalar constant. - **X**: `[out] double*` input array. -- **strideX**: `[in] CBLAS_INT` index increment for `X`. -- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **strideX**: `[in] CBLAS_INT` stride length. +- **offsetX**: `[in] CBLAS_INT` starting index. ```c void stdlib_strided_dfill_ndarray( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/repl.txt index bfb452838111..6d761a00ec5f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( N, alpha, x, strideX ) Fills a double-precision floating-point strided array with a specified - scalar value. + scalar constant. The `N` and stride parameters determine which elements in the strided array are accessed at runtime. @@ -17,13 +17,13 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Float64Array Input array. strideX: integer - Index increment for `x`. + Stride length. Returns ------- @@ -53,7 +53,7 @@ {{alias}}.ndarray( N, alpha, x, strideX, offsetX ) Fills a double-precision floating-point strided array with a specified - scalar value using alternative indexing semantics. + scalar constant using alternative indexing semantics. While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting @@ -65,16 +65,16 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Float64Array Input array. strideX: integer - Index increment for `x`. + Stride length. offsetX: integer - Starting index of `x`. + Starting index. Returns ------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/types/index.d.ts index b31a2c3ff00e..709b0d2213e4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/docs/types/index.d.ts @@ -26,7 +26,7 @@ interface Routine { * Fills a double-precision floating-point strided array with a specified scalar value. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array * @param strideX - stride length * @returns input array @@ -45,7 +45,7 @@ interface Routine { * Fills a double-precision floating-point strided array with a specified scalar value using alternative indexing semantics. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array * @param strideX - stride length * @param offsetX - starting index @@ -66,7 +66,7 @@ interface Routine { * Fills a double-precision floating-point strided array with a specified scalar value. * * @param N - number of indexed elements -* @param alpha - constant +* @param alpha - scalar constant * @param x - input array * @param strideX - stride length * @returns input array diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.js b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.js index 76fb64f61b1e..30b5adbb572e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.js @@ -30,9 +30,9 @@ var ndarray = require( './ndarray.js' ); * Fills a double-precision floating-point strided array with a specified scalar constant. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @returns {Float64Array} input array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.native.js b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.native.js index 36c577e707a0..fe69199f00ce 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/dfill.native.js @@ -29,9 +29,9 @@ var addon = require( './../src/addon.node' ); * Fills a double-precision floating-point strided array with a specified scalar constant. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @returns {Float64Array} input array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.js index 09e00d7e932d..efc1e90494cd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.js @@ -29,9 +29,9 @@ var M = 8; * Fills a double-precision floating-point strided array with a specified scalar constant. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index * @returns {Float64Array} input array * diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.native.js index e1274ac611e5..1f6b6de3cebf 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/lib/ndarray.native.js @@ -29,9 +29,9 @@ var addon = require( './../src/addon.node' ); * Fills a double-precision floating-point strided array with a specified scalar constant. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index * @returns {Float64Array} input array * diff --git a/lib/node_modules/@stdlib/blas/ext/base/dfill/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/dfill/src/main.c index f74a0c1b9ab8..4b5f0962954d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dfill/src/main.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dfill/src/main.c @@ -24,9 +24,9 @@ * Fills a double-precision floating-point strided array with a specified scalar constant. * * @param N number of indexed elements -* @param alpha scalar +* @param alpha scalar constant * @param X input array -* @param strideX index increment +* @param strideX stride length */ void API_SUFFIX(stdlib_strided_dfill)( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX ) { 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 * Fills a double-precision floating-point strided array with a specified scalar constant using alternative indexing semantics. * * @param N number of indexed elements -* @param alpha scalar +* @param alpha scalar constant * @param X input array -* @param strideX index increment +* @param strideX stride length * @param offsetX starting index */ void API_SUFFIX(stdlib_strided_dfill_ndarray)( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) {