Skip to content

Commit 1b70250

Browse files
authored
Update README.md
Signed-off-by: Kaushikgtm <[email protected]>
1 parent 6d6d131 commit 1b70250

File tree

1 file changed

+6
-6
lines changed
  • lib/node_modules/@stdlib/stats/base/nanminabs

1 file changed

+6
-6
lines changed

lib/node_modules/@stdlib/stats/base/nanminabs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
@license Apache-2.0
44
5-
Copyright (c) 2020 The Stdlib Authors.
5+
Copyright (c) 2025 The Stdlib Authors.
66
77
Licensed under the Apache License, Version 2.0 (the "License");
88
you may not use this file except in compliance with the License.
@@ -36,7 +36,7 @@ limitations under the License.
3636
var nanminabs = require( '@stdlib/stats/base/nanminabs' );
3737
```
3838

39-
#### nanminabs( N, x, stride )
39+
#### nanminabs( N, x, strideX )
4040

4141
Computes the minimum absolute value of a strided array `x`, ignoring `NaN` values.
4242

@@ -54,7 +54,7 @@ The function has the following parameters:
5454
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
5555
- **stride**: index increment for `x`.
5656

57-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the minimum absolute value of every other element in `x`,
57+
The `N` and `strideX` parameters determine which elements in `x` are accessed at runtime. For example, to compute the minimum absolute value of every other element in `x`,
5858

5959
```javascript
6060
var floor = require( '@stdlib/math/base/special/floor' );
@@ -83,7 +83,7 @@ var v = nanminabs( N, x1, 2 );
8383
// returns 1.0
8484
```
8585

86-
#### nanminabs.ndarray( N, x, stride, offset )
86+
#### nanminabs.ndarray( N, x, strideX, offsetX )
8787

8888
Computes the minimum absolute value of a strided array, ignoring `NaN` values and using alternative indexing semantics.
8989

@@ -97,9 +97,9 @@ var v = nanminabs.ndarray( N, x, 1, 0 );
9797

9898
The function has the following additional parameters:
9999

100-
- **offset**: starting index for `x`.
100+
- **offsetX**: starting index for `x`.
101101

102-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the minimum absolute value for every other value in `x` starting from the second value
102+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offsetX` parameter supports indexing semantics based on a starting index. For example, to calculate the minimum absolute value for every other value in `x` starting from the second value
103103

104104
```javascript
105105
var floor = require( '@stdlib/math/base/special/floor' );

0 commit comments

Comments
 (0)