diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md index 85affbbbdbe2..5db31e4d2795 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md @@ -125,6 +125,7 @@ var v = gasumpw.ndarray( 4, x, 2, 1 ); - If `N <= 0`, both functions return `0.0`. - In general, pairwise summation is more numerically stable than ordinary recursive summation (i.e., "simple" summation), with slightly worse performance. While not the most numerically stable summation technique (e.g., compensated summation techniques such as the Kahan–Babuška-Neumaier algorithm are generally more numerically stable), pairwise summation strikes a reasonable balance between numerical stability and performance. If either numerical stability or performance is more desirable for your use case, consider alternative summation techniques. +- 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 ([`dasumpw`][@stdlib/blas/ext/base/dasumpw], [`sasumpw`][@stdlib/blas/ext/base/sasumpw], etc.) are likely to be significantly more performant. @@ -191,6 +192,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 + [l1norm]: https://en.wikipedia.org/wiki/Norm_%28mathematics%29 [@higham:1993a]: https://doi.org/10.1137/0914050 diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts index 783274e040b6..9ebe505b714c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/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 `gasumpw`. @@ -40,7 +45,7 @@ interface Routine { * var v = gasumpw( x.length, x, 1 ); * // returns 5.0 */ - ( N: number, x: NumericArray, strideX: number ): number; + ( N: number, x: InputArray, strideX: number ): number; /** * Computes the sum of absolute values (L1 norm) of strided array elements using pairwise summation and alternative indexing semantics. @@ -57,7 +62,7 @@ interface Routine { * var v = gasumpw.ndarray( x.length, x, 1, 0 ); * // returns 5.0 */ - ndarray( N: number, x: NumericArray, strideX: number, offsetX: number ): number; + ndarray( N: number, x: InputArray, strideX: number, offsetX: number ): number; } /** diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/test.ts index 095f2b5a48be..0b6862a813e8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import gasumpw = require( './index' ); @@ -26,6 +27,7 @@ import gasumpw = require( './index' ); const x = new Float64Array( 10 ); gasumpw( x.length, x, 1 ); // $ExpectType number + gasumpw( x.length, new AccessorArray( x ), 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -86,6 +88,7 @@ import gasumpw = require( './index' ); const x = new Float64Array( 10 ); gasumpw.ndarray( x.length, x, 1, 0 ); // $ExpectType number + gasumpw.ndarray( x.length, 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/gasumpw/lib/accessors.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/accessors.js new file mode 100644 index 000000000000..d8fafa6f9d4f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/accessors.js @@ -0,0 +1,135 @@ +/** +* @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'; + +// MODULES // + +var floor = require( '@stdlib/math/base/special/floor' ); +var abs = require( '@stdlib/math/base/special/abs' ); + + +// VARIABLES // + +// Blocksize for pairwise summation (NOTE: decreasing the blocksize decreases rounding error as more pairs are summed, but also decreases performance. Because the inner loop is unrolled eight times, the blocksize is effectively `16`.): +var BLOCKSIZE = 128; + + +// MAIN // + +/** +* Computes the sum of absolute values (L1 norm) of strided array elements using pairwise summation. +* +* @private +* @param {PositiveInteger} N - number of indexed elements +* @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 = gasumpw( 4, arraylike2object( x ), 2, 1 ); +* // returns 9.0 +*/ +function gasumpw( N, x, strideX, offsetX ) { + var xbuf; + var get; + var ix; + var s0; + var s1; + var s2; + var s3; + var s4; + var s5; + var s6; + var s7; + var M; + var s; + var n; + 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 * ( abs( get( xbuf, ix ) ) ); + } + if ( N < 8 ) { + // Use simple summation... + s = 0.0; + for ( i = 0; i < N; i++ ) { + s += abs( get( xbuf, ix ) ); + ix += strideX; + } + return s; + } + if ( N <= BLOCKSIZE ) { + // Sum a block with 8 accumulators (by loop unrolling, we lower the effective blocksize to 16)... + s0 = abs( get( xbuf, ix ) ); + s1 = abs( get( xbuf, ix+strideX ) ); + s2 = abs( get( xbuf, ix+(2*strideX) ) ); + s3 = abs( get( xbuf, ix+(3*strideX) ) ); + s4 = abs( get( xbuf, ix+(4*strideX) ) ); + s5 = abs( get( xbuf, ix+(5*strideX) ) ); + s6 = abs( get( xbuf, ix+(6*strideX) ) ); + s7 = abs( get( xbuf, ix+(7*strideX) ) ); + ix += 8 * strideX; + + M = N % 8; + for ( i = 8; i < N-M; i += 8 ) { + s0 += abs( get( xbuf, ix ) ); + s1 += abs( get( xbuf, ix+strideX ) ); + s2 += abs( get( xbuf, ix+(2*strideX) ) ); + s3 += abs( get( xbuf, ix+(3*strideX) ) ); + s4 += abs( get( xbuf, ix+(4*strideX) ) ); + s5 += abs( get( xbuf, ix+(5*strideX) ) ); + s6 += abs( get( xbuf, ix+(6*strideX) ) ); + s7 += abs( get( xbuf, ix+(7*strideX) ) ); + ix += 8 * strideX; + } + // Pairwise sum the accumulators: + s = ( (s0+s1) + (s2+s3) ) + ( (s4+s5) + (s6+s7) ); + + // Clean-up loop... + for ( i; i < N; i++ ) { + s += abs( get( xbuf, ix ) ); + ix += strideX; + } + return s; + } + // Recurse by dividing by two, but avoiding non-multiples of unroll factor... + n = floor( N/2 ); + n -= n % 8; + return gasumpw( n, x, strideX, ix ) + gasumpw( N-n, x, strideX, ix+(n*strideX) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = gasumpw; diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js index 310df05fb9b0..e3da40393ea8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js @@ -20,8 +20,10 @@ // MODULES // +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); var floor = require( '@stdlib/math/base/special/floor' ); var abs = require( '@stdlib/math/base/special/abs' ); +var accessors = require( './accessors.js' ); // VARIABLES // @@ -68,11 +70,16 @@ function gasumpw( N, x, strideX, offsetX ) { var M; var s; var n; + var o; var i; if ( N <= 0 ) { return 0.0; } + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, o, strideX, offsetX ); + } ix = offsetX; if ( strideX === 0 ) { return N * ( abs( x[ix] ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.main.js index c220a3a7b5db..6a5b091cba06 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/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 gasumpw = require( './../lib' ); @@ -75,6 +75,41 @@ tape( 'the function calculates the sum of absolute values', function test( t ) { t.end(); }); +tape( 'the function calculates the sum of absolute values (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, 0.0, -3.0, 3.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 21.0, 'returns expected value' ); + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 15.0, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 8.0, 'returns expected value' ); + + x = [ NaN, 4.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 1.0, 1.0e100, 1.0, -1.0e100 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 2.0e100, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( i + 1 ); + } + v = gasumpw( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 500500.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; @@ -103,7 +138,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; @@ -118,15 +152,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = gasumpw( N, x, 2 ); + v = gasumpw( 4, x, 2 ); + + t.strictEqual( v, 9.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 = gasumpw( 4, toAccessorArray( x ), 2 ); t.strictEqual( v, 9.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; var i; @@ -142,8 +195,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gasumpw( N, x, -2 ); + v = gasumpw( 4, x, -2 ); t.strictEqual( v, 9.0, 'returns expected value' ); @@ -157,6 +209,36 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = gasumpw( 4, toAccessorArray( x ), -2 ); + + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( i + 1 ); + } + v = gasumpw( x.length, toAccessorArray( x ), -1 ); + t.strictEqual( v, 500500.0, 'returns expected value' ); + + t.end(); +}); + 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; @@ -172,7 +254,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the s tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -188,9 +269,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 = gasumpw( N, x1, 2 ); + v = gasumpw( 4, x1, 2 ); t.strictEqual( v, 9.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.ndarray.js index 001032894b27..67b580612c95 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/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 gasumpw = require( './../lib/ndarray.js' ); @@ -74,6 +74,41 @@ tape( 'the function calculates the sum of all strided array elements', function t.end(); }); +tape( 'the function calculates the sum of all strided array elements (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, 0.0, -3.0, 3.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 21.0, 'returns expected value' ); + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 15.0, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 8.0, 'returns expected value' ); + + x = [ NaN, 4.0 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 1.0, 1.0e100, 1.0, -1.0e100 ]; + v = gasumpw( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 2.0e100, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( i + 1 ); + } + v = gasumpw( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 500500.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; @@ -102,7 +137,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; @@ -117,15 +151,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = gasumpw( N, x, 2, 0 ); + v = gasumpw( 4, x, 2, 0 ); + + t.strictEqual( v, 9.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 = gasumpw( 4, toAccessorArray( x ), 2, 0 ); t.strictEqual( v, 9.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; var i; @@ -141,8 +194,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gasumpw( N, x, -2, 6 ); + v = gasumpw( 4, x, -2, 6 ); t.strictEqual( v, 9.0, 'returns expected value' ); @@ -156,6 +208,36 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = gasumpw( 4, toAccessorArray( x ), -2, 6 ); + + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( i + 1 ); + } + v = gasumpw( x.length, toAccessorArray( x ), -1, x.length-1 ); + t.strictEqual( v, 500500.0, 'returns expected value' ); + + t.end(); +}); + 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; @@ -169,7 +251,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the s }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -183,9 +264,29 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]; - N = floor( x.length / 2 ); - v = gasumpw( N, x, 2, 1 ); + v = gasumpw( 4, x, 2, 1 ); + t.strictEqual( v, 9.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 = gasumpw( 4, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 9.0, 'returns expected value' ); t.end();