time-to-botec/squiggle/node_modules/@stdlib/stats/base/nanrange/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.2 KiB
Plaintext

{{alias}}( N, x, stride )
Computes the range of a strided array, ignoring `NaN` values.
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 a typed
array view.
If `N <= 0`, the function returns `NaN`.
Parameters
----------
N: integer
Number of indexed elements.
x: Array<number>|TypedArray
Input array.
stride: integer
Index increment.
Returns
-------
out: number
Range.
Examples
--------
// Standard Usage:
> var x = [ 1.0, -2.0, NaN, 2.0 ];
> {{alias}}( x.length, x, 1 )
4.0
// Using `N` and `stride` parameters:
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ];
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> var stride = 2;
> {{alias}}( N, x, stride )
4.0
// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
> stride = 2;
> {{alias}}( N, x1, stride )
4.0
{{alias}}.ndarray( N, x, stride, offset )
Computes the range of a strided array, ignoring `NaN` values and 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: Array<number>|TypedArray
Input array.
stride: integer
Index increment.
offset: integer
Starting index.
Returns
-------
out: number
Range.
Examples
--------
// Standard Usage:
> var x = [ 1.0, -2.0, NaN, 2.0 ];
> {{alias}}.ndarray( x.length, x, 1, 0 )
4.0
// Using offset parameter:
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ];
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}.ndarray( N, x, 2, 1 )
4.0
See Also
--------