diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/dsumors/README.md index a68ee7615de1..24d284967a28 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsumors/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dsumors/README.md @@ -36,7 +36,7 @@ limitations under the License. var dsumors = require( '@stdlib/blas/ext/base/dsumors' ); ``` -#### dsumors( N, x, stride ) +#### dsumors( N, x, strideX ) Computes the sum of double-precision floating-point strided array elements using ordinary recursive summation. @@ -44,9 +44,8 @@ Computes the sum of double-precision floating-point strided array elements using var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = dsumors( N, x, 1 ); +var v = dsumors( x.length, x, 1 ); // returns 1.0 ``` @@ -54,9 +53,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **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 `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: ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -81,7 +80,7 @@ var v = dsumors( 4, x1, 2 ); // returns 5.0 ``` -#### dsumors.ndarray( N, x, stride, offset ) +#### dsumors.ndarray( N, x, strideX, offsetX ) Computes the sum of double-precision floating-point strided array elements using ordinary recursive summation and alternative indexing semantics. @@ -89,17 +88,16 @@ Computes the sum of double-precision floating-point strided array elements using var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = dsumors.ndarray( N, x, 1, 0 ); +var v = dsumors.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 Float64Array = require( '@stdlib/array/float64' ); @@ -132,11 +130,12 @@ var v = dsumors.ndarray( 4, x, 2, 1 ); ```javascript -var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var dsumors = require( '@stdlib/blas/ext/base/dsumors' ); -var x = filledarrayBy( 10, 'float64', discreteUniform( 0, 100 ) ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = dsumors( x.length, x, 1 ); @@ -147,6 +146,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/dsumors.h" +``` + +#### stdlib_strided_dsumors( N, \*X, strideX ) + +Computes the sum of double-precision floating-point strided array elements using ordinary recursive summation. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; + +double v = stdlib_strided_dsumors( 4, x, 1 ); +// returns 10.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +double stdlib_strided_dsumors( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dsumors_ndarray( N, \*X, strideX, offsetX ) + +Computes the sum of double-precision floating-point strided array elements using ordinary recursive summation and alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; + +double v = stdlib_strided_dsumors_ndarray( 4, x, 1, 0 ); +// returns 10.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +double stdlib_strided_dsumors_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/dsumors.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the sum: + double v = stdlib_strided_dsumors( N, x, strideX ); + + // Print the result: + printf( "sum: %lf\n", v ); +} +``` + +
+ + + +
+ + +