diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/snansumors/README.md index 95c9f6665e35..b9b71d6e931c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/snansumors/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/snansumors/README.md @@ -36,7 +36,7 @@ limitations under the License. var snansumors = require( '@stdlib/blas/ext/base/snansumors' ); ``` -#### snansumors( N, x, stride ) +#### snansumors( N, x, strideX ) Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation. @@ -44,9 +44,8 @@ Computes the sum of single-precision floating-point strided array elements, igno var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snansumors( N, x, 1 ); +var v = snansumors( x.length, x, 1 ); // returns 1.0 ``` @@ -54,11 +53,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment for the strided array. +- **strideX**: stride length for `x`. -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 in -the strided array. +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: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -84,7 +81,7 @@ var v = snansumors( 4, x1, 2 ); // returns 5.0 ``` -#### snansumors.ndarray( N, x, stride, offset ) +#### snansumors.ndarray( N, x, strideX, offsetX ) Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. @@ -92,17 +89,16 @@ Computes the sum of single-precision floating-point strided array elements, igno var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snansumors.ndarray( N, x, 1, 0 ); +var v = snansumors.ndarray( x.length, x, 1, 0 ); // returns 1.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index for `x`. -While [`typed array`][mdn-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 value in `x` starting from the second value +While [`typed array`][mdn-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: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -158,6 +154,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/snansumors.h" +``` + +#### stdlib_strided_snansumors( N, \*X, strideX ) + +Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation. + +```c +const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, 2.0f }; + +float v = stdlib_strided_snansumors( 4, x, 1 ); +// returns 1.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +float stdlib_strided_snansumors( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_snansumors_ndarray( N, \*X, strideX, offsetX ) + +Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. + +```c +const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, 2.0f }; + +float v = stdlib_strided_snansumors_ndarray( 4, x, 1, 0 ); +// returns 1.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +float stdlib_strided_snansumors_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/snansumors.h" +#include + +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, 0.0f/0.0f, 0.0f/0.0f }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride length: + const int strideX = 2; + + // Compute the sum: + float v = stdlib_strided_snansumors( N, x, strideX ); + + // Print the result: + printf( "sum: %f\n", v ); +} +``` + +
+ + + +
+ + +