diff --git a/lib/node_modules/@stdlib/blas/ext/base/sfill/README.md b/lib/node_modules/@stdlib/blas/ext/base/sfill/README.md index a58f14ca3740..a35e5d3dcf15 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sfill/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sfill/README.md @@ -30,7 +30,7 @@ limitations under the License. var sfill = require( '@stdlib/blas/ext/base/sfill' ); ``` -#### sfill( N, alpha, x, stride ) +#### sfill( N, alpha, x, strideX ) Fills a single-precision floating-point strided array `x` with a specified scalar constant `alpha`. @@ -48,7 +48,7 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment. +- **strideX**: index increment. The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element @@ -77,7 +77,7 @@ sfill( 3, 5.0, x1, 2 ); // x0 => [ 1.0, 5.0, 3.0, 5.0, 5.0, 5.0 ] ``` -#### sfill.ndarray( N, alpha, x, stride, offset ) +#### sfill.ndarray( N, alpha, x, strideX, offsetX ) Fills a single-precision floating-point strided array `x` with a specified scalar constant `alpha` using alternative indexing semantics. @@ -92,9 +92,9 @@ sfill.ndarray( x.length, 5.0, x, 1, 0 ); The function has the following additional parameters: -- **offset**: starting index. +- **offsetX**: starting index. -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 access only the last three elements of the strided array +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 access only the last three elements of the strided array ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -126,13 +126,12 @@ sfill.ndarray( 3, 5.0, x, 1, x.length-3 ); ```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 sfill = require( '@stdlib/blas/ext/base/sfill' ); -var rand = discreteUniform( -100, 100 ); - -var x = filledarrayBy( 10, 'float32', rand ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); console.log( x ); sfill( x.length, 5.0, x, 1 ); @@ -143,6 +142,126 @@ console.log( x ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/sfill.h" +``` + +#### c_sfill( N, alpha, \*X, strideX ) + +Fills a single-precision floating-point strided array `X` with a specified scalar constant `alpha`. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +c_sfill( 4, 5.0f, x, 1 ); + +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **alpha**: `[in] float` scalar constant. +- **X**: `[out] float*` input array. +- **strideX**: `[in] CBLAS_INT` index increment for `X`. + +```c +void c_sfill( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX ); +``` + +#### c_sfill_ndarray( N, alpha, \*X, strideX, offsetX ) + +Fills a single-precision floating-point strided array `X` with a specified scalar constant `alpha` using alternative indexing semantics. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +c_sfill_ndarray( 4, 5.0f, x, 1, 0 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **alpha**: `[in] float` scalar constant. +- **X**: `[out] float*` input array. +- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +void c_sfill_ndarray( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/sfill.h" +#include + +int main( void ) { + // Create a strided array: + 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; + + // Fill the array: + c_sfill( N, 5.0f, x, strideX ); + + // Print the result: + for ( int i = 0; i < 8; i++ ) { + printf( "x[ %i ] = %f\n", i, x[ i ] ); + } +} +``` + +
+ + + +
+ + +