Skip to content

Commit 273ee7b

Browse files
authored
Update README.md
Signed-off-by: Kaushikgtm <[email protected]>
1 parent 9c887ff commit 273ee7b

File tree

1 file changed

+27
-38
lines changed
  • lib/node_modules/@stdlib/stats/base/nanmskmin

1 file changed

+27
-38
lines changed

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

Lines changed: 27 additions & 38 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.
@@ -52,20 +52,18 @@ The function has the following parameters:
5252

5353
- **N**: number of indexed elements.
5454
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
55-
- **strideX**: index increment for `x`.
55+
- **strideX**: stride length for `x`.
5656
- **mask**: mask [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and **excluded** from computation.
57-
- **strideMask**: index increment for `mask`.
57+
- **strideMask**: stride length for `mask`.
5858

59-
The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
59+
The `N` and `stride` parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
6060

6161
```javascript
62-
var floor = require( '@stdlib/math/base/special/floor' );
63-
6462
var x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, -5.0, -6.0 ];
6563
var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ];
66-
var N = floor( x.length / 2 );
6764

68-
var v = nanmskmin( N, x, 2, mask, 2 );
65+
66+
var v = nanmskmin( 4, x, 2, mask, 2 );
6967
// returns -7.0
7068
```
7169

@@ -76,17 +74,16 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t
7674
```javascript
7775
var Float64Array = require( '@stdlib/array/float64' );
7876
var Uint8Array = require( '@stdlib/array/uint8' );
79-
var floor = require( '@stdlib/math/base/special/floor' );
77+
8078

8179
var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
8280
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8381

8482
var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
8583
var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8684

87-
var N = floor( x0.length / 2 );
8885

89-
var v = nanmskmin( N, x1, 2, mask1, 2 );
86+
var v = nanmskmin( 4, x1, 2, mask1, 2 );
9087
// returns -2.0
9188
```
9289

@@ -107,16 +104,15 @@ The function has the following additional parameters:
107104
- **offsetX**: starting index for `x`.
108105
- **offsetMask**: starting index for `mask`.
109106

110-
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 value for every other value in `x` starting from the second value
107+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset
108+
indexing semantics based on
109+
starting indices. For example, to calculate the minimum value for every other value in `x` starting from the second value
111110

112111
```javascript
113-
var floor = require( '@stdlib/math/base/special/floor' );
114-
115112
var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0 ];
116113
var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ];
117-
var N = floor( x.length / 2 );
118114

119-
var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 );
115+
var v = nanmskmin.ndarray( 4, x, 2, 1, mask, 2, 1 );
120116
// returns -2.0
121117
```
122118

@@ -130,6 +126,8 @@ var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 );
130126

131127
- If `N <= 0`, both functions return `NaN`.
132128
- Depending on the environment, the typed versions ([`dnanmskmin`][@stdlib/stats/base/dnanmskmin], [`snanmskmin`][@stdlib/stats/base/snanmskmin], etc.) are likely to be significantly more performant.
129+
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
130+
133131

134132
</section>
135133

@@ -142,31 +140,18 @@ var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 );
142140
<!-- eslint no-undef: "error" -->
143141

144142
```javascript
145-
var randu = require( '@stdlib/random/base/randu' );
146-
var round = require( '@stdlib/math/base/special/round' );
147-
var Float64Array = require( '@stdlib/array/float64' );
148-
var Uint8Array = require( '@stdlib/array/uint8' );
143+
var uniform = require( '@stdlib/random/array/uniform' );
144+
var bernoulli = require( '@stdlib/random/array/bernoulli' );
149145
var nanmskmin = require( '@stdlib/stats/base/nanmskmin' );
150146

151-
var mask;
152-
var x;
153-
var i;
154-
155-
x = new Float64Array( 10 );
156-
mask = new Uint8Array( x.length );
157-
for ( i = 0; i < x.length; i++ ) {
158-
if ( randu() < 0.2 ) {
159-
mask[ i ] = 1;
160-
} else {
161-
mask[ i ] = 0;
162-
}
163-
if ( randu() < 0.1 ) {
164-
x[ i ] = NaN;
165-
} else {
166-
x[ i ] = round( (randu()*100.0) - 50.0 );
167-
}
168-
}
147+
var x = uniform( 10, -50.0, 50.0, {
148+
'dtype': 'float64'
149+
});
169150
console.log( x );
151+
152+
var mask = bernoulli( x.length, 0.2, {
153+
'dtype': 'uint8'
154+
});
170155
console.log( mask );
171156

172157
var v = nanmskmin( x.length, x, 1, mask, 1 );
@@ -201,6 +186,10 @@ console.log( v );
201186

202187
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
203188

189+
190+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
191+
192+
204193
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
205194

206195
<!-- <related-links> -->

0 commit comments

Comments
 (0)