Skip to content

Commit ce0f12a

Browse files
authored
docs: update description
Signed-off-by: Athan <[email protected]>
1 parent b495105 commit ce0f12a

File tree

1 file changed

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

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/stats/array/nanstdevch/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
3232
*
3333
* ## Notes
3434
*
35-
* - Setting the correction parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the standard deviation according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the standard deviation of a population, setting the correction parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample standard deviation, setting the correction parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction).
35+
* - Setting the correction parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the standard deviation according to `N-c` where `N` corresponds to the number of non-`NaN` elements and `c` corresponds to the provided degrees of freedom adjustment. When computing the standard deviation of a population, setting the correction parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample standard deviation, setting the correction parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction).
3636
*
3737
* @param x - input array
3838
* @param correction - degrees of freedom adjustment (default: 1.0)

0 commit comments

Comments
 (0)