Skip to content

README.md

Latest commit

 

History

History
340 lines (216 loc) · 9.55 KB

README.md

File metadata and controls

340 lines (216 loc) · 9.55 KB

snancusumkbn2

Calculate the cumulative sum of single-precision floating-point strided array elements ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.

Usage

var snancusumkbn2 = require( '@stdlib/blas/ext/base/snancusumkbn2' );

snancusumkbn2( N, sum, x, strideX, y, strideY )

Computes the cumulative sum of single-precision floating-point strided array elements ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, -2.0, NaN ] );
var y = new Float32Array( x.length );

snancusumkbn2( x.length, 0.0, x, 1, y, 1 );
// y => <Float32Array>[ 1.0, -1.0, -1.0 ]

x = new Float32Array( [ 1.0, -2.0, NaN ] );
y = new Float32Array( x.length );

snancusumkbn2( x.length, 10.0, x, 1, y, 1 );
// y => <Float32Array>[ 11.0, 9.0, 9.0 ]

The function has the following parameters:

  • N: number of indexed elements.
  • sum: initial sum.
  • x: input Float32Array.
  • strideX: stride length for x.
  • y: output Float32Array.
  • strideY: stride length for y.

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

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, NaN, NaN ] );
var y = new Float32Array( x.length );

var v = snancusumkbn2( 4, 0.0, x, 2, y, 1 );
// y => <Float32Array>[ 1.0, 3.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]

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

var Float32Array = require( '@stdlib/array/float32' );

// Initial arrays...
var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, NaN, NaN ] );
var y0 = new Float32Array( x0.length );

// Create offset views...
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element

snancusumkbn2( 4, 0.0, x1, -2, y1, 1 );
// y0 => <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 2.0, 0.0, 1.0, 0.0 ]

snancusumkbn2.ndarray( N, sum, x, strideX, offsetX, y, strideY, offsetY )

Computes the cumulative sum of single-precision floating-point strided array elements ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, -2.0, NaN ] );
var y = new Float32Array( x.length );

snancusumkbn2.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 );
// y => <Float32Array>[ 1.0, -1.0, -1.0 ]

The function has the following additional parameters:

  • offsetX: starting index for x.
  • offsetY: starting index for y.

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 cumulative sum of every other element in the strided input array starting from the second element and to store in the last N elements of the strided output array starting from the last element:

var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, NaN, NaN ] );
var y = new Float32Array( x.length );

snancusumkbn2.ndarray( 4, 0.0, x, 2, 1, y, -1, y.length-1 );
// y => <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, -1.0, 1.0 ]

Notes

  • If N <= 0, both functions return y unchanged.

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var zeros = require( '@stdlib/array/zeros' );
var snancusumkbn2 = require( '@stdlib/blas/ext/base/snancusumkbn2' );

function rand() {
    if ( bernoulli( 0.7 ) > 0 ) {
        return discreteUniform( 0, 100 );
    }
    return NaN;
}

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

var y = zeros( 10, 'float32' );
console.log( y );

snancusumkbn2( x.length, 0.0, x, 1, y, -1 );
console.log( y );

C APIs

Usage

#include "stdlib/blas/ext/base/snancusumkbn2.h"

stdlib_strided_snancusumkbn2( N, sum, *X, strideX, *Y, strideY )

Computes the cumulative sum of single-precision floating-point strided array elements ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.

const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };

stdlib_strided_snancusumkbn2( 4, 0.0f, x, 1, y, 1 );

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • sum: [in] float initial sum.
  • X: [in] float* input array.
  • strideX: [in] CBLAS_INT stride length for X.
  • Y: [out] float* output array.
  • strideY: [in] CBLAS_INT stride length for Y.
void stdlib_strided_snancusumkbn2( const CBLAS_INT N, const float sum, const float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY );

stdlib_strided_snancusumkbn2_ndarray( N, sum, *X, strideX, offsetX, *Y, strideY, offsetY )

Computes the cumulative sum of single-precision floating-point strided array elements ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.

const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };

stdlib_strided_snancusumkbn2_ndarray( 4, 0.0f, x, 1, 0, y, 1, 0 );

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • sum: [in] float initial sum.
  • X: [in] float* input array.
  • strideX: [in] CBLAS_INT stride length for X.
  • offsetX: [in] CBLAS_INT starting index for X.
  • Y: [out] float* output array.
  • strideY: [in] CBLAS_INT stride length for Y.
  • offsetY: [in] CBLAS_INT starting index for Y.
void stdlib_strided_snancusumkbn2_ndarray( const CBLAS_INT N, const float sum, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );

Examples

#include "stdlib/blas/ext/base/snancusumkbn2.h"
#include <stdio.h>

int main( void ) {
    // Create strided arrays:
    const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 0.0f/0.0f, 0.0f/0.0f };
    float y[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };

    // Specify the number of elements:
    const int N = 4;

    // Specify stride lengths:
    const int strideX = 2;
    const int strideY = -2;

    // Compute the cumulative sum:
    stdlib_strided_snancusumkbn2( N, 0.0f, x, strideX, y, strideY );

    // Print the result:
    for ( int i = 0; i < 8; i++ ) {
        printf( "y[ %d ] = %f\n", i, y[ i ] );
    }
}

References

  • Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." Computing 76 (3): 279–93. doi:10.1007/s00607-005-0139-x.