Skip to content

Commit a8ea675

Browse files
authored
Apply suggestions from code review
Signed-off-by: Athan <[email protected]>
1 parent d43ad21 commit a8ea675

File tree

1 file changed

+3
-3
lines changed
  • lib/node_modules/@stdlib/stats/base/variancewd

1 file changed

+3
-3
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The function has the following parameters:
116116
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
117117
- **strideX**: stride length for `x`.
118118

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`,
120120

121121
```javascript
122122
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:
153153

154154
- **offset**: starting index for `x`.
155155

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
157157

158158
```javascript
159159
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 );
171171
## Notes
172172

173173
- 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]).
175174
- 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]).
176176
- 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.
177177

178178
</section>

0 commit comments

Comments
 (0)