diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/README.md index d98bf9b1ba41..c43e4b08765f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/README.md @@ -44,9 +44,8 @@ Adds a scalar constant to each double-precision floating-point strided array ele var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = dapxsum( N, 5.0, x, 1 ); +var v = dapxsum( x.length, 5.0, x, 1 ); // returns 16.0 ``` @@ -55,9 +54,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **strideX**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element: ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -90,9 +89,8 @@ Adds a scalar constant to each double-precision floating-point strided array ele var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = dapxsum.ndarray( N, 5.0, x, 1, 0 ); +var v = dapxsum.ndarray( x.length, 5.0, x, 1, 0 ); // returns 16.0 ``` @@ -100,7 +98,7 @@ The function has the following additional parameters: - **offsetX**: starting index for `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 every other value in `x` starting from the second value +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 every element starting from the second element: ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -190,7 +188,7 @@ The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] double` scalar constant. - **X**: `[in] double*` input array. -- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. ```c double stdlib_strided_dapxsum( const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX ); @@ -212,7 +210,7 @@ The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **alpha**: `[in] double` scalar constant. - **X**: `[in] double*` 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/dapxsum/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/benchmark/c/benchmark.length.c index 561889f3969c..35f32c7af5ff 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/benchmark/c/benchmark.length.c @@ -107,6 +107,7 @@ static double benchmark1( int iterations, int len ) { v = 0.0; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar v = stdlib_strided_dapxsum( len, 5.0, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -140,6 +141,7 @@ static double benchmark2( int iterations, int len ) { v = 0.0; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar v = stdlib_strided_dapxsum_ndarray( len, 5.0, x, 1, 0 ); if ( v != v ) { printf( "should not return NaN\n" ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/repl.txt index ed688f09f39f..2584b16a2390 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/repl.txt @@ -3,8 +3,8 @@ Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. - The `N` and stride parameters determine which elements in the strided - array are accessed at runtime. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed array view. @@ -17,13 +17,13 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Float64Array Input array. strideX: integer - Index increment. + Stride length. Returns ------- @@ -63,13 +63,13 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Float64Array Input array. strideX: integer - Index increment. + Stride length. offsetX: integer Starting index. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/types/index.d.ts index ce3d34fa05ec..8198936c4354 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/docs/types/index.d.ts @@ -26,7 +26,7 @@ interface Routine { * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array * @param strideX - stride length * @returns sum @@ -45,7 +45,7 @@ interface Routine { * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum 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 { * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. * * @param N - number of indexed elements -* @param alpha - constant +* @param alpha - scalar constant * @param x - input array * @param strideX - stride length * @returns sum diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/examples/c/example.c index 844ffb883024..8f28c178e1be 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/examples/c/example.c @@ -27,10 +27,10 @@ int main( void ) { const int N = 4; // Specify the stride length: - const int stride = 2; + const int strideX = 2; // Compute the sum: - double v = stdlib_strided_dapxsum( N, 5.0, x, stride ); + double v = stdlib_strided_dapxsum( N, 5.0, x, strideX ); // Print the result: printf( "sum: %lf\n", v ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.js index cb025bb28168..08784ceff107 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.js @@ -30,7 +30,7 @@ var ndarray = require( './ndarray.js' ); * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array * @param {integer} strideX - stride length * @returns {number} sum @@ -39,9 +39,8 @@ var ndarray = require( './ndarray.js' ); * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = dapxsum( N, 5.0, x, 1 ); +* var v = dapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 */ function dapxsum( N, alpha, x, strideX ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.native.js index 0e70605ac5ff..32b051419416 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/dapxsum.native.js @@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' ); * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array * @param {integer} strideX - stride length * @returns {number} sum @@ -38,9 +38,8 @@ var addon = require( './../src/addon.node' ); * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = dapxsum( N, 5.0, x, 1 ); +* var v = dapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 */ function dapxsum( N, alpha, x, strideX ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.js index 9a210ae6fa34..9431d4a9f966 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.js @@ -29,7 +29,7 @@ var dapxsumkbn = require( '@stdlib/blas/ext/base/dapxsumkbn' ).ndarray; * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array * @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.native.js index 88f82eae0a3e..cf970d2f5a34 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/lib/ndarray.native.js @@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' ); * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @param {Float64Array} x - input array * @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/src/main.c index 99c6aeac4a93..d0b755e27ef5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/src/main.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/src/main.c @@ -41,8 +41,8 @@ double API_SUFFIX(stdlib_strided_dapxsum)( const CBLAS_INT N, const double alpha * @param N number of indexed elements * @param alpha scalar constant * @param X input array -* @param strideX index increment -* @param offsetX index offset +* @param strideX stride length +* @param offsetX starting index * @return output value */ double API_SUFFIX(stdlib_strided_dapxsum_ndarray)( const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.js index e1e504910961..2e62ef75b451 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.js @@ -135,14 +135,14 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant repeated N times', function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dapxsum( x.length, 5.0, x, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.native.js index 517bea646e02..90c2735fc892 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.dapxsum.native.js @@ -253,14 +253,14 @@ tape( 'the function supports a negative `stride` parameter', opts, function test t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant repeated N times', opts, function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dapxsum( x.length, 5.0, x, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.js index 541719cb7fb6..364fc5b7818b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.js @@ -135,14 +135,14 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element plus a constant', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant repeated N times', function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dapxsum( x.length, 5.0, x, 0, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.native.js index e0d251264d0d..ffa586f4c8d3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsum/test/test.ndarray.native.js @@ -144,14 +144,14 @@ tape( 'the function supports a negative `stride` parameter', opts, function test t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element plus a constant', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant repeated N times', opts, function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dapxsum( x.length, 5.0, x, 0, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); });