diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/README.md b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/README.md index 20ea8a24b5db..8bf197f27804 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/README.md @@ -36,7 +36,7 @@ limitations under the License. var dsumkbn2 = require( '@stdlib/blas/ext/base/dsumkbn2' ); ``` -#### dsumkbn2( N, x, stride ) +#### dsumkbn2( N, x, strideX ) Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. @@ -45,7 +45,7 @@ var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var v = dsumkbn2( 3, x, 1 ); +var v = dsumkbn2( x.length, x, 1 ); // returns 1.0 ``` @@ -53,9 +53,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the sum of every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element: ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -80,7 +80,7 @@ var v = dsumkbn2( 4, x1, 2 ); // returns 5.0 ``` -#### dsumkbn2.ndarray( N, x, stride, offset ) +#### dsumkbn2.ndarray( N, x, strideX, offsetX ) Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics. @@ -89,19 +89,18 @@ var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var v = dsumkbn2.ndarray( 3, x, 1, 0 ); +var v = dsumkbn2.ndarray( x.length, x, 1, 0 ); // returns 1.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **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 calculate the sum of 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 calculate the sum of every other element starting from the second element: ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); @@ -130,11 +129,12 @@ var v = dsumkbn2.ndarray( 4, x, 2, 1 ); ```javascript -var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var dsumkbn2 = require( '@stdlib/blas/ext/base/dsumkbn2' ); -var x = filledarrayBy( 10, 'float64', discreteUniform( -100, 100 ) ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = dsumkbn2( x.length, x, 1 ); @@ -145,8 +145,123 @@ console.log( v ); + + * * * +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/dsumkbn2.h" +``` + +#### stdlib_strided_dsumkbn2( N, \*X, strideX ) + +Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; + +double v = stdlib_strided_dsumkbn2( 4, x, 1 ); +// returns 10.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +double stdlib_strided_dsumkbn2( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dsumkbn2_ndarray( N, \*X, strideX, offsetX ) + +Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; + +double v = stdlib_strided_dsumkbn2_ndarray( 4, x, 1, 0 ); +// returns 10.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +double stdlib_strided_dsumkbn2_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/dsumkbn2.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the sum: + double v = stdlib_strided_dsumkbn2( N, x, strideX ); + + // Print the result: + printf( "sum: %lf\n", v ); +} +``` + +
+ + + +
+ + +
## References diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.js index 66237dbf6082..73821cb0ba02 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.js @@ -21,8 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -31,7 +30,9 @@ var dsumkbn2 = require( './../lib/dsumkbn2.js' ); // VARIABLES // -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -44,7 +45,7 @@ var rand = uniform( -100.0, 100.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.native.js index 1eb8239f0d78..970f9c599d42 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.native.js @@ -22,8 +22,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -36,7 +35,9 @@ var dsumkbn2 = tryRequire( resolve( __dirname, './../lib/dsumkbn2.native.js' ) ) var opts = { 'skip': ( dsumkbn2 instanceof Error ) }; -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -49,7 +50,7 @@ var rand = uniform( -100.0, 100.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.js index 88a1b89b76ed..a1140774100a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.js @@ -21,8 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -31,7 +30,9 @@ var dsumkbn2 = require( './../lib/ndarray.js' ); // VARIABLES // -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -44,7 +45,7 @@ var rand = uniform( -100.0, 100.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.native.js index b587ad2fde9b..3002f93ac258 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/benchmark.ndarray.native.js @@ -22,8 +22,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -36,7 +35,9 @@ var dsumkbn2 = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); var opts = { 'skip': ( dsumkbn2 instanceof Error ) }; -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -49,7 +50,7 @@ var rand = uniform( -100.0, 100.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/c/benchmark.length.c index b0f588bac5ce..af2585fe4ab4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/benchmark/c/benchmark.length.c @@ -94,7 +94,7 @@ static double rand_double( void ) { * @param len array length * @return elapsed time in seconds */ -static double benchmark( int iterations, int len ) { +static double benchmark1( int iterations, int len ) { double elapsed; double x[ len ]; double v; @@ -107,6 +107,7 @@ static double benchmark( int iterations, int len ) { v = 0.0; t = tic(); for ( i = 0; i < iterations; i++ ) { + //cppcheck-suppress uninitvar v = stdlib_strided_dsumkbn2( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -120,6 +121,40 @@ static double benchmark( int iterations, int len ) { return elapsed; } +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + double x[ len ]; + double v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double() * 20000.0 ) - 10000.0; + } + v = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + //cppcheck-suppress uninitvar + v = stdlib_strided_dsumkbn2_ndarray( len, x, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + /** * Main execution sequence. */ @@ -142,7 +177,18 @@ int main( void ) { for ( j = 0; j < REPEATS; j++ ) { count += 1; printf( "# c::%s:len=%d\n", NAME, len ); - elapsed = benchmark( iter, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); print_results( iter, elapsed ); printf( "ok %d benchmark finished\n", count ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/repl.txt index 9f7b1409d597..ff123adf7edc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. - The `N` and `stride` parameters determine which elements in `x` are accessed + The `N` and stride parameters determine which elements in `x` are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed @@ -19,8 +19,8 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -34,28 +34,25 @@ > {{alias}}( x.length, x, 1 ) 1.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 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 3, x, 2 ) 1.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > stride = 2; - > {{alias}}( N, x1, stride ) + > {{alias}}( 3, x1, 2 ) -1.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm and 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 + buffer, the offset parameter supports indexing semantics based on a starting index. Parameters @@ -66,10 +63,10 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -86,8 +83,7 @@ // Using offset parameter: > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) -1.0 See Also diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/types/index.d.ts index 9392b4f1443b..442ae97bb82e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/docs/types/index.d.ts @@ -27,7 +27,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -38,15 +38,15 @@ interface Routine { * var v = dsumkbn2( x.length, x, 1 ); * // returns 1.0 */ - ( N: number, x: Float64Array, stride: number ): number; + ( N: number, x: Float64Array, strideX: number ): number; /** * Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns sum * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = dsumkbn2.ndarray( x.length, x, 1, 0 ); * // returns 1.0 */ - ndarray( N: number, x: Float64Array, stride: number, offset: number ): number; + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number; } /** @@ -65,7 +65,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns sum * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/c/example.c index 3fceb0339216..216365c5ba3e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/c/example.c @@ -17,7 +17,6 @@ */ #include "stdlib/blas/ext/base/dsumkbn2.h" -#include #include int main( void ) { @@ -25,13 +24,13 @@ int main( void ) { const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; // Specify the number of elements: - const int64_t N = 4; + const int N = 4; // Specify the stride length: - const int64_t stride = 2; + const int strideX = 2; // Compute the sum: - double v = stdlib_strided_dsumkbn2( N, x, stride ); + double v = stdlib_strided_dsumkbn2( N, x, strideX ); // Print the result: printf( "sum: %lf\n", v ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/index.js index c3b802e07f38..48def1b1b42b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/examples/index.js @@ -18,11 +18,12 @@ 'use strict'; -var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var dsumkbn2 = require( './../lib' ); -var x = filledarrayBy( 10, 'float64', discreteUniform( -100, 100 ) ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = dsumkbn2( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/include/stdlib/blas/ext/base/dsumkbn2.h b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/include/stdlib/blas/ext/base/dsumkbn2.h index 510ae882cdfd..e3dbd459c213 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/include/stdlib/blas/ext/base/dsumkbn2.h +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/include/stdlib/blas/ext/base/dsumkbn2.h @@ -19,7 +19,7 @@ #ifndef STDLIB_BLAS_EXT_BASE_DSUMKBN2_H #define STDLIB_BLAS_EXT_BASE_DSUMKBN2_H -#include +#include "stdlib/blas/base/shared.h" /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -31,7 +31,12 @@ extern "C" { /** * Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. */ -double stdlib_strided_dsumkbn2( const int64_t N, const double *X, const int64_t stride ); +double API_SUFFIX(stdlib_strided_dsumkbn2)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); + +/** +* Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics. +*/ +double API_SUFFIX(stdlib_strided_dsumkbn2_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.js index af09b995ffa2..ab046471f7da 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.js @@ -20,7 +20,8 @@ // MODULES // -var abs = require( '@stdlib/math/base/special/abs' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -38,63 +39,19 @@ var abs = require( '@stdlib/math/base/special/abs' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} sum * * @example * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = dsumkbn2( N, x, 1 ); +* var v = dsumkbn2( x.length, x, 1 ); * // returns 1.0 */ -function dsumkbn2( N, x, stride ) { - var sum; - var ccs; - var ix; - var cs; - var cc; - var v; - var t; - var c; - var i; - - if ( N <= 0 ) { - return 0.0; - } - if ( N === 1 || stride === 0 ) { - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - sum = 0.0; - ccs = 0.0; // second order correction term for lost low order bits - cs = 0.0; // first order correction term for lost low order bits - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - t = sum + v; - if ( abs( sum ) >= abs( v ) ) { - c = (sum-t) + v; - } else { - c = (v-t) + sum; - } - sum = t; - t = cs + c; - if ( abs( cs ) >= abs( c ) ) { - cc = (cs-t) + c; - } else { - cc = (c-t) + cs; - } - cs = t; - ccs += cc; - ix += stride; - } - return sum + cs + ccs; +function dsumkbn2( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.native.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.native.js index eb9fbb3338bb..edc4cb98de18 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/dsumkbn2.native.js @@ -30,20 +30,19 @@ var addon = require( './../src/addon.node' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} sum * * @example * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = dsumkbn2( N, x, 1 ); +* var v = dsumkbn2( x.length, x, 1 ); * // returns 1.0 */ -function dsumkbn2( N, x, stride ) { - return addon( N, x, stride ); +function dsumkbn2( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/index.js index 52d959f2b369..f224b12dde83 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/index.js @@ -28,20 +28,17 @@ * var dsumkbn2 = require( '@stdlib/blas/ext/base/dsumkbn2' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = dsumkbn2( N, x, 1 ); +* var v = dsumkbn2( x.length, x, 1 ); * // returns 1.0 * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var dsumkbn2 = require( '@stdlib/blas/ext/base/dsumkbn2' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = 3;; * -* var v = dsumkbn2.ndarray( N, x, 2, 1 ); +* var v = dsumkbn2.ndarray( 4, x, 2, 1 ); * // returns 5.0 */ diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.js index fb283fd02921..64e5d6682dbe 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.js @@ -38,21 +38,19 @@ var abs = require( '@stdlib/math/base/special/abs' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} sum * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = 4; * -* var v = dsumkbn2( N, x, 2, 1 ); +* var v = dsumkbn2( 4, x, 2, 1 ); * // returns 5.0 */ -function dsumkbn2( N, x, stride, offset ) { +function dsumkbn2( N, x, strideX, offsetX ) { var sum; var ccs; var ix; @@ -66,10 +64,10 @@ function dsumkbn2( N, x, stride, offset ) { if ( N <= 0 ) { return 0.0; } - if ( N === 1 || stride === 0 ) { - return x[ offset ]; + ix = offsetX; + if ( strideX === 0 ) { + return N * x[ ix ]; } - ix = offset; sum = 0.0; ccs = 0.0; // second order correction term for lost low order bits cs = 0.0; // first order correction term for lost low order bits @@ -90,7 +88,7 @@ function dsumkbn2( N, x, stride, offset ) { } cs = t; ccs += cc; - ix += stride; + ix += strideX; } return sum + cs + ccs; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.native.js index 6fdd350530d2..e254d48df707 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/lib/ndarray.native.js @@ -20,9 +20,7 @@ // MODULES // -var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' ); -var offsetView = require( '@stdlib/strided/base/offset-view' ); -var addon = require( './dsumkbn2.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -32,26 +30,20 @@ var addon = require( './dsumkbn2.native.js' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} sum * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = 4; * -* var v = dsumkbn2( N, x, 2, 1 ); +* var v = dsumkbn2( 4, x, 2, 1 ); * // returns 5.0 */ -function dsumkbn2( N, x, stride, offset ) { - var view; - offset = minViewBufferIndex( N, stride, offset ); - view = offsetView( x, offset ); - - return addon( N, view, stride ); +function dsumkbn2( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/manifest.json index bcafb815b9e0..95e0331dd32d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/manifest.json +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/manifest.json @@ -28,7 +28,7 @@ { "task": "build", "src": [ - "./src/dsumkbn2.c" + "./src/main.c" ], "include": [ "./include" @@ -40,13 +40,16 @@ "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", - "@stdlib/math/base/special/abs" + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/napi/create-double" ] }, { "task": "benchmark", "src": [ - "./src/dsumkbn2.c" + "./src/main.c" ], "include": [ "./include" @@ -54,13 +57,15 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared", "@stdlib/math/base/special/abs" ] }, { "task": "examples", "src": [ - "./src/dsumkbn2.c" + "./src/main.c" ], "include": [ "./include" @@ -68,6 +73,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared", "@stdlib/math/base/special/abs" ] } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/addon.c index 322422386ad3..b896fa028e0d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/addon.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/addon.c @@ -17,12 +17,13 @@ */ #include "stdlib/blas/ext/base/dsumkbn2.h" +#include "stdlib/blas/base/shared.h" #include "stdlib/napi/export.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_int64.h" #include "stdlib/napi/argv_strided_float64array.h" +#include "stdlib/napi/create_double.h" #include -#include /** * Receives JavaScript callback invocation data. @@ -36,11 +37,25 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); - - napi_value v; - napi_create_double( env, stdlib_strided_dsumkbn2( N, X, strideX ), &v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dsumkbn2)( N, X, strideX ), v ); + return v; +} +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dsumkbn2_ndarray)( N, X, strideX, offsetX ), v ); return v; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ); +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/dsumkbn2.c b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/main.c similarity index 55% rename from lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/dsumkbn2.c rename to lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/main.c index 49bc11fdff51..43ea376f1f05 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/dsumkbn2.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 The Stdlib Authors. +* Copyright (c) 2024 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,7 +18,8 @@ #include "stdlib/blas/ext/base/dsumkbn2.h" #include "stdlib/math/base/special/abs.h" -#include +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" /** * Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. @@ -31,16 +32,38 @@ * * - Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." _Computing_ 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x). * -* @param N number of indexed elements -* @param X input array -* @param stride stride length -* @return output value +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value */ -double stdlib_strided_dsumkbn2( const int64_t N, const double *X, const int64_t stride ) { +double API_SUFFIX(stdlib_strided_dsumkbn2)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX( stdlib_strided_dsumkbn2_ndarray )( N, X, strideX, ox ); +} + +/** +* Computes the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics. +* +* ## Method +* +* - This implementation uses a second-order iterative Kahan–Babuška algorithm, as described by Klein (2005). +* +* ## References +* +* - Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." _Computing_ 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x). +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param offsetX starting index +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dsumkbn2_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT i; double sum; double ccs; - int64_t ix; - int64_t i; double cs; double cc; double v; @@ -50,13 +73,9 @@ double stdlib_strided_dsumkbn2( const int64_t N, const double *X, const int64_t if ( N <= 0 ) { return 0.0; } - if ( N == 1 || stride == 0 ) { - return X[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; + ix = offsetX; + if ( strideX == 0 ) { + return N * X[ ix ]; } sum = 0.0; ccs = 0.0; // second order correction term for lost lower order bits @@ -78,7 +97,7 @@ double stdlib_strided_dsumkbn2( const int64_t N, const double *X, const int64_t } cs = t; ccs += cc; - ix += stride; + ix += strideX; } return sum + cs + ccs; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.js index 0e74cf92c7cb..87c207198eea 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.js @@ -139,14 +139,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', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dsumkbn2( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.native.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.native.js index 09a7a5b243f5..831a125f8370 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.dsumkbn2.native.js @@ -230,14 +230,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', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element 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 = dsumkbn2( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.js index 6eaad80ee38d..e5b1b366b09a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.js @@ -139,14 +139,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', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dsumkbn2( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.native.js index 668f399f2ab6..2fee9488664e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumkbn2/test/test.ndarray.native.js @@ -148,14 +148,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', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element 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 = dsumkbn2( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); });