refactor: update stride handling and function documentation for blas/ext/base/dapxsumpw

headlessNode · web-flow · commit 536419208fcd · 2024-12-07T17:06:53.000-05:00
PR-URL: #3248 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/README.md
@@ -44,19 +44,18 @@ 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 = dapxsumpw( N, 5.0, x, 1 );
+var v = dapxsumpw( x.length, 5.0, x, 1 );
 // returns 16.0
 ```
 
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **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' );
@@ -89,17 +88,16 @@ 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 = dapxsumpw.ndarray( N, 5.0, x, 1, 0 );
+var v = dapxsumpw.ndarray( x.length, 5.0, x, 1, 0 );
 // returns 16.0
 ```
 
 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 other element starting from the second element:
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
@@ -189,7 +187,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_dapxsumpw( const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX );
@@ -211,7 +209,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/dapxsumpw/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/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_dapxsumpw( 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_dapxsumpw_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/dapxsumpw/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/docs/repl.txt
@@ -17,13 +17,13 @@
         Number of indexed elements.
 
     alpha: number
-        Constant.
+        Scalar constant.
 
     x: Float64Array
         Input array.
 
     strideX: integer
-        Index increment.
+        Stride length.
 
     Returns
     -------
@@ -37,7 +37,7 @@
     > {{alias}}( x.length, 5.0, x, 1 )
     16.0
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and stride parameters:
     > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
     > {{alias}}( 3, 5.0, x, 2 )
     16.0
@@ -64,13 +64,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/dapxsumpw/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/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 using pairwise summation.
 	*
 	* @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 pairwise summation and 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 using pairwise summation.
 *
 * @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/dapxsumpw/lib/dapxsumpw.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/dapxsumpw.js
@@ -38,7 +38,7 @@ var ndarray = require( './ndarray.js' );
 * -   Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
 *
 * @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
@@ -47,9 +47,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 = dapxsumpw( N, 5.0, x, 1 );
+* var v = dapxsumpw( x.length, 5.0, x, 1 );
 * // returns 16.0
 */
 function dapxsumpw( N, alpha, x, strideX ) {
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/dapxsumpw.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/dapxsumpw.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 using pairwise summation.
 *
 * @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 = dapxsumpw( N, 5.0, x, 1 );
+* var v = dapxsumpw( x.length, 5.0, x, 1 );
 * // returns 16.0
 */
 function dapxsumpw( N, alpha, x, strideX ) {
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/index.js
@@ -29,7 +29,7 @@
 *
 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 *
-* var v = dapxsumpw( 3, 5.0, x, 1 );
+* var v = dapxsumpw( x.length, 5.0, x, 1 );
 * // returns 16.0
 *
 * @example
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/ndarray.js
@@ -43,7 +43,7 @@ var BLOCKSIZE = 128;
 * -   Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
 *
 * @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
@@ -75,10 +75,10 @@ function dapxsumpw( N, alpha, x, strideX, offsetX ) {
 	if ( N <= 0 ) {
 		return 0.0;
 	}
-	if ( N === 1 || strideX === 0 ) {
-		return alpha + x[ offsetX ];
-	}
 	ix = offsetX;
+	if ( strideX === 0 ) {
+		return N * ( alpha + x[ ix ] );
+	}
 	if ( N < 8 ) {
 		// Use simple summation...
 		s = 0.0;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/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 using pairwise summation.
 *
 * @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/dapxsumpw/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/src/main.c
@@ -56,17 +56,17 @@ double API_SUFFIX(stdlib_strided_dapxsumpw)( const CBLAS_INT N, const double alp
 * @param N        number of indexed elements
 * @param alpha    scalar constant
 * @param X        input array
-* @param strideX  index increment
+* @param strideX  stride length
 * @param offsetX  starting index
 * @return         output value
 *
 */
 double API_SUFFIX(stdlib_strided_dapxsumpw_ndarray)( const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) {
-	double sum;
 	CBLAS_INT ix;
 	CBLAS_INT M;
 	CBLAS_INT n;
 	CBLAS_INT i;
+	double sum;
 	double s0;
 	double s1;
 	double s2;
@@ -79,10 +79,10 @@ double API_SUFFIX(stdlib_strided_dapxsumpw_ndarray)( const CBLAS_INT N, const do
 	if ( N <= 0 ) {
 		return 0.0;
 	}
-	if ( N == 1 || strideX == 0 ) {
-		return alpha + X[ offsetX ];
-	}
 	ix = offsetX;
+	if ( strideX == 0 ) {
+		return N * ( alpha + X[ ix ] );
+	}
 	if ( N < 8 ) {
 		// Use simple summation...
 		sum = 0.0;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/test/test.dapxsumpw.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/test/test.dapxsumpw.js
@@ -152,14 +152,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 = dapxsumpw( 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/dapxsumpw/test/test.dapxsumpw.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/test/test.dapxsumpw.native.js
@@ -270,14 +270,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 = dapxsumpw( 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/dapxsumpw/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/test/test.ndarray.js
@@ -152,14 +152,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 = dapxsumpw( 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/dapxsumpw/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dapxsumpw/test/test.ndarray.native.js
@@ -161,14 +161,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 = dapxsumpw( 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();
 });

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ var ndarray = require( './ndarray.js' );`
`38`	`38`	`* - Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).`
`39`	`39`	`*`
`40`	`40`	`* @param {PositiveInteger} N - number of indexed elements`
`41`		`-* @param {number} alpha - constant`
	`41`	`+* @param {number} alpha - scalar constant`
`42`	`42`	`* @param {Float64Array} x - input array`
`43`	`43`	`* @param {integer} strideX - stride length`
`44`	`44`	`* @returns {number} sum`
`@@ -47,9 +47,8 @@ var ndarray = require( './ndarray.js' );`
`47`	`47`	`* var Float64Array = require( '@stdlib/array/float64' );`
`48`	`48`	`*`
`49`	`49`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`50`		`-* var N = x.length;`
`51`	`50`	`*`
`52`		`-* var v = dapxsumpw( N, 5.0, x, 1 );`
	`51`	`+* var v = dapxsumpw( x.length, 5.0, x, 1 );`
`53`	`52`	`* // returns 16.0`
`54`	`53`	`*/`
`55`	`54`	`function dapxsumpw( N, alpha, x, strideX ) {`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );`
`29`	`29`	`* Adds a scalar constant to each double-precision floating-point strided array element and computes the sum using pairwise summation.`
`30`	`30`	`*`
`31`	`31`	`* @param {PositiveInteger} N - number of indexed elements`
`32`		`-* @param {number} alpha - constant`
	`32`	`+* @param {number} alpha - scalar constant`
`33`	`33`	`* @param {Float64Array} x - input array`
`34`	`34`	`* @param {integer} strideX - stride length`
`35`	`35`	`* @returns {number} sum`
`@@ -38,9 +38,8 @@ var addon = require( './../src/addon.node' );`
`38`	`38`	`* var Float64Array = require( '@stdlib/array/float64' );`
`39`	`39`	`*`
`40`	`40`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`41`		`-* var N = x.length;`
`42`	`41`	`*`
`43`		`-* var v = dapxsumpw( N, 5.0, x, 1 );`
	`42`	`+* var v = dapxsumpw( x.length, 5.0, x, 1 );`
`44`	`43`	`* // returns 16.0`
`45`	`44`	`*/`
`46`	`45`	`function dapxsumpw( N, alpha, x, strideX ) {`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`*`
`30`	`30`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`31`	`31`	`*`
`32`		`-* var v = dapxsumpw( 3, 5.0, x, 1 );`
	`32`	`+* var v = dapxsumpw( x.length, 5.0, x, 1 );`
`33`	`33`	`* // returns 16.0`
`34`	`34`	`*`
`35`	`35`	`* @example`