Skip to content
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

feat: add support for accessor arrays in blas/ext/base/gsumkbn #4923

Merged
merged 2 commits into from
Jan 29, 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/gsumkbn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ var v = gsumkbn.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 @@ -178,6 +179,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/dsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dsum

[@stdlib/blas/ext/base/ssum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ssum
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 `gsumkbn`.
Expand All @@ -40,7 +45,7 @@ interface Routine {
* var v = gsumkbn( 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 an improved Kahan–Babuška algorithm and alternative indexing semantics.
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 gsumkbn = require( './index' );


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

gsumkbn( x.length, x, 1 ); // $ExpectType number
gsumkbn( 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 gsumkbn = require( './index' );
const x = new Float64Array( 10 );

gsumkbn.ndarray( x.length, x, 1, 0 ); // $ExpectType number
gsumkbn.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
100 changes: 100 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gsumkbn/lib/accessors.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
/**
* @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 abs = require( '@stdlib/math/base/special/abs' );


// MAIN //

/**
* Computes the sum of strided array elements using an improved Kahan–Babuška algorithm.
*
* ## Method
*
* - This implementation uses an "improved Kahan–Babuška algorithm", as described by Neumaier (1974).
*
* ## References
*
* - Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106](https://doi.org/10.1002/zamm.19740540106).
*
* @private
* @param {PositiveInteger} N - number of indexed elements
* @param {Object} x - input array object
* @param {Collection} x.data - input array data
* @param {Array<Function>} 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 = gsumkbn( 4, arraylike2object( x ), 2, 1 );
* // returns 5.0
*/
function gsumkbn( N, x, strideX, offsetX ) {
var xbuf;
var get;
var sum;
var ix;
var v;
var t;
var c;
var i;

if ( N <= 0 ) {
return 0.0;
}

// 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 * get( xbuf, ix );
}
sum = 0.0;
c = 0.0;
for ( i = 0; i < N; i++ ) {
v = get( xbuf, ix );
t = sum + v;
if ( abs( sum ) >= abs( v ) ) {
c += (sum-t) + v;
} else {
c += (v-t) + sum;
}
sum = t;
ix += strideX;
}
return sum + c;
}


// EXPORTS //

module.exports = gsumkbn;
7 changes: 7 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gsumkbn/lib/ndarray.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
// MODULES //

var abs = require( '@stdlib/math/base/special/abs' );
var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
var accessors = require( './accessors.js' );


// MAIN //
Expand Down Expand Up @@ -51,6 +53,7 @@ var abs = require( '@stdlib/math/base/special/abs' );
function gsumkbn( N, x, strideX, offsetX ) {
var sum;
var ix;
var o;
var v;
var t;
var c;
Expand All @@ -59,6 +62,10 @@ function gsumkbn( N, x, strideX, offsetX ) {
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 * x[ ix ];
Expand Down
70 changes: 70 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gsumkbn/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 gsumkbn = 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 = gsumkbn( 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 = gsumkbn( x.length, toAccessorArray( x ), 1 );
t.strictEqual( v, 3.0, 'returns expected value' );

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

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

x = [ 1.0, 1.0e100, 1.0, -1.0e100 ];
v = gsumkbn( 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 = gsumkbn( 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 = gsumkbn( 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 Down
Loading
Loading