diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md index 7c6b99ebe5af..e47e96afe3d6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md @@ -110,6 +110,7 @@ var v = gapxsumors.ndarray( 4, 5.0, x, 2, 1 ); - If `N <= 0`, both functions return `0.0`. - Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation is acceptable; in all other cases, exercise due caution. +- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]) - Depending on the environment, the typed versions ([`dapxsumors`][@stdlib/blas/ext/base/dapxsumors], [`sapxsumors`][@stdlib/blas/ext/base/sapxsumors], etc.) are likely to be significantly more performant. @@ -170,6 +171,8 @@ console.log( v ); [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray +[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor + [@stdlib/blas/ext/base/dapxsumors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dapxsumors diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/index.d.ts index b75a10f3e60f..d14bfe0a4f22 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/index.d.ts @@ -20,7 +20,12 @@ /// -import { NumericArray } from '@stdlib/types/array'; +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; + +/** +* Input array. +*/ +type InputArray = NumericArray | Collection | AccessorArrayLike; /** * Interface describing `gapxsumors`. @@ -41,7 +46,7 @@ interface Routine { * var v = gapxsumors( x.length, 5.0, x, 1 ); * // returns 16.0 */ - ( N: number, alpha: number, x: NumericArray, strideX: number ): number; + ( N: number, alpha: number, x: InputArray, strideX: number ): number; /** * Adds a scalar constant to each strided array element and computes the sum using ordinary recursive summation and alternative indexing semantics. @@ -59,7 +64,7 @@ interface Routine { * var v = gapxsumors.ndarray( x.length, 5.0, x, 1, 0 ); * // returns 16.0 */ - ndarray( N: number, alpha: number, x: NumericArray, strideX: number, offsetX: number ): number; + ndarray( N: number, alpha: number, x: InputArray, strideX: number, offsetX: number ): number; } /** diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/test.ts index 2765c3f85497..217124e11885 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import gapxsumors = require( './index' ); @@ -26,6 +27,7 @@ import gapxsumors = require( './index' ); const x = new Float64Array( 10 ); gapxsumors( x.length, 5.0, x, 1 ); // $ExpectType number + gapxsumors( x.length, 5.0, new AccessorArray( x ), 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -100,6 +102,7 @@ import gapxsumors = require( './index' ); const x = new Float64Array( 10 ); gapxsumors.ndarray( x.length, 5.0, x, 1, 0 ); // $ExpectType number + gapxsumors.ndarray( x.length, 5.0, new AccessorArray( x ), 1, 0 ); // $ExpectType number } // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/accessors.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/accessors.js new file mode 100644 index 000000000000..b1cda957e4f0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/accessors.js @@ -0,0 +1,73 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MAIN // + +/** +* Adds a scalar constant to each strided array element and computes the sum using ordinary recursive summation. +* +* @private +* @param {PositiveInteger} N - number of indexed elements +* @param {number} alpha - scalar constant +* @param {Object} x - input array object +* @param {Collection} x.data - input array data +* @param {Array} x.accessors - array element accessors +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index +* @returns {number} sum +* +* @example +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* +* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +* +* var v = gapxsumors( 4, 5.0, arraylike2object( x ), 2, 1 ); +* // returns 25.0 +*/ +function gapxsumors( N, alpha, x, strideX, offsetX ) { + var xbuf; + var sum; + var get; + var ix; + var i; + + // Cache reference to array data: + xbuf = x.data; + + // Cache a reference to the element accessor: + get = x.accessors[ 0 ]; + + ix = offsetX; + if ( strideX === 0 ) { + return N * ( alpha + get( xbuf, ix ) ); + } + sum = 0.0; + for ( i = 0; i < N; i++ ) { + sum += alpha + get( xbuf, ix ); + ix += strideX; + } + return sum; +} + + +// EXPORTS // + +module.exports = gapxsumors; diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/ndarray.js index f12eff019fbb..b6b8365ce30f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/ndarray.js @@ -18,6 +18,12 @@ 'use strict'; +// MODULES // + +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +var accessors = require( './accessors.js' ); + + // MAIN // /** @@ -39,11 +45,16 @@ function gapxsumors( N, alpha, x, strideX, offsetX ) { var sum; var ix; + var o; var i; if ( N <= 0 ) { return 0.0; } + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, alpha, o, strideX, offsetX ); + } ix = offsetX; if ( strideX === 0 ) { return N * ( alpha + x[ ix ] ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.main.js index 5e5f5a33f797..c78a256d797c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.main.js @@ -21,8 +21,8 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var Float64Array = require( '@stdlib/array/float64' ); var gapxsumors = require( './../lib' ); @@ -67,6 +67,33 @@ tape( 'the function adds a constant and calculates the sum of all strided array t.end(); }); +tape( 'the function adds a constant and calculates the sum of all strided array elements (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, 0.0, -3.0, 3.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 48.0, 'returns expected value' ); + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 33.0, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = [ NaN, 4.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 1.0, 1e100, 1.0, -1.0e100 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', function test( t ) { var x; var v; @@ -95,7 +122,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 +136,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = gapxsumors( N, 5.0, x, 2 ); + v = gapxsumors( 4, 5.0, x, 2 ); + + t.strictEqual( v, 25.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `stride` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]; + + v = gapxsumors( 4, 5.0, toAccessorArray( x ), 2 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -133,8 +178,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gapxsumors( N, 5.0, x, -2 ); + v = gapxsumors( 4, 5.0, x, -2 ); + + t.strictEqual( v, 25.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = gapxsumors( 4, 5.0, toAccessorArray( x ), -2 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end(); @@ -152,10 +217,21 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f t.end(); }); +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant repeated N times (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 0 ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -171,9 +247,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 = gapxsumors( N, 5.0, x1, 2 ); + v = gapxsumors( 4, 5.0, x1, 2 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.ndarray.js index 1ee4065a41fb..5222abea3ad3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.ndarray.js @@ -21,8 +21,8 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var gapxsumors = require( './../lib/ndarray.js' ); @@ -66,6 +66,33 @@ tape( 'the function adds a constant and calculates the sum of all strided array t.end(); }); +tape( 'the function adds a constant and calculates the sum of all strided array elements (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, 0.0, -3.0, 3.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 48.0, 'returns expected value' ); + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 33.0, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = [ NaN, 4.0 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 1.0, 1.0e100, 1.0, -1.0e100 ]; + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', function test( t ) { var x; var v; @@ -94,7 +121,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 +135,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = gapxsumors( N, 5.0, x, 2, 0 ); + v = gapxsumors( 4, 5.0, x, 2, 0 ); + + t.strictEqual( v, 25.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `stride` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]; + + v = gapxsumors( 4, 5.0, toAccessorArray( x ), 2, 0 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -132,8 +177,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gapxsumors( N, 5.0, x, -2, 6 ); + v = gapxsumors( 4, 5.0, x, -2, 6 ); + + t.strictEqual( v, 25.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = gapxsumors( 4, 5.0, toAccessorArray( x ), -2, 6 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end(); @@ -151,8 +216,19 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f t.end(); }); +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element plus a constant repeated N times (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 0, 0 ); + t.strictEqual( v, x.length * (x[0]+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 +242,29 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]; - N = floor( x.length / 2 ); - v = gapxsumors( N, 5.0, x, 2, 1 ); + v = gapxsumors( 4, 5.0, x, 2, 1 ); + t.strictEqual( v, 25.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offset` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]; + + v = gapxsumors( 4, 5.0, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end();