@stdlib/blas-ext-base-sapxsumpw
v0.3.1
Published
Add a scalar constant to each single-precision floating-point strided array element and compute the sum using pairwise summation.
Readme
sapxsumpw
Add a scalar constant to each single-precision floating-point strided array element and compute the sum using pairwise summation.
Installation
npm install @stdlib/blas-ext-base-sapxsumpwUsage
var sapxsumpw = require( '@stdlib/blas-ext-base-sapxsumpw' );sapxsumpw( N, alpha, x, strideX )
Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
var v = sapxsumpw( x.length, 5.0, x, 1 );
// returns 16.0The function has the following parameters:
- N: number of indexed elements.
- alpha: scalar constant.
- x: input
Float32Array. - strideX: stride length.
The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access 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, 4.0, 2.0 ] );
var v = sapxsumpw( 4, 5.0, x, 2 );
// returns 25.0Note 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 = sapxsumpw( 4, 5.0, x1, 2 );
// returns 25.0sapxsumpw.ndarray( N, alpha, x, strideX, offsetX )
Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation and alternative indexing semantics.
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
var v = sapxsumpw.ndarray( x.length, 5.0, x, 1, 0 );
// returns 16.0The 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 access every other element starting from the second element:
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 = sapxsumpw.ndarray( 4, 5.0, x, 2, 1 );
// returns 25.0Notes
- If
N <= 0, both functions return0.0.
Examples
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var sapxsumpw = require( '@stdlib/blas-ext-base-sapxsumpw' );
var x = discreteUniform( 10, -100, 100, {
'dtype': 'float32'
});
console.log( x );
var v = sapxsumpw( x.length, 5.0, x, 1 );
console.log( v );C APIs
Usage
#include "stdlib/blas/ext/base/sapxsumpw.h"stdlib_strided_sapxsumpw( N, alpha, *X, strideX )
Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
float v = stdlib_strided_sapxsumpw( 4, 5.0f, x, 1 );
// returns 30.0fThe function accepts the following arguments:
- N:
[in] CBLAS_INTnumber of indexed elements. - alpha:
[in] floatscalar constant. - X:
[in] float*input array. - strideX:
[in] CBLAS_INTstride length.
float stdlib_strided_sapxsumpw( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX );stdlib_strided_sapxsumpw_ndarray( N, alpha, *X, strideX, offsetX )
Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation and alternative indexing semantics.
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
float v = stdlib_strided_sapxsumpw_ndarray( 4, 5.0f, x, 1, 0 );
// returns 30.0fThe function accepts the following arguments:
- N:
[in] CBLAS_INTnumber of indexed elements. - alpha:
[in] floatscalar constant. - X:
[in] float*input array. - strideX:
[in] CBLAS_INTstride length. - offsetX:
[in] CBLAS_INTstarting index.
float stdlib_strided_sapxsumpw_ndarray( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );Examples
#include "stdlib/blas/ext/base/sapxsumpw.h"
#include <stdio.h>
int main( void ) {
// Create a strided array:
const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
// Specify the number of indexed elements:
const int N = 8;
// Specify a stride:
const int strideX = 1;
// Compute the sum:
float v = stdlib_strided_sapxsumpw( N, 5.0f, x, strideX );
// Print the result:
printf( "Sum: %f\n", v );
}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/dapxsumpw: add a scalar constant to each double-precision floating-point strided array element and compute the sum using pairwise summation.@stdlib/blas-ext/base/gapxsumpw: add a scalar constant to each strided array element and compute the sum using pairwise summation.@stdlib/blas-ext/base/sapxsum: add a constant to each single-precision floating-point strided array element and compute the sum.@stdlib/blas-ext/base/ssumpw: calculate the sum of single-precision floating-point strided array elements using pairwise summation.
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-2026. The Stdlib Authors.
