Skip to content

Commit 7195c03

Browse files
authored
Update repl.txt
Signed-off-by: Kaushikgtm <[email protected]>
1 parent 56bf3f6 commit 7195c03

File tree

1 file changed

+19
-24
lines changed
  • lib/node_modules/@stdlib/stats/base/nanmaxabs/docs

1 file changed

+19
-24
lines changed
Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

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

6-
The `N` and `stride` parameters determine which elements in `x` are accessed
7-
at runtime.
6+
The `N` and stride parameters determine which elements in the
7+
stridedarray 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,
10+
use a typed array view.
1111

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

@@ -19,13 +19,13 @@
1919
x: Array<number>|TypedArray
2020
Input array.
2121

22-
stride: integer
23-
Index increment.
22+
strideX: integer
23+
Stride length.
2424

2525
Returns
2626
-------
2727
out: number
28-
Maximum absolute value.
28+
maximum absolute value.
2929

3030
Examples
3131
--------
@@ -36,20 +36,17 @@
3636

3737
// Using `N` and `stride` parameters:
3838
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ];
39-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
40-
> var stride = 2;
41-
> {{alias}}( N, x, stride )
39+
> {{alias}}( 4, x, 2 )
4240
2.0
4341

4442
// Using view offsets:
4543
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
4644
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
47-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
48-
> stride = 2;
49-
> {{alias}}( N, x1, stride )
45+
> {{alias}}( 4, x1, 2 )
5046
2.0
5147

52-
{{alias}}.ndarray( N, x, stride, offset )
48+
49+
{{alias}}.ndarray( N, x, strideX, offsetX )
5350
Computes the maximum absolute value of a strided array, ignoring `NaN`
5451
values and using alternative indexing semantics.
5552

@@ -65,16 +62,16 @@
6562
x: Array<number>|TypedArray
6663
Input array.
6764

68-
stride: integer
69-
Index increment.
65+
strideX: integer
66+
Stride length.
7067

71-
offset: integer
68+
offsetX: integer
7269
Starting index.
7370

7471
Returns
7572
-------
7673
out: number
77-
Maximum absolute value.
74+
maximum absolute value.
7875

7976
Examples
8077
--------
@@ -85,10 +82,8 @@
8582

8683
// Using offset parameter:
8784
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ];
88-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
89-
> {{alias}}.ndarray( N, x, 2, 1 )
85+
> {{alias}}.ndarray( 4, x, 2, 1 )
9086
2.0
9187

9288
See Also
9389
--------
94-

0 commit comments

Comments
 (0)