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/variancewd/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ The function has the following parameters:
116
116
-**x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
117
117
-**strideX**: stride length for `x`.
118
118
119
-
The `N` and strideX parameters determine which elements in the strided array are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
119
+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [variance][variance] of every other element in `x`,
120
120
121
121
```javascript
122
122
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
@@ -153,7 +153,7 @@ The function has the following additional parameters:
153
153
154
154
-**offset**: starting index for `x`.
155
155
156
-
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 [variance][variance] for every other element in the strided array starting from the second element
156
+
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 [variance][variance] for every other element in the strided array starting from the second element
157
157
158
158
```javascript
159
159
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
@@ -171,8 +171,8 @@ var v = variancewd.ndarray( 4, 1, x, 2, 1 );
171
171
## Notes
172
172
173
173
- If `N <= 0`, both functions return `NaN`.
174
-
- 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]).
175
174
- If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment), both functions return `NaN`.
175
+
- 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]).
176
176
- Depending on the environment, the typed versions ([`dvariancewd`][@stdlib/stats/base/dvariancewd], [`svariancewd`][@stdlib/stats/base/svariancewd], etc.) are likely to be significantly more performant.
0 commit comments