time-to-botec/js/node_modules/@stdlib/blas/ext/base/drev/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

94 lines
2.7 KiB
Plaintext

{{alias}}( N, x, stride )
Reverses a double-precision floating-point strided array in-place.
The `N` and `stride` parameters determine which elements in `x` are accessed
at runtime.
Indexing is relative to the first index. To introduce an offset, use typed
array views.
If `N <= 0`, the function returns `x` unchanged.
Parameters
----------
N: integer
Number of indexed elements.
x: Float64Array
Input array.
stride: integer
Index increment for `x`.
Returns
-------
x: Float64Array
Input array `x`.
Examples
--------
// Standard Usage:
> var x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
> {{alias}}( x.length, x, 1 )
<Float64Array>[ -3.0, -1.0, 4.0, -5.0, 3.0, 1.0, -2.0 ]
// Using `N` and `stride` parameters:
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}( N, x, 2 )
<Float64Array>[ 4.0, 1.0, 3.0, -5.0, -2.0, -1.0, -3.0 ]
// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
> {{alias}}( N, x1, 2 )
<Float64Array>[ -6.0, 3.0, -4.0, 5.0, -2.0 ]
> x0
<Float64Array>[ 1.0, -6.0, 3.0, -4.0, 5.0, -2.0 ]
{{alias}}.ndarray( N, x, stride, offset )
Reverses a double-precision floating-point strided array in-place using
alternative indexing semantics.
While typed array views mandate a view offset based on the underlying
buffer, the `offset` parameter supports indexing semantics based on a
starting index.
Parameters
----------
N: integer
Number of indexed elements.
x: Float64Array
Input array.
stride: integer
Index increment for `x`.
offset: integer
Starting index of `x`.
Returns
-------
x: Float64Array
Input array `x`.
Examples
--------
// Standard Usage:
> var x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
> {{alias}}.ndarray( x.length, x, 1, 0 )
<Float64Array>[ -3.0, -1.0, 4.0, -5.0, 3.0, 1.0, -2.0 ]
// Using an index offset:
> x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}.ndarray( N, x, 2, 1 )
<Float64Array>[ 1.0, -6.0, 3.0, -4.0, 5.0, -2.0 ]
See Also
--------