README
scusumors
Calculate the cumulative sum of single-precision floating-point strided array elements using ordinary recursive summation.
Installation
npm install @stdlib/blas-ext-base-scusumors
Usage
var scusumors = require( '@stdlib/blas-ext-base-scusumors' );
scusumors( N, sum, x, strideX, y, strideY )
Computes the cumulative sum of single-precision floating-point strided array elements using ordinary recursive summation.
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
var y = new Float32Array( x.length );
scusumors( x.length, 0.0, x, 1, y, 1 );
// y => <Float32Array>[ 1.0, -1.0, 1.0 ]
x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
y = new Float32Array( x.length );
scusumors( x.length, 10.0, x, 1, y, 1 );
// y => <Float32Array>[ 11.0, 9.0, 11.0 ]
The function has the following parameters:
- N: number of indexed elements.
- sum: initial sum.
- x: input
Float32Array
. - strideX: index increment for
x
. - y: output
Float32Array
. - strideY: index increment for
y
.
The N
and stride
parameters determine which elements in x
and y
are accessed at runtime. For example, to compute the cumulative sum of every other element in x
,
var Float32Array = require( '@stdlib/array-float32' );
var floor = require( '@stdlib/math-base-special-floor' );
var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
var y = new Float32Array( x.length );
var N = floor( x.length / 2 );
var v = scusumors( N, 0.0, x, 2, y, 1 );
// y => <Float32Array>[ 1.0, 3.0, 1.0, 5.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' );
var floor = require( '@stdlib/math-base-special-floor' );
// Initial arrays...
var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
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
var N = floor( x0.length / 2 );
scusumors( N, 0.0, x1, -2, y1, 1 );
// y0 => <Float32Array>[ 0.0, 0.0, 0.0, 4.0, 6.0, 4.0, 5.0, 0.0 ]
scusumors.ndarray( N, sum, x, strideX, offsetX, y, strideY, offsetY )
Computes the cumulative sum of single-precision floating-point strided array elements using ordinary recursive summation and alternative indexing semantics.
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
var y = new Float32Array( x.length );
scusumors.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
, offsetX
and offsetY
parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative sum of every other value in x
starting from the second value and to store in the last N
elements of y
starting from the last element
var Float32Array = require( '@stdlib/array-float32' );
var floor = require( '@stdlib/math-base-special-floor' );
var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var y = new Float32Array( x.length );
var N = floor( x.length / 2 );
scusumors.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 );
// y => <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 5.0, 1.0, -1.0, 1.0 ]
Notes
- If
N <= 0
, both functions returny
unchanged. - Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation is acceptable; in all other cases, exercise due caution.
Examples
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var Float32Array = require( '@stdlib/array-float32' );
var scusumors = require( '@stdlib/blas-ext-base-scusumors' );
var y;
var x;
var i;
x = new Float32Array( 10 );
y = new Float32Array( x.length );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = round( randu()*100.0 );
}
console.log( x );
console.log( y );
scusumors( x.length, 0.0, x, 1, y, -1 );
console.log( y );
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, 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
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.