Skip to content

Commit a47a21e

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

File tree

1 file changed

+43
-24
lines changed
  • lib/node_modules/@stdlib/stats/base/nanminabs/docs

1 file changed

+43
-24
lines changed
Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,112 @@
1-
21
{{alias}}( N, x, strideX )
2+
33
Computes the minimum absolute value of a strided array, ignoring `NaN`
44
values.
55

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

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

1212
If `N <= 0`, the function returns `NaN`.
1313

14+
1415
Parameters
1516
----------
16-
N: integer
17+
18+
N: integer
1719
Number of indexed elements.
1820

19-
x: Array<number>|TypedArray
21+
x: Array<number>|TypedArray
2022
Input array.
2123

22-
strideX: integer
23-
stride length.
24+
strideX: integer
25+
Stride length.
2426

27+
2528
Returns
2629
-------
27-
out: number
30+
31+
out: number
2832
Minimum absolute value.
2933

34+
3035
Examples
3136
--------
37+
3238
// Standard Usage:
3339
> var x = [ 1.0, -2.0, NaN, 2.0 ];
34-
> {{alias}}( x.length, x, 1 )
40+
> {{alias}}( x.length, x, 1 );
3541
1.0
3642

3743
// Using `N` and `stride` parameters:
3844
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ];
3945
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
4046
> var stride = 2;
41-
> {{alias}}( N, x, stride )
47+
> {{alias}}( N, x, stride );
4248
1.0
4349

4450
// Using view offsets:
45-
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
46-
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
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+
);
4757
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
4858
> stride = 2;
49-
> {{alias}}( N, x1, stride )
59+
> {{alias}}( N, x1, stride );
5060
1.0
5161

62+
5263
{{alias}}.ndarray( N, x, stride, offset )
64+
5365
Computes the minimum absolute value of a strided array, ignoring `NaN`
5466
values and using alternative indexing semantics.
5567

5668
While typed array views mandate a view offset based on the underlying
57-
buffer, the `offset` parameter supports indexing semantics based on a
69+
buffer, the `offset` parameter supports indexing semantics based on a
5870
starting index.
5971

72+
6073
Parameters
6174
----------
62-
N: integer
75+
76+
N: integer
6377
Number of indexed elements.
6478

65-
x: Array<number>|TypedArray
79+
x: Array<number>|TypedArray
6680
Input array.
6781

68-
strideX: integer
69-
stride length.
82+
strideX: integer
83+
Stride length.
7084

71-
offsetX: integer
85+
offsetX: integer
7286
Starting index.
7387

88+
7489
Returns
7590
-------
76-
out: number
91+
92+
out: number
7793
Minimum absolute value.
7894

95+
7996
Examples
8097
--------
98+
8199
// Standard Usage:
82100
> var x = [ 1.0, -2.0, NaN, 2.0 ];
83-
> {{alias}}.ndarray( x.length, x, 1, 0 )
101+
> {{alias}}.ndarray( x.length, x, 1, 0 );
84102
1.0
85103

86104
// Using offset parameter:
87105
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ];
88106
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
89-
> {{alias}}.ndarray( N, x, 2, 1 )
107+
> {{alias}}.ndarray( N, x, 2, 1 );
90108
1.0
91109

110+
92111
See Also
93112
--------

0 commit comments

Comments
 (0)