diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/README.md b/lib/node_modules/@stdlib/blas/ext/base/cfill/README.md index c474bf9e78a0..625acb7c6509 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/README.md @@ -63,9 +63,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Complex64Array`][@stdlib/array/complex64]. -- **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 Float32Array = require( '@stdlib/array/float32' ); @@ -175,7 +175,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 two elements of the strided array +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 two elements of the strided array: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -290,6 +290,8 @@ console.log( x.get( 0 ).toString() ); Fills a single-precision complex floating-point strided array `X` with a specified scalar constant `alpha`. ```c +#include "stdlib/complex/float32/ctor.h" + float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f ); @@ -301,7 +303,7 @@ The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] stdlib_complex64_t` scalar constant. - **X**: `[out] stdlib_complex64_t*` input array. -- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. ```c void stdlib_strided_cfill( const CBLAS_INT N, const stdlib_complex64_t alpha, stdlib_complex64_t *X, const CBLAS_INT strideX ); @@ -312,6 +314,8 @@ void stdlib_strided_cfill( const CBLAS_INT N, const stdlib_complex64_t alpha, st Fills a single-precision complex floating-point strided array `X` with a specified scalar constant `alpha` using alternative indexing semantics. ```c +#include "stdlib/complex/float32/ctor.h" + float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f ); @@ -323,7 +327,7 @@ The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] stdlib_complex64_t` scalar constant. - **X**: `[out] stdlib_complex64_t*` input array. -- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. - **offsetX**: `[in] CBLAS_INT` starting index for `X`. ```c diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/benchmark.length.c index fdd940cc9ecc..2e355e907b6c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/benchmark.length.c @@ -109,6 +109,7 @@ static double benchmark1( int iterations, int len ) { } t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar stdlib_strided_cfill( len, alpha, (stdlib_complex64_t *)x, 1 ); if ( x[ 0 ] != x[ 0 ] ) { printf( "should not return NaN\n" ); @@ -143,6 +144,7 @@ static double benchmark2( int iterations, int len ) { } t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar stdlib_strided_cfill_ndarray( len, alpha, (stdlib_complex64_t *)x, 1, 0 ); if ( x[ 0 ] != x[ 0 ] ) { printf( "should not return NaN\n" ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/repl.txt index ca4c45831bd3..6b0690eb14d5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/repl.txt @@ -17,13 +17,13 @@ Number of indexed elements. alpha: Complex64 - Constant. + Scalar Constant. x: Complex64Array Input array. strideX: integer - Index increment. + Stride length. Returns ------- @@ -88,13 +88,13 @@ Number of indexed elements. alpha: Complex64 - Constant. + Scalar Constant. x: Complex64Array Input array. strideX: integer - Index increment. + Stride length. offsetX: integer Starting index. diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts index 86ae783fa232..0e62ac388d2b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts @@ -103,7 +103,7 @@ interface Routine { * @param N - number of indexed elements * @param alpha - scalar constant * @param x - input array -* @param strideX - index increment +* @param strideX - stride length * @returns input array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.js index d771318c1beb..ab9a3b49072d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.js +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.js @@ -32,7 +32,7 @@ var ndarray = require( './ndarray.js' ); * @param {PositiveInteger} N - number of indexed elements * @param {ComplexLike} alpha - scalar constant * @param {Complex64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @returns {Complex64Array} input array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js index 76f267650de8..5f8afcb20a48 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js @@ -32,7 +32,7 @@ var addon = require( './../src/addon.node' ); * @param {PositiveInteger} N - number of indexed elements * @param {ComplexLike} alpha - scalar constant * @param {Complex64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @returns {Complex64Array} input array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js index 8b36a9f6e562..0f3fad5c6c93 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js @@ -38,7 +38,7 @@ var M = 8; * @param {PositiveInteger} N - number of indexed elements * @param {ComplexLike} alpha - scalar constant * @param {Complex64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index * @returns {Complex64Array} input array * diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js index c20781ea1527..4e14f85131c7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js @@ -32,7 +32,7 @@ var addon = require( './../src/addon.node' ); * @param {PositiveInteger} N - number of indexed elements * @param {ComplexLike} alpha - scalar constant * @param {Complex64Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index * @returns {Complex64Array} input array * diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c index 6f6f961e1395..fe00f9f055d2 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c @@ -27,7 +27,7 @@ * @param N number of indexed elements * @param alpha scalar constant * @param X input array -* @param strideX index increment +* @param strideX stride length */ void API_SUFFIX(stdlib_strided_cfill)( const CBLAS_INT N, const stdlib_complex64_t alpha, stdlib_complex64_t *X, const CBLAS_INT strideX ) { @@ -41,7 +41,7 @@ void API_SUFFIX(stdlib_strided_cfill)( const CBLAS_INT N, const stdlib_complex64 * @param N number of indexed elements * @param alpha scalar * @param X input array -* @param strideX index increment +* @param strideX stride length * @param offsetX starting index */