diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/README.md b/lib/node_modules/@stdlib/blas/ext/base/srev/README.md index d9b2cbd85f17..1832c30d3f88 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/srev/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/srev/README.md @@ -30,9 +30,9 @@ limitations under the License. var srev = require( '@stdlib/blas/ext/base/srev' ); ``` -#### srev( N, x, stride ) +#### srev( N, x, strideX ) -Reverses a single-precision floating-point strided array `x` in-place. +Reverses a single-precision floating-point strided array in-place. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -47,9 +47,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment. +- **strideX**: stride length. -The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to reverse every other element +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to reverse every other element: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -76,9 +76,9 @@ srev( 3, x1, 2 ); // x0 => [ 1.0, -6.0, 3.0, -4.0, 5.0, -2.0 ] ``` -#### srev.ndarray( N, x, stride, offset ) +#### srev.ndarray( N, x, strideX, offsetX ) -Reverses a single-precision floating-point strided array `x` in-place using alternative indexing semantics. +Reverses a single-precision floating-point strided array in-place using alternative indexing semantics. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -91,9 +91,9 @@ srev.ndarray( x.length, 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 @@ srev.ndarray( 3, 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 srev = require( '@stdlib/blas/ext/base/srev' ); -var rand = discreteUniform( -100, 100 ); - -var x = filledarrayBy( 10, 'float32', rand ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); console.log( x ); srev( x.length, x, 1 ); @@ -143,6 +142,123 @@ console.log( x ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/srev.h" +``` + +#### stdlib_strided_srev( N, \*X, strideX ) + +Reverses a single-precision floating-point strided array in-place. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +stdlib_strided_srev( 4, x, 1 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[inout] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. + +```c +void stdlib_strided_srev( const CBLAS_INT N, float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_srev_ndarray( N, \*X, strideX, offsetX ) + +Reverses a single-precision floating-point strided array in-place using alternative indexing semantics. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +stdlib_strided_srev_ndarray( 4, x, 1, 0 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[inout] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. +- **offsetX**: `[in] CBLAS_INT` starting index. + +```c +void stdlib_strided_srev_ndarray( const CBLAS_INT N, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/srev.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 elements: + const int N = 8; + + // Specify a stride: + const int strideX = 1; + + // Reverse the array: + stdlib_strided_srev( N, x, strideX ); + + // Print the result: + for ( int i = 0; i < 8; i++ ) { + printf( "x[ %i ] = %f\n", i, x[ i ] ); + } +} +``` + +
+ + + +
+ + +