Skip to content
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/gnansumpw/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ var v = gnansumpw.ndarray( 5, 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])
- 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.
- Depending on the environment, the typed versions ([`dnansumpw`][@stdlib/blas/ext/base/dnansumpw], [`snansumpw`][@stdlib/blas/ext/base/snansumpw], etc.) are likely to be significantly more performant.

Expand Down Expand Up @@ -185,6 +186,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

[@higham:1993a]: https://doi.org/10.1137/0914050

<!-- <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 `gnansumpw`.
Expand All @@ -40,7 +45,7 @@ interface Routine {
* var v = gnansumpw( 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, ignoring `NaN` values and using pairwise summation and alternative indexing semantics.
Expand All @@ -57,7 +62,7 @@ interface Routine {
* var v = gnansumpw.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 gnansumpw = require( './index' );


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

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

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


// 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 strided array elements, ignoring `NaN` values and using pairwise summation.
*
* ## Method
*
* - This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.
*
* ## References
*
* - Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
*
* @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 for `x`
* @param {NonNegativeInteger} offsetX - starting index for `x`
* @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 = gnansumpw( 4, arraylike2object( x ), 2, 1 );
* // returns 5.0
*/
function gnansumpw( N, x, strideX, offsetX ) {
var xbuf;
var xget;
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 v;
var i;

// Cache reference to array data:
xbuf = x.data;

// Cache reference to the element accessors:
xget = x.accessors[ 0 ];

ix = offsetX;
if ( strideX === 0 ) {
v = xget( xbuf, ix );
if ( isnan( v ) ) {
return 0.0;
}
return N * v;
}
if ( N < 8 ) {
// Use simple summation...
s = 0.0;
for ( i = 0; i < N; i++ ) {
v = xget( xbuf, ix );
if ( isnan( v ) === false ) {
s += v;
}
ix += strideX;
}
return s;
}
if ( N <= BLOCKSIZE ) {
// Sum a block with 8 accumulators (by loop unrolling, we lower the effective blocksize to 16)...
v = xget( xbuf, ix );
s0 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s1 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s2 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s3 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s4 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s5 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s6 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s7 = ( isnan( v ) ) ? 0.0 : v;
ix += strideX;

M = N % 8;
for ( i = 8; i < N-M; i += 8 ) {
v = xget( xbuf, ix );
s0 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s1 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s2 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s3 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s4 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s5 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s6 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
v = xget( xbuf, ix );
s7 += ( isnan( v ) ) ? 0.0 : v;
ix += strideX;
}
// Pairwise sum the accumulators:
s = ( (s0+s1) + (s2+s3) ) + ( (s4+s5) + (s6+s7) );

// Clean-up loop...
for ( i; i < N; i++ ) {
v = xget( xbuf, ix );
if ( isnan( v ) === false ) {
s += v;
}
ix += strideX;
}
return s;
}
// Recurse by dividing by two, but avoiding non-multiples of unroll factor...
n = floor( N/2 );
n -= n % 8;
return gnansumpw( n, x, strideX, ix ) + gnansumpw( N-n, x, strideX, ix+(n*strideX) ); // eslint-disable-line max-len
}


// EXPORTS //

module.exports = gnansumpw;
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@

// MODULES //

var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var floor = require( '@stdlib/math/base/special/floor' );
var accessors = require( './accessors.js' );


// VARIABLES //
Expand Down Expand Up @@ -68,11 +70,16 @@ function gnansumpw( 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 ) {
if ( isnan( x[ ix ] ) ) {
Expand Down
Loading