diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md index 2a09804a0164..0d25e1b75c0a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md @@ -109,6 +109,7 @@ var v = gapxsum.ndarray( 4, 5.0, x, 2, 1 ); ## Notes - If `N <= 0`, both functions return `0.0`. +- 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 ([`dapxsum`][@stdlib/blas/ext/base/dapxsum], [`sapxsum`][@stdlib/blas/ext/base/sapxsum], etc.) are likely to be significantly more performant. @@ -169,6 +170,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/dapxsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dapxsum diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts index 84712dc38355..62cc754716ab 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts @@ -20,7 +20,11 @@ /// -import { NumericArray } from '@stdlib/types/array'; +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; +/** +* Input array. +*/ +type InputArray = NumericArray | Collection | AccessorArrayLike; /** * Interface describing `gapxsum`. @@ -41,7 +45,7 @@ interface Routine { * var v = gapxsum( 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 alternative indexing semantics. @@ -59,7 +63,7 @@ interface Routine { * var v = gapxsum.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/gapxsum/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/test.ts index ff4c89d1185f..e455b2e3fe0c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import gapxsum = require( './index' ); @@ -26,6 +27,7 @@ import gapxsum = require( './index' ); const x = new Float64Array( 10 ); gapxsum( x.length, 5.0, x, 1 ); // $ExpectType number + gapxsum( 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 gapxsum = require( './index' ); const x = new Float64Array( 10 ); gapxsum.ndarray( x.length, 5.0, x, 1, 0 ); // $ExpectType number + gapxsum.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/gapxsum/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/test/test.main.js index 3105c7d8c1aa..c01d1cbd24a3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/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 gapxsum = 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 = gapxsum( 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 = gapxsum( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 33.0, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = gapxsum( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = [ NaN, 4.0 ]; + v = gapxsum( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 1.0, 1e100, 1.0, -1.0e100 ]; + v = gapxsum( x.length, 5.0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 12.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 = gapxsum( N, 5.0, x, 2 ); + v = gapxsum( 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 = gapxsum( 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 = gapxsum( N, 5.0, x, -2 ); + v = gapxsum( 4, 5.0, x, -2 ); + + 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 = gapxsum( 4, 5.0, toAccessorArray( x ), -2 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end(); @@ -155,7 +220,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 +235,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 = gapxsum( N, 5.0, x1, 2 ); + v = gapxsum( 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/gapxsum/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/test/test.ndarray.js index e261c3eedc22..7faa59a962dc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/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 gapxsum = 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 = gapxsum( 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 = gapxsum( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 33.0, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = gapxsum( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = [ NaN, 4.0 ]; + v = gapxsum( 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 = gapxsum( x.length, 5.0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 12.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 = gapxsum( N, 5.0, x, 2, 0 ); + v = gapxsum( 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 = gapxsum( 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 = gapxsum( N, 5.0, x, -2, 6 ); + v = gapxsum( 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 = gapxsum( 4, 5.0, toAccessorArray( x ), -2, 6 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end(); @@ -152,7 +217,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -166,9 +230,29 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]; - N = floor( x.length / 2 ); - v = gapxsum( N, 5.0, x, 2, 1 ); + v = gapxsum( 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 = gapxsum( 4, 5.0, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 25.0, 'returns expected value' ); t.end();