sapxsum

Add a constant to each single-precision floating-point strided array element and compute the sum.

Installation

npm install @stdlib/blas-ext-base-sapxsum

Usage

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

sapxsum( N, alpha, x, stride )

Adds a constant to each single-precision floating-point strided array element and computes the sum.

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

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

var v = sapxsum( N, 5.0, x, 1 );
// returns 16.0

The function has the following parameters:

• N: number of indexed elements.
• x: input Float32Array.
• stride: index increment for x.

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

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

var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );

var v = sapxsum( 4, 5.0, x, 2 );
// returns 25.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 x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var v = sapxsum( 4, 5.0, x1, 2 );
// returns 25.0

sapxsum.ndarray( N, alpha, x, stride, offset )

Adds a constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics.

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

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

var v = sapxsum.ndarray( N, 5.0, x, 1, 0 );
// returns 16.0

The function has the following additional parameters:

• offset: starting index for x.

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 access every other value in x starting from the second value

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

var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );

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

Notes

• If N <= 0, both functions return 0.0.

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var filledarrayBy = require( '@stdlib/array-filled-by' );
var sapxsum = require( '@stdlib/blas-ext-base-sapxsum' );

var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
console.log( x );

See Also

• @stdlib/blas-ext/base/dapxsum: adds a constant to each double-precision floating-point strided array element and computes the sum.
• @stdlib/blas-ext/base/gapxsum: adds a constant to each strided array element and computes the sum.
• @stdlib/blas-ext/base/sapxsumpw: adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.
• @stdlib/blas-ext/base/ssum: calculate the sum of single-precision floating-point strided array elements.

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-2024. The Stdlib Authors.