Skip to content

Calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using pairwise summation.

License

Notifications You must be signed in to change notification settings

stdlib-js/blas-ext-base-dnannsumpw

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

dnannsumpw

NPM version Build Status Coverage Status

Calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using pairwise summation.

Usage

import dnannsumpw from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-dnannsumpw@deno/mod.js';

dnannsumpw( N, x, strideX, out, strideOut )

Computes the sum of double-precision floating-point strided array elements, ignoring NaN values and using pairwise summation.

import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';

var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
var out = new Float64Array( 2 );

var v = dnannsumpw( x.length, x, 1, out, 1 );
// returns <Float64Array>[ 1.0, 3 ]

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Float64Array.
  • strideX: stride length for x.
  • out: output Float64Array whose first element is the sum and whose second element is the number of non-NaN elements.
  • strideOut: stride length for out.

The N and stride parameters determine which elements are accessed at runtime. For example, to compute the sum of every other element in the strided array:

import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';

var x = new Float64Array( [ 1.0, 2.0, NaN, -7.0, NaN, 3.0, 4.0, 2.0 ] );
var out = new Float64Array( 2 );

var v = dnannsumpw( 4, x, 2, out, 1 );
// returns <Float64Array>[ 5.0, 2 ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';

var x0 = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var out0 = new Float64Array( 4 );
var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at 3rd element

var v = dnannsumpw( 4, x1, 2, out1, 1 );
// returns <Float64Array>[ 5.0, 4 ]

dnannsumpw.ndarray( N, x, strideX, offsetX, out, strideOut, offsetOut )

Computes the sum of double-precision floating-point strided array elements, ignoring NaN values and using pairwise summation and alternative indexing semantics.

import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';

var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
var out = new Float64Array( 2 );

var v = dnannsumpw.ndarray( x.length, x, 1, 0, out, 1, 0 );
// returns <Float64Array>[ 1.0, 3 ]

The function has the following additional parameters:

  • offsetX: starting index for x.
  • offsetOut: starting index for out.

While typed array views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the sum of every other element starting from the second element:

import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';

var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var out = new Float64Array( 4 );

var v = dnannsumpw.ndarray( 4, x, 2, 1, out, 2, 1 );
// returns <Float64Array>[ 0.0, 5.0, 0.0, 4 ]

Notes

  • If N <= 0, both functions return a sum equal to 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.

Examples

import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@deno/mod.js';
import bernoulli from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-bernoulli@deno/mod.js';
import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@deno/mod.js';
import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@deno/mod.js';
import dnannsumpw from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-dnannsumpw@deno/mod.js';

function rand() {
    if ( bernoulli( 0.5 ) < 1 ) {
        return discreteUniform( 0, 100 );
    }
    return NaN;
}

var x = filledarrayBy( 10, 'float64', rand );
console.log( x );

var out = new Float64Array( 2 );
dnannsumpw( x.length, x, 1, out, 1 );
console.log( out );

References

  • Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." SIAM Journal on Scientific Computing 14 (4): 783–99. doi:10.1137/0914050.

See Also

  • @stdlib/blas-ext/base/dnannsum: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values.
  • @stdlib/blas-ext/base/dnannsumkbn: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using an improved Kahan–Babuška algorithm.
  • @stdlib/blas-ext/base/dnannsumkbn2: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.
  • @stdlib/blas-ext/base/dnannsumors: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using ordinary recursive summation.
  • @stdlib/blas-ext/base/dsumpw: calculate the sum of double-precision floating-point strided array elements using pairwise summation.

Notice

This package is part of stdlib, a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.