Skip to content

Commit a672185

Browse files
authored
Update repl.txt
Signed-off-by: Kaushikgtm <[email protected]>
1 parent 612e0a8 commit a672185

File tree

1 file changed

+28
-52
lines changed
  • lib/node_modules/@stdlib/stats/base/nanminabs/docs

1 file changed

+28
-52
lines changed
Lines changed: 28 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,88 @@
1-
{{alias}}( N, x, strideX )
21

3-
Computes the minimum absolute value of a strided array, ignoring `NaN`
4-
values.
2+
{{alias}}( N, x, strideX )
3+
Computes the minimum absolute value of a strided array, ignoring `NaN` values.
54

6-
The `N` and `strideX` parameters determine which elements in the strided
7-
array are accessed at runtime.
5+
The `N` and stride parameters determine which elements in the strided array
6+
are accessed at runtime.
87

9-
Indexing is relative to the first index. To introduce an offset, use a
10-
typed array view.
8+
Indexing is relative to the first index. To introduce an offset, use a typed
9+
array view.
1110

1211
If `N <= 0`, the function returns `NaN`.
1312

14-
1513
Parameters
1614
----------
17-
18-
N: integer
15+
N: integer
1916
Number of indexed elements.
2017

21-
x: Array<number>|TypedArray
18+
x: Array<number>|TypedArray
2219
Input array.
2320

24-
strideX: integer
21+
strideX: integer
2522
Stride length.
2623

27-
2824
Returns
2925
-------
30-
31-
out: number
26+
out: number
3227
Minimum absolute value.
3328

34-
3529
Examples
3630
--------
37-
3831
// Standard Usage:
39-
> var x = [ 1.0, -2.0, NaN, 2.0 ]
32+
> var x = [ 1.0, -2.0, NaN, 2.0 ];
4033
> {{alias}}( x.length, x, 1 )
4134
1.0
4235

4336
// Using `N` and `stride` parameters:
44-
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ]
45-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 )
46-
> var stride = 2
47-
> {{alias}}( N, x, stride )
37+
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ];
38+
> {{alias}}( 4, x, 2 )
4839
1.0
4940

5041
// Using view offsets:
51-
> var x0 = new {{alias:@stdlib/array/float64}}([
52-
1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN
53-
])
54-
> var x1 = new {{alias:@stdlib/array/float64}}(
55-
x0.buffer, x0.BYTES_PER_ELEMENT * 1
56-
)
57-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 )
58-
> stride = 2
59-
> {{alias}}( N, x1, stride )
42+
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
43+
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
44+
> {{alias}}( 4, x1, 2 )
6045
1.0
6146

6247

63-
{{alias}}.ndarray( N, x, stride, offset )
64-
65-
Computes the minimum absolute value of a strided array, ignoring `NaN`
66-
values and using alternative indexing semantics.
48+
{{alias}}.ndarray( N, x, strideX, offsetX )
49+
Computes the minimum absolute value of a strided array, ignoring `NaN` values and using
50+
alternative indexing semantics.
6751

6852
While typed array views mandate a view offset based on the underlying
69-
buffer, the `offset` parameter supports indexing semantics based on a
53+
buffer, the `offset` parameter supports indexing semantics based on a
7054
starting index.
7155

72-
7356
Parameters
7457
----------
75-
76-
N: integer
58+
N: integer
7759
Number of indexed elements.
7860

79-
x: Array<number>|TypedArray
61+
x: Array<number>|TypedArray
8062
Input array.
8163

82-
strideX: integer
64+
strideX: integer
8365
Stride length.
8466

85-
offsetX: integer
67+
offsetX: integer
8668
Starting index.
8769

88-
8970
Returns
9071
-------
91-
92-
out: number
72+
out: number
9373
Minimum absolute value.
9474

95-
9675
Examples
9776
--------
98-
9977
// Standard Usage:
100-
> var x = [ 1.0, -2.0, NaN, 2.0 ]
78+
> var x = [ 1.0, -2.0, NaN, 2.0 ];
10179
> {{alias}}.ndarray( x.length, x, 1, 0 )
10280
1.0
10381

10482
// Using offset parameter:
105-
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ]
106-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 )
107-
> {{alias}}.ndarray( N, x, 2, 1 )
83+
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ];
84+
> {{alias}}.ndarray( 4, x, 2, 1 )
10885
1.0
10986

110-
11187
See Also
11288
--------

0 commit comments

Comments
 (0)