You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/stats/base/nanmskmin/README.md
+52-64Lines changed: 52 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,37 +33,36 @@ limitations under the License.
33
33
## Usage
34
34
35
35
```javascript
36
-
var nanmskmin =require('@stdlib/stats/base/nanmskmin');
36
+
var nanmskmin =require("@stdlib/stats/base/nanmskmin");
37
37
```
38
38
39
39
#### nanmskmin( N, x, strideX, mask, strideMask )
40
40
41
41
Computes the minimum value of a strided array `x` according to a `mask`, ignoring `NaN` values.
42
42
43
43
```javascript
44
-
var x = [1.0, -2.0, -4.0, 2.0, NaN];
45
-
var mask = [0, 0, 1, 0, 0];
44
+
var x = [1.0, -2.0, -4.0, 2.0, NaN];
45
+
var mask = [0, 0, 1, 0, 0];
46
46
47
-
var v =nanmskmin(x.length, x, 1, mask, 1);
47
+
var v =nanmskmin(x.length, x, 1, mask, 1);
48
48
// returns -2.0
49
49
```
50
50
51
51
The function has the following parameters:
52
52
53
-
-**N**: number of indexed elements.
54
-
-**x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
55
-
-**strideX**: stride length for `x`.
56
-
-**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**: stride length for `mask`.
53
+
-**N**: number of indexed elements.
54
+
-**x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
55
+
-**strideX**: stride length for `x`.
56
+
-**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**: stride length for `mask`.
58
58
59
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`,
60
60
61
61
```javascript
62
-
var x = [1.0, 2.0, -7.0, -2.0, 4.0, 3.0, -5.0, -6.0];
63
-
var mask = [0, 0, 0, 0, 0, 0, 1, 1];
62
+
var x = [1.0, 2.0, -7.0, -2.0, 4.0, 3.0, -5.0, -6.0];
63
+
var mask = [0, 0, 0, 0, 0, 0, 1, 1];
64
64
65
-
66
-
var v =nanmskmin( 4, x, 2, mask, 2 );
65
+
var v =nanmskmin(4, x, 2, mask, 2);
67
66
// returns -7.0
68
67
```
69
68
@@ -72,18 +71,16 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t
varx1=newFloat64Array(x0.buffer, x0.BYTES_PER_ELEMENT*1); // start at 2nd element
84
79
80
+
var mask0 =newUint8Array([0, 0, 0, 0, 0, 0, 1, 1]);
81
+
var mask1 =newUint8Array(mask0.buffer, mask0.BYTES_PER_ELEMENT*1); // start at 2nd element
85
82
86
-
var v =nanmskmin(4, x1, 2, mask1, 2);
83
+
var v =nanmskmin(4, x1, 2, mask1, 2);
87
84
// returns -2.0
88
85
```
89
86
@@ -92,27 +89,27 @@ var v = nanmskmin( 4, x1, 2, mask1, 2 );
92
89
Computes the minimum value of a strided array according to a `mask`, ignoring `NaN` values and using alternative indexing semantics.
93
90
94
91
```javascript
95
-
var x = [1.0, -2.0, -4.0, 2.0, NaN];
96
-
var mask = [0, 0, 1, 0, 0];
92
+
var x = [1.0, -2.0, -4.0, 2.0, NaN];
93
+
var mask = [0, 0, 1, 0, 0];
97
94
98
-
var v =nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, 0);
95
+
var v =nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, 0);
99
96
// returns -2.0
100
97
```
101
98
102
99
The function has the following additional parameters:
103
100
104
-
-**offsetX**: starting index for `x`.
105
-
-**offsetMask**: starting index for `mask`.
101
+
-**offsetX**: starting index for `x`.
102
+
-**offsetMask**: starting index for `mask`.
106
103
107
104
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset
108
105
indexing semantics based on
109
106
starting indices. For example, to calculate the minimum value for every other value in `x` starting from the second value
110
107
111
108
```javascript
112
-
var x = [2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0];
113
-
var mask = [0, 0, 0, 0, 0, 0, 1, 1];
109
+
var x = [2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0];
110
+
var mask = [0, 0, 0, 0, 0, 0, 1, 1];
114
111
115
-
var v =nanmskmin.ndarray(4, x, 2, 1, mask, 2, 1);
112
+
var v =nanmskmin.ndarray(4, x, 2, 1, mask, 2, 1);
116
113
// returns -2.0
117
114
```
118
115
@@ -124,10 +121,9 @@ var v = nanmskmin.ndarray( 4, x, 2, 1, mask, 2, 1 );
124
121
125
122
## Notes
126
123
127
-
- If `N <= 0`, both functions return `NaN`.
128
-
- 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
-
124
+
- If `N <= 0`, both functions return `NaN`.
125
+
- 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.
126
+
- 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]).
131
127
132
128
</section>
133
129
@@ -140,22 +136,22 @@ var v = nanmskmin.ndarray( 4, x, 2, 1, mask, 2, 1 );
140
136
<!-- eslint no-undef: "error" -->
141
137
142
138
```javascript
143
-
var uniform =require('@stdlib/random/array/uniform');
144
-
var bernoulli =require('@stdlib/random/array/bernoulli');
145
-
var nanmskmin =require('@stdlib/stats/base/nanmskmin');
146
-
147
-
var x =uniform(10, -50.0, 50.0, {
148
-
'dtype':'float64'
149
-
});
150
-
console.log( x );
151
-
152
-
var mask =bernoulli(x.length, 0.2, {
153
-
'dtype':'uint8'
154
-
});
155
-
console.log(mask);
156
-
157
-
var v =nanmskmin(x.length, x, 1, mask, 1);
158
-
console.log( v );
139
+
var uniform =require("@stdlib/random/array/uniform");
140
+
var bernoulli =require("@stdlib/random/array/bernoulli");
141
+
var nanmskmin =require("@stdlib/stats/base/nanmskmin");
142
+
143
+
var x =uniform(10, -50.0, 50.0, {
144
+
dtype:"float64",
145
+
});
146
+
console.log(x);
147
+
148
+
var mask =bernoulli(x.length, 0.2, {
149
+
dtype:"uint8",
150
+
});
151
+
console.log(mask);
152
+
153
+
var v =nanmskmin(x.length, x, 1, mask, 1);
154
+
console.log(v);
159
155
```
160
156
161
157
</section>
@@ -166,15 +162,15 @@ console.log( v );
166
162
167
163
<sectionclass="related">
168
164
169
-
* * *
165
+
---
170
166
171
167
## See Also
172
168
173
-
-<spanclass="package-name">[`@stdlib/stats/base/dnanmskmin`][@stdlib/stats/base/dnanmskmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a double-precision floating-point strided array according to a mask, ignoring NaN values.</span>
174
-
-<spanclass="package-name">[`@stdlib/stats/base/mskmin`][@stdlib/stats/base/mskmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a strided array according to a mask.</span>
175
-
-<spanclass="package-name">[`@stdlib/stats/base/nanmin`][@stdlib/stats/base/nanmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a strided array, ignoring NaN values.</span>
176
-
-<spanclass="package-name">[`@stdlib/stats/base/nanmskmax`][@stdlib/stats/base/nanmskmax]</span><spanclass="delimiter">: </span><spanclass="description">calculate the maximum value of a strided array according to a mask, ignoring NaN values.</span>
177
-
-<spanclass="package-name">[`@stdlib/stats/base/snanmskmin`][@stdlib/stats/base/snanmskmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a single-precision floating-point strided array according to a mask, ignoring NaN values.</span>
169
+
- <spanclass="package-name">[`@stdlib/stats/base/dnanmskmin`][@stdlib/stats/base/dnanmskmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a double-precision floating-point strided array according to a mask, ignoring NaN values.</span>
170
+
- <spanclass="package-name">[`@stdlib/stats/base/mskmin`][@stdlib/stats/base/mskmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a strided array according to a mask.</span>
171
+
- <spanclass="package-name">[`@stdlib/stats/base/nanmin`][@stdlib/stats/base/nanmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a strided array, ignoring NaN values.</span>
172
+
- <spanclass="package-name">[`@stdlib/stats/base/nanmskmax`][@stdlib/stats/base/nanmskmax]</span><spanclass="delimiter">: </span><spanclass="description">calculate the maximum value of a strided array according to a mask, ignoring NaN values.</span>
173
+
- <spanclass="package-name">[`@stdlib/stats/base/snanmskmin`][@stdlib/stats/base/snanmskmin]</span><spanclass="delimiter">: </span><spanclass="description">calculate the minimum value of a single-precision floating-point strided array according to a mask, ignoring NaN values.</span>
0 commit comments