From 031e344ff0cd25a548b19d558d5dc8d8bba41182 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sun, 29 Dec 2024 19:56:49 +0000 Subject: [PATCH 1/6] refactor: update to follow current project conventions --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../blas/ext/base/gapxsumkbn/README.md | 53 +++++++------------ .../base/gapxsumkbn/benchmark/benchmark.js | 17 +++--- .../gapxsumkbn/benchmark/benchmark.ndarray.js | 17 +++--- .../blas/ext/base/gapxsumkbn/docs/repl.txt | 38 ++++++------- .../ext/base/gapxsumkbn/docs/types/index.d.ts | 24 ++++----- .../ext/base/gapxsumkbn/examples/index.js | 14 ++--- .../blas/ext/base/gapxsumkbn/lib/index.js | 9 ++-- .../blas/ext/base/gapxsumkbn/lib/main.js | 47 +++------------- .../blas/ext/base/gapxsumkbn/lib/ndarray.js | 22 ++++---- .../ext/base/gapxsumkbn/test/test.main.js | 4 +- .../ext/base/gapxsumkbn/test/test.ndarray.js | 4 +- 11 files changed, 94 insertions(+), 155 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md index ef044c89548a..eae2f645c7da 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md @@ -20,7 +20,7 @@ limitations under the License. # gapxsumkbn -> Add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm. +> Add a scalar constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.
@@ -36,15 +36,14 @@ limitations under the License. var gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' ); ``` -#### gapxsumkbn( N, alpha, x, stride ) +#### gapxsumkbn( N, alpha, x, strideX ) -Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. +Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = gapxsumkbn( N, 5.0, x, 1 ); +var v = gapxsumkbn( x.length, 5.0, x, 1 ); // returns 16.0 ``` @@ -52,17 +51,14 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. -- **stride**: index increment for `x`. +- **strideX**: stride length. -The `N` and `stride` parameters determine which elements in `x` 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 floor = require( '@stdlib/math/base/special/floor' ); - var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ]; -var N = floor( x.length / 2 ); -var v = gapxsumkbn( N, 5.0, x, 2 ); +var v = gapxsumkbn( 4, 5.0, x, 2 ); // returns 25.0 ``` @@ -72,42 +68,35 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = gapxsumkbn( N, 5.0, x1, 2 ); +var v = gapxsumkbn( 4, 5.0, x1, 2 ); // returns 25.0 ``` -#### gapxsumkbn.ndarray( N, alpha, x, stride, offset ) +#### gapxsumkbn.ndarray( N, alpha, x, strideX, offsetX ) -Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm and alternative indexing semantics. +Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm and alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = gapxsumkbn.ndarray( N, 5.0, x, 1, 0 ); +var v = gapxsumkbn.ndarray( x.length, 5.0, x, 1, 0 ); // returns 16.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **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 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 floor = require( '@stdlib/math/base/special/floor' ); - var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; -var N = floor( x.length / 2 ); -var v = gapxsumkbn.ndarray( N, 5.0, x, 2, 1 ); +var v = gapxsumkbn.ndarray( 4, 5.0, x, 2, 1 ); // returns 25.0 ``` @@ -133,18 +122,12 @@ var v = gapxsumkbn.ndarray( N, 5.0, x, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( randu()*100.0 ); -} +var x = discreteUniform( 10.0, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = gapxsumkbn( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js index 42708502ed34..baef5dee4167 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js @@ -21,13 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +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; var gapxsumkbn = require( './../lib/main.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gapxsumkbn = require( './../lib/main.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - x.push( ( randu()*20.0 ) - 10.0 ); - } + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js index 4d29b62d7b3d..7b6ed0ed6099 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js @@ -21,13 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +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; var gapxsumkbn = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gapxsumkbn = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - x.push( ( randu()*20.0 ) - 10.0 ); - } + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt index 8086546e1495..ae3cb743c148 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt @@ -1,10 +1,10 @@ -{{alias}}( N, alpha, x, stride ) +{{alias}}( N, alpha, x, strideX ) Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. - The `N` and `stride` parameters determine which elements in `x` 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: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -37,27 +37,24 @@ > {{alias}}( x.length, 5.0, x, 1 ) 16.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -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, 5.0, x, stride ) + > {{alias}}( 3, 5.0, x, 2 ) 16.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, 5.0, x1, stride ) + > {{alias}}( 3, 5.0, x1, 2 ) 14.0 -{{alias}}.ndarray( N, alpha, x, stride, offset ) + +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) Adds a constant to each strided array element and computes the sum using an improved 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,15 +63,15 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -91,8 +88,7 @@ // Using offset parameter: > var x = [ 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, 5.0, x, 2, 1 ) + > {{alias}}.ndarray( 3, 5.0, x, 2, 1 ) 14.0 See Also diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts index 1966e18c72a7..7744cc349d67 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts @@ -27,12 +27,12 @@ import { NumericArray } from '@stdlib/types/array'; */ interface Routine { /** - * Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. + * Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -41,16 +41,16 @@ interface Routine { * var v = gapxsumkbn( x.length, 5.0, x, 1 ); * // returns 16.0 */ - ( N: number, alpha: number, x: NumericArray, stride: number ): number; + ( N: number, alpha: number, x: NumericArray, strideX: number ): number; /** - * Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm and alternative indexing semantics. + * Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm and alternative indexing semantics. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns sum * * @example @@ -59,16 +59,16 @@ interface Routine { * var v = gapxsumkbn.ndarray( x.length, 5.0, x, 1, 0 ); * // returns 16.0 */ - ndarray( N: number, alpha: number, x: NumericArray, stride: number, offset: number ): number; + ndarray( N: number, alpha: number, x: NumericArray, strideX: number, offsetX: number ): number; } /** -* Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. +* Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. * * @param N - number of indexed elements -* @param alpha - constant +* @param alpha - scalar constant * @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/gapxsumkbn/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/examples/index.js index 50a2169217e8..80b06149581d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/examples/index.js @@ -18,18 +18,12 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var gapxsumkbn = require( './../lib' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( randu()*100.0 ); -} +var x = discreteUniform( 10.0, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = gapxsumkbn( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/index.js index 79bd8cb9e6c4..d5af602009d2 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm. +* Add a scalar constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm. * * @module @stdlib/blas/ext/base/gapxsumkbn * @@ -27,19 +27,16 @@ * var gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' ); * * var x = [ 1.0, -2.0, 2.0 ]; -* var N = x.length; * -* var v = gapxsumkbn( N, 5.0, x, 1 ); +* var v = gapxsumkbn( x.length, 5.0, x, 1 ); * // returns 16.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' ); * * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; -* var N = floor( x.length / 2 ); * -* var v = gapxsumkbn.ndarray( N, 5.0, x, 2, 1 ); +* var v = gapxsumkbn.ndarray( 4, 5.0, x, 2, 1 ); * // returns 25.0 */ diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/main.js index 640df2f7cf81..c0a046a3c351 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/main.js @@ -20,13 +20,14 @@ // MODULES // -var abs = require( '@stdlib/math/base/special/abs' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // /** -* Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. +* Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. * * ## Method * @@ -37,51 +38,19 @@ var abs = require( '@stdlib/math/base/special/abs' ); * - Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106](https://doi.org/10.1002/zamm.19740540106). * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @param {NumericArray} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} sum * * @example * var x = [ 1.0, -2.0, 2.0 ]; -* var N = x.length; * -* var v = gapxsumkbn( N, 5.0, x, 1 ); +* var v = gapxsumkbn( x.length, 5.0, x, 1 ); * // returns 16.0 */ -function gapxsumkbn( N, alpha, x, stride ) { - var sum; - var ix; - var v; - var t; - var c; - var i; - - if ( N <= 0 ) { - return 0.0; - } - if ( N === 1 || stride === 0 ) { - return alpha + x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - sum = 0.0; - c = 0.0; - for ( i = 0; i < N; i++ ) { - v = alpha + x[ ix ]; - t = sum + v; - if ( abs( sum ) >= abs( v ) ) { - c += (sum-t) + v; - } else { - c += (v-t) + sum; - } - sum = t; - ix += stride; - } - return sum + c; +function gapxsumkbn( N, alpha, x, strideX ) { + return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js index f532f587dd6d..ff23be1cfd27 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js @@ -26,7 +26,7 @@ var abs = require( '@stdlib/math/base/special/abs' ); // MAIN // /** -* Adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. +* Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. * * ## Method * @@ -37,22 +37,20 @@ var abs = require( '@stdlib/math/base/special/abs' ); * - Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106](https://doi.org/10.1002/zamm.19740540106). * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @param {NumericArray} 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 floor = require( '@stdlib/math/base/special/floor' ); * * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; -* var N = floor( x.length / 2 ); * -* var v = gapxsumkbn( N, 5.0, x, 2, 1 ); +* var v = gapxsumkbn( 4, 5.0, x, 2, 1 ); * // returns 25.0 */ -function gapxsumkbn( N, alpha, x, stride, offset ) { +function gapxsumkbn( N, alpha, x, strideX, offsetX ) { var sum; var ix; var v; @@ -63,10 +61,10 @@ function gapxsumkbn( N, alpha, x, stride, offset ) { if ( N <= 0 ) { return 0.0; } - if ( N === 1 || stride === 0 ) { - return alpha + x[ offset ]; + ix = offsetX; + if ( strideX === 0 ) { + return N * ( alpha + x[ ix ] ); } - ix = offset; sum = 0.0; c = 0.0; for ( i = 0; i < N; i++ ) { @@ -78,7 +76,7 @@ function gapxsumkbn( N, alpha, x, stride, offset ) { c += (v-t) + sum; } sum = t; - ix += stride; + ix += strideX; } return sum + c; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.main.js index 728daede0674..c4076f2647fb 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.main.js @@ -140,14 +140,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 = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; v = gapxsumkbn( 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/gapxsumkbn/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.ndarray.js index 2d12ea8ac74e..b7ca7336b287 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/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 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 = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; v = gapxsumkbn( 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(); }); From 171b06482b3ca14c3c381149b27ebefabc1c5619 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Mon, 30 Dec 2024 08:03:25 +0000 Subject: [PATCH 2/6] fix: apply code review suggestions --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js | 1 - lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/package.json | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js index ff23be1cfd27..1f9680fef8db 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js @@ -44,7 +44,6 @@ var abs = require( '@stdlib/math/base/special/abs' ); * @returns {number} sum * * @example -* * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; * * var v = gapxsumkbn( 4, 5.0, x, 2, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/package.json b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/package.json index f0751de6d487..7452c8a12612 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/ext/base/gapxsumkbn", "version": "0.0.0", - "description": "Add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.", + "description": "Add a scalar constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From cff362478ce494756967916ebb6adf3ffe98cb24 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Mon, 30 Dec 2024 14:13:02 +0500 Subject: [PATCH 3/6] docs: apply review suggestion Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- .../@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt index ae3cb743c148..f6d8b0009400 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( N, alpha, x, strideX ) - Adds a constant to each strided array element and computes the sum using an - improved Kahan–Babuška algorithm. + Adds a scalar constant to each strided array element and computes the sum + using an improved Kahan–Babuška algorithm. The `N` and stride parameters determine which elements in the strided array are accessed at runtime. From abfb59a337edd6ea1577bf0d2b27ca59cb523031 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Mon, 30 Dec 2024 14:13:11 +0500 Subject: [PATCH 4/6] docs: apply review suggestion Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- .../@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt index f6d8b0009400..4b5fa050a134 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt @@ -50,8 +50,8 @@ {{alias}}.ndarray( N, alpha, x, strideX, offsetX ) - Adds a constant to each strided array element and computes the sum using an - improved Kahan–Babuška algorithm and alternative indexing semantics. + Adds a scalar constant to each strided array element and computes the sum + using an improved 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 From 3caabae782936e6e4b6e0746339ce4dc5fa20eea Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Mon, 30 Dec 2024 15:03:02 +0500 Subject: [PATCH 5/6] docs: apply review suggestion Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- .../@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt index 4b5fa050a134..2e4ffe83a925 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/repl.txt @@ -51,7 +51,8 @@ {{alias}}.ndarray( N, alpha, x, strideX, offsetX ) Adds a scalar constant to each strided array element and computes the sum - using an improved Kahan–Babuška algorithm and alternative indexing semantics. + using an improved 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 From 856c09b9aa865429f3c8e87d0cbc28ad05a78a60 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 1 Jan 2025 20:03:09 -0800 Subject: [PATCH 6/6] Apply suggestions from code review Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md | 2 +- .../@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js | 2 +- .../blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js | 2 +- .../@stdlib/blas/ext/base/gapxsumkbn/examples/index.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md index eae2f645c7da..0dc4ff595419 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md @@ -125,7 +125,7 @@ var v = gapxsumkbn.ndarray( 4, 5.0, x, 2, 1 ); var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' ); -var x = discreteUniform( 10.0, -100, 100, { +var x = discreteUniform( 10, -100, 100, { 'dtype': 'float64' }); console.log( x ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js index baef5dee4167..864505285dfd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.js @@ -31,7 +31,7 @@ var gapxsumkbn = require( './../lib/main.js' ); // VARIABLES // var options = { - 'dtype': 'float64' + 'dtype': 'generic' }; diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js index 7b6ed0ed6099..5d7a55828086 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/benchmark/benchmark.ndarray.js @@ -31,7 +31,7 @@ var gapxsumkbn = require( './../lib/ndarray.js' ); // VARIABLES // var options = { - 'dtype': 'float64' + 'dtype': 'generic' }; diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/examples/index.js index 80b06149581d..a0bbd3acb496 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/examples/index.js @@ -21,7 +21,7 @@ var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var gapxsumkbn = require( './../lib' ); -var x = discreteUniform( 10.0, -100, 100, { +var x = discreteUniform( 10, -100, 100, { 'dtype': 'float64' }); console.log( x );