Skip to content

feat: add accessor arrays support to blas/ext/base/gsum #5134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gsum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ var v = gsum.ndarray( 4, 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 ([`dsum`][@stdlib/blas/ext/base/dsum], [`ssum`][@stdlib/blas/ext/base/ssum], etc.) are likely to be significantly more performant.

</section>
Expand Down Expand Up @@ -167,6 +168,8 @@ console.log( v );

[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array

[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

<!-- <related-links> -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,12 @@

/// <reference types="@stdlib/types"/>

import { NumericArray } from '@stdlib/types/array';
import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';

/**
* Input array.
*/
type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;

/**
* Interface describing `gsum`.
Expand All @@ -40,7 +45,7 @@ interface Routine {
* var v = gsum( x.length, x, 1 );
* // returns 1.0
*/
( N: number, x: NumericArray, strideX: number ): number;
( N: number, x: InputArray, strideX: number ): number;

/**
* Computes the sum of strided array elements using alternative indexing semantics.
Expand All @@ -57,7 +62,7 @@ interface Routine {
* var v = gsum.ndarray( x.length, x, 1, 0 );
* // returns 1.0
*/
ndarray( N: number, x: NumericArray, strideX: number, offsetX: number ): number;
ndarray( N: number, x: InputArray, strideX: number, offsetX: number ): number;
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* limitations under the License.
*/

import AccessorArray = require( '@stdlib/array/base/accessor' );
import gsum = require( './index' );


Expand All @@ -26,6 +27,7 @@ import gsum = require( './index' );
const x = new Float64Array( 10 );

gsum( x.length, x, 1 ); // $ExpectType number
gsum( 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...
Expand Down Expand Up @@ -85,6 +87,7 @@ import gsum = require( './index' );
const x = new Float64Array( 10 );

gsum.ndarray( x.length, x, 1, 0 ); // $ExpectType number
gsum.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...
Expand Down
82 changes: 82 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.main.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

var tape = require( 'tape' );
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 gsum = require( './../lib' );

Expand Down Expand Up @@ -66,6 +67,33 @@ 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;

x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, 0.0, -3.0, 3.0 ];
v = gsum( x.length, toAccessorArray( x ), 1 );
t.strictEqual( v, 3.0, 'returns expected value' );

x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ];
v = gsum( x.length, toAccessorArray( x ), 1 );
t.strictEqual( v, 3.0, 'returns expected value' );

x = [ -4.0, -4.0 ];
v = gsum( x.length, toAccessorArray( x ), 1 );
t.strictEqual( v, -8.0, 'returns expected value' );

x = [ NaN, 4.0 ];
v = gsum( x.length, toAccessorArray( x ), 1 );
t.strictEqual( isnan( v ), true, 'returns expected value' );

x = [ 1.0, 1.0e100, 1.0, -1.0e100 ];
v = gsum( x.length, toAccessorArray( x ), 1 );
t.strictEqual( v, 2.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;
Expand Down Expand Up @@ -114,6 +142,27 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
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 = gsum( 4, toAccessorArray( x ), 2 );

t.strictEqual( v, 5.0, 'returns expected value' );
t.end();
});

tape( 'the function supports a negative `stride` parameter', function test( t ) {
var x;
var v;
Expand All @@ -135,6 +184,27 @@ 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;

x = [
1.0, // 3
2.0,
2.0, // 2
-7.0,
-2.0, // 1
3.0,
4.0, // 0
2.0
];

v = gsum( 4, toAccessorArray( 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 sum of the first element repeated N times', function test( t ) {
var x;
var v;
Expand All @@ -147,6 +217,18 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the s
t.end();
});

tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times (accessors)', function test( t ) {
var x;
var v;

x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];

v = gsum( x.length, toAccessorArray( x ), 0 );
t.strictEqual( v, 5.0, 'returns expected value' );

t.end();
});

tape( 'the function supports view offsets', function test( t ) {
var x0;
var x1;
Expand Down
103 changes: 103 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gsum/test/test.ndarray.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

var tape = require( 'tape' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
var gsum = require( './../lib/ndarray.js' );


Expand Down Expand Up @@ -65,6 +66,33 @@ 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', 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 = gsum( x.length, toAccessorArray( x ), 1, 0 );
t.strictEqual( v, 3.0, 'returns expected value' );

x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ];
v = gsum( x.length, toAccessorArray( x ), 1, 0 );
t.strictEqual( v, 3.0, 'returns expected value' );

x = [ -4.0, -4.0 ];
v = gsum( x.length, toAccessorArray( x ), 1, 0 );
t.strictEqual( v, -8.0, 'returns expected value' );

x = [ NaN, 4.0 ];
v = gsum( x.length, toAccessorArray( x ), 1, 0 );
t.strictEqual( isnan( v ), true, 'returns expected value' );

x = [ 1.0, 1.0e100, 1.0, -1.0e100 ];
v = gsum( x.length, toAccessorArray( x ), 1, 0 );
t.strictEqual( v, 2.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;
Expand Down Expand Up @@ -113,6 +141,27 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
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 = gsum( 4, toAccessorArray( 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 x;
var v;
Expand All @@ -134,6 +183,27 @@ 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;

x = [
1.0, // 3
2.0,
2.0, // 2
-7.0,
-2.0, // 1
3.0,
4.0, // 0
2.0
];

v = gsum( 4, toAccessorArray( 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 sum of the first element repeated N times', function test( t ) {
var x;
var v;
Expand All @@ -146,6 +216,18 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the s
t.end();
});

tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times (accessors)', function test( t ) {
var x;
var v;

x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];

v = gsum( x.length, toAccessorArray( x ), 0, 0 );
t.strictEqual( v, 5.0, 'returns expected value' );

t.end();
});

tape( 'the function supports an `offset` parameter', function test( t ) {
var x;
var v;
Expand All @@ -166,3 +248,24 @@ tape( 'the function supports an `offset` parameter', function test( t ) {

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 = gsum( 4, toAccessorArray( x ), 2, 1 );
t.strictEqual( v, 5.0, 'returns expected value' );

t.end();
});