Skip to content

Commit 98d9c2b

Browse files
authored
docs: fix note
Signed-off-by: Athan <[email protected]>
1 parent b0ca387 commit 98d9c2b

File tree

1 file changed

+1
-1
lines changed
  • lib/node_modules/@stdlib/stats/array/nanstdevch

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/stats/array/nanstdevch/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ var v = nanstdevch( x, 0.0 );
134134
- If provided an empty array, the function returns `NaN`.
135135
- If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment and `N` corresponds to the number of non-`NaN` array elements), the function returns `NaN`.
136136
- The function supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
137-
- The underlying algorithm is a specialized case of Neely's two-pass algorithm. As the standard deviation is invariant with respect to changes in the location parameter, the underlying algorithm uses the first strided array element as a trial mean to shift subsequent data values and thus mitigate catastrophic cancellation. Accordingly, the algorithm's accuracy is best when data is **unordered** (i.e., the data is **not** sorted in either ascending or descending order such that the first value is an "extreme" value).
137+
- The underlying algorithm is a specialized case of Neely's two-pass algorithm. As the standard deviation is invariant with respect to changes in the location parameter, the underlying algorithm uses the first array element as a trial mean to shift subsequent data values and thus mitigate catastrophic cancellation. Accordingly, the algorithm's accuracy is best when data is **unordered** (i.e., the data is **not** sorted in either ascending or descending order such that the first value is an "extreme" value).
138138

139139
</section>
140140

0 commit comments

Comments
 (0)