Skip to content

Commit 4e60447

Browse files
committed
chore: clean-up
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 632314d commit 4e60447

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ var v = nanstdev( x );
112112
The function has the following parameters:
113113

114114
- **x**: input array.
115-
- **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `N` corresponds to the number of array elements and `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the unbiased sample [standard deviation][standard-deviation], setting this 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). Default: `1.0`.
115+
- **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `N` corresponds to the number of non-`NaN` array elements and `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the unbiased sample [standard deviation][standard-deviation], setting this 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). Default: `1.0`.
116116

117117
By default, the function computes the sample [standard deviation][standard-deviation]. To adjust the degrees of freedom when computing the [standard deviation][standard-deviation], provide a `correction` argument.
118118

@@ -132,7 +132,7 @@ var v = nanstdev( x, 0.0 );
132132
## Notes
133133

134134
- If provided an empty array, the function returns `NaN`.
135-
- If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment), the function returns `NaN`.
135+
- 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]).
137137

138138
</section>

lib/node_modules/@stdlib/stats/array/nanstdev/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@
1313
Degrees of freedom adjustment. Setting this parameter to a value other
1414
than `0` has the effect of adjusting the divisor during the calculation
1515
of the standard deviation according to `N-c` where `N` corresponds to
16-
the number of array elements and `c` corresponds to the provided
16+
the number of non-NaN array elements and `c` corresponds to the provided
1717
degrees of freedom adjustment. When computing the standard deviation of
1818
a population, setting this parameter to `0` is the standard choice
1919
(i.e., the provided array contains data constituting an entire
2020
population). When computing the unbiased sample standard deviation,
2121
setting this parameter to `1` is the standard choice (i.e., the
2222
provided array contains data sampled from a larger population; this is
23-
commonly referred to as Bessel's correction). Default: `1.0`.
23+
commonly referred to as Bessel's correction). Default: 1.0.
2424

2525
Returns
2626
-------

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ 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` array 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
38-
* @param correction - degrees of freedom adjustment
38+
* @param correction - degrees of freedom adjustment (default: 1.0)
3939
* @returns standard deviation
4040
*
4141
* @example

lib/node_modules/@stdlib/stats/array/nanstdev/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ var GENERIC_DTYPE = 'generic';
4545
* @param {number} [correction=1.0] - degrees of freedom adjustment
4646
* @throws {TypeError} first argument must have a supported data type
4747
* @throws {TypeError} first argument must be an array-like object
48-
* @throws {TypeError} second argument must be an number
48+
* @throws {TypeError} second argument must be a number
4949
* @returns {number} standard deviation
5050
*
5151
* @example

lib/node_modules/@stdlib/stats/array/nanstdev/test/test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ tape( 'if provided an array containing a single element, the function returns `0
320320
t.end();
321321
});
322322

323-
tape( 'if provided a `correction` parameter which is greater than or equal to the input array length, the function returns `NaN`', function test( t ) {
323+
tape( 'if provided a `correction` parameter yielding a correction term less than or equal to `0`, the function returns `NaN`', function test( t ) {
324324
var x;
325325
var v;
326326

@@ -335,7 +335,7 @@ tape( 'if provided a `correction` parameter which is greater than or equal to th
335335
t.end();
336336
});
337337

338-
tape( 'if provided a `correction` parameter which is greater than or equal to the input array length, the function returns `NaN` (accessors)', function test( t ) {
338+
tape( 'if provided a `correction` parameter yielding a correction term less than or equal to `0`, the function returns `NaN` (accessors)', function test( t ) {
339339
var x;
340340
var v;
341341

0 commit comments

Comments
 (0)