From 8661d607cabb2ed13ca40f01f8250a18bddc66a3 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Mon, 27 Jan 2025 09:34:06 +0000 Subject: [PATCH] refactor: update blas/base/gsum 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 --- --- .../@stdlib/blas/ext/base/gsum/README.md | 47 ++++++------------- .../blas/ext/base/gsum/benchmark/benchmark.js | 17 +++---- .../base/gsum/benchmark/benchmark.ndarray.js | 17 +++---- .../@stdlib/blas/ext/base/gsum/docs/repl.txt | 32 ++++++------- .../blas/ext/base/gsum/docs/types/index.d.ts | 12 ++--- .../blas/ext/base/gsum/examples/index.js | 14 ++---- .../@stdlib/blas/ext/base/gsum/lib/index.js | 7 +-- .../@stdlib/blas/ext/base/gsum/lib/main.js | 12 ++--- .../@stdlib/blas/ext/base/gsum/lib/ndarray.js | 13 ++--- .../blas/ext/base/gsum/test/test.main.js | 17 ++----- .../blas/ext/base/gsum/test/test.ndarray.js | 17 ++----- 11 files changed, 80 insertions(+), 125 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/gsum/README.md index 7d32459d5ad9..8d66fdc00a8d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/README.md @@ -36,15 +36,14 @@ limitations under the License. var gsum = require( '@stdlib/blas/ext/base/gsum' ); ``` -#### gsum( N, x, stride ) +#### gsum( N, x, strideX ) Computes the sum of strided array elements. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = gsum( N, x, 1 ); +var v = gsum( x.length, x, 1 ); // returns 1.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 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 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 = gsum( N, x, 2 ); +var v = gsum( 4, x, 2 ); // returns 5.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 = gsum( N, x1, 2 ); +var v = gsum( 4, x1, 2 ); // returns 5.0 ``` -#### gsum.ndarray( N, x, stride, offset ) +#### gsum.ndarray( N, x, strideX, offsetX ) Computes the sum of strided array elements using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = gsum.ndarray( N, x, 1, 0 ); +var v = gsum.ndarray( x.length, x, 1, 0 ); // returns 1.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 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 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 = gsum.ndarray( N, x, 2, 1 ); +var v = gsum.ndarray( 4, x, 2, 1 ); // returns 5.0 ``` @@ -133,18 +122,12 @@ var v = gsum.ndarray( N, 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 gsum = require( '@stdlib/blas/ext/base/gsum' ); -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, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = gsum( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/benchmark/benchmark.js index e9d1f58fb85d..c70c3870ddfb 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/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 gsum = require( './../lib/main.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gsum = 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()*10.0 ) - 20.0 ); - } + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/benchmark/benchmark.ndarray.js index 35a7a1b2b3cc..267f9416dd4c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/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 gsum = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gsum = 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()*10.0 ) - 20.0 ); - } + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/repl.txt index 0d4d633df887..606ef28e40e2 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the sum of strided array elements. - 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. @@ -18,8 +18,8 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -33,22 +33,19 @@ > {{alias}}( x.length, x, 1 ) 1.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, 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 strided array elements using alternative indexing semantics. @@ -64,10 +61,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -84,8 +81,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, x, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) -1.0 See Also diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/types/index.d.ts index bd7cf1b6d1e5..3271d19cf5a5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/docs/types/index.d.ts @@ -31,7 +31,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -40,15 +40,15 @@ interface Routine { * var v = gsum( x.length, x, 1 ); * // returns 1.0 */ - ( N: number, x: NumericArray, stride: number ): number; + ( N: number, x: NumericArray, strideX: number ): number; /** * Computes the sum of strided array elements using 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 = gsum.ndarray( x.length, x, 1, 0 ); * // returns 1.0 */ - ndarray( N: number, x: NumericArray, stride: number, offset: number ): number; + ndarray( N: number, x: NumericArray, 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/gsum/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/examples/index.js index c4215e3873cc..628523e96845 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/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 gsum = 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, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = gsum( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/index.js index c42620ebc800..94c332c9cb9f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/index.js @@ -27,19 +27,16 @@ * var gsum = require( '@stdlib/blas/ext/base/gsum' ); * * var x = [ 1.0, -2.0, 2.0 ]; -* var N = x.length; * -* var v = gsum( N, x, 1 ); +* var v = gsum( x.length, x, 1 ); * // returns 1.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var gsum = require( '@stdlib/blas/ext/base/gsum' ); * * 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 = gsum.ndarray( N, x, 2, 1 ); +* var v = gsum.ndarray( 4, x, 2, 1 ); * // returns 5.0 */ diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/main.js index 7148f6f2e4d6..7aae126a3d29 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/main.js @@ -20,7 +20,8 @@ // MODULES // -var gsumkbn = require( '@stdlib/blas/ext/base/gsumkbn' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -30,18 +31,17 @@ var gsumkbn = require( '@stdlib/blas/ext/base/gsumkbn' ); * * @param {PositiveInteger} N - number of indexed elements * @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 = gsum( N, x, 1 ); +* var v = gsum( x.length, x, 1 ); * // returns 1.0 */ -function gsum( N, x, stride ) { - return gsumkbn( N, x, stride ); +function gsum( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/ndarray.js index 231fab744c92..a57fc3526959 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/lib/ndarray.js @@ -30,21 +30,18 @@ var gsumkbn = require( '@stdlib/blas/ext/base/gsumkbn' ).ndarray; * * @param {PositiveInteger} N - number of indexed elements * @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 = gsum( N, x, 2, 1 ); +* var v = gsum( 4, x, 2, 1 ); * // returns 5.0 */ -function gsum( N, x, stride, offset ) { - return gsumkbn( N, x, stride, offset ); +function gsum( N, x, strideX, offsetX ) { + return gsumkbn( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.main.js index fe5feaa91de8..0a51a5be6b57 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.main.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Float64Array = require( '@stdlib/array/float64' ); var gsum = require( './../lib' ); @@ -95,7 +94,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -110,15 +108,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = gsum( N, x, 2 ); + v = gsum( 4, x, 2 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -133,21 +129,20 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gsum( N, x, -2 ); + v = gsum( 4, x, -2 ); t.strictEqual( v, 5.0, 'returns expected value' ); 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 = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; v = gsum( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); @@ -155,7 +150,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -171,9 +165,8 @@ tape( 'the function supports view offsets', function test( t ) { ]); x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = gsum( N, x1, 2 ); + v = gsum( 4, x1, 2 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.ndarray.js index 21919baaefcd..9c256c5c3f14 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.ndarray.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var gsum = require( './../lib/ndarray.js' ); @@ -94,7 +93,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -109,15 +107,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = gsum( N, x, 2, 0 ); + v = gsum( 4, x, 2, 0 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -132,27 +128,25 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gsum( N, x, -2, 6 ); + v = gsum( 4, x, -2, 6 ); t.strictEqual( v, 5.0, 'returns expected value' ); 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 = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; v = gsum( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -166,9 +160,8 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]; - N = floor( x.length / 2 ); - v = gsum( N, x, 2, 1 ); + v = gsum( 4, x, 2, 1 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end();