Skip to content

Files

Latest commit

 

History

History

gsumors

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

gsumors

Calculate the sum of strided array elements using ordinary recursive summation.

Usage

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

gsumors( N, x, strideX )

Computes the sum of strided array elements using ordinary recursive summation.

var x = [ 1.0, -2.0, 2.0 ];

var v = gsumors( x.length, x, 1 );
// returns 1.0

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Array or typed array.
  • strideX: stride length.

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

var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];

var v = gsumors( 4, x, 2 );
// returns 5.0

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

var Float64Array = require( '@stdlib/array/float64' );

var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -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 v = gsumors( 4, x1, 2 );
// returns 5.0

gsumors.ndarray( N, x, strideX, offsetX )

Computes the sum of strided array elements using ordinary recursive summation and alternative indexing semantics.

var x = [ 1.0, -2.0, 2.0 ];

var v = gsumors.ndarray( x.length, x, 1, 0 );
// returns 1.0

The function has the following additional parameters:

  • offsetX: starting index.

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

var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];

var v = gsumors.ndarray( 4, x, 2, 1 );
// returns 5.0

Notes

  • If N <= 0, both functions return 0.0.
  • 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.
  • Both functions support array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array/base/accessor).
  • Depending on the environment, the typed versions (dsumors, ssumors, etc.) are likely to be significantly more performant.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var gsumors = require( '@stdlib/blas/ext/base/gsumors' );

var x = discreteUniform( 10, -100, 100, {
    'dtype': 'float64'
});
console.log( x );

var v = gsumors( x.length, x, 1 );
console.log( v );

See Also