Skip to content

Commit 5d6b241

Browse files
committed
docs: update notes and copy
--- 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: na - 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 c08c615 commit 5d6b241

File tree

24 files changed

+49
-49
lines changed

24 files changed

+49
-49
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ var v = nanvariance( 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 [variance][variance] 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 [variance][variance] 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 [variance][variance], 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 [variance][variance] 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 [variance][variance] 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 [variance][variance], 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 [variance][variance]. To adjust the degrees of freedom when computing the [variance][variance], provide a `correction` argument.
118118

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

134134
- If provided an empty array, the function returns `NaN`.
135-
- If provided a `correction` argument which is greater than or equal to the number of elements in a provided input 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 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/nanvariance/docs/repl.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
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 variance according to `N - c` where `N` corresponds to the number
16-
of array elements and `c` corresponds to the provided degrees of freedom
17-
adjustment. When computing the variance of a population, setting this
18-
parameter to `0` is the standard choice (i.e., the provided array
16+
of non-NaN array elements and `c` corresponds to the provided degrees of
17+
freedom adjustment. When computing the variance of a population, setting
18+
this parameter to `0` is the standard choice (i.e., the provided array
1919
contains data constituting an entire population). When computing the
2020
unbiased sample variance, setting this parameter to `1` is the standard
2121
choice (i.e., the provided array contains data sampled from a larger

lib/node_modules/@stdlib/stats/array/nanvariance/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 variance according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the variance 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 variance, 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 variance 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 variance 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 variance, 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)

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

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

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

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

337-
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 ) {
337+
tape( 'if provided a `correction` parameter yielding a correction term less than or equal to `0`, the function returns `NaN` (accessors)', function test( t ) {
338338
var x;
339339
var v;
340340

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ var v = nanvariancech( 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 [variance][variance] 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 [variance][variance] 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 [variance][variance], 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 [variance][variance] 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 [variance][variance] 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 [variance][variance], 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 [variance][variance]. To adjust the degrees of freedom when computing the [variance][variance], provide a `correction` argument.
118118

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

134134
- If provided an empty array, the function returns `NaN`.
135-
- If provided a `correction` argument which is greater than or equal to the number of elements in a provided input array, the function returns `NaN`.
136-
- The underlying algorithm is a specialized case of Neely's two-pass algorithm. As the variance is invariant with respect to changes in the location parameter, the underlying algorithm uses the first non-`NaN` 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).
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`.
136+
- The underlying algorithm is a specialized case of Neely's two-pass algorithm. As the variance is invariant with respect to changes in the location parameter, the underlying algorithm uses the first non-`NaN` 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).
137137
- 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]).
138138

139139
</section>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
Degrees of freedom adjustment. Setting this parameter to a value other
1515
than `0` has the effect of adjusting the divisor during the calculation
1616
of the variance according to `N - c` where `N` corresponds to the number
17-
of array elements and `c` corresponds to the provided degrees of freedom
18-
adjustment. When computing the variance of a population, setting this
19-
parameter to `0` is the standard choice (i.e., the provided array
17+
of non-NaN array elements and `c` corresponds to the provided degrees of
18+
freedom adjustment. When computing the variance of a population, setting
19+
this parameter to `0` is the standard choice (i.e., the provided array
2020
contains data constituting an entire population). When computing the
2121
unbiased sample variance, setting this parameter to `1` is the standard
2222
choice (i.e., the provided array contains data sampled from a larger

lib/node_modules/@stdlib/stats/array/nanvariancech/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 variance according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the variance 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 variance, 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 variance 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 variance 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 variance, 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)

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

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

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

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

337-
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 ) {
337+
tape( 'if provided a `correction` parameter yielding a correction term less than or equal to `0`, the function returns `NaN`, the function returns `NaN` (accessors)', function test( t ) {
338338
var x;
339339
var v;
340340

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ var v = nanvariancepn( 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 [variance][variance] 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 [variance][variance] 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 [variance][variance], 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 [variance][variance] 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 [variance][variance] 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 [variance][variance], 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 [variance][variance]. To adjust the degrees of freedom when computing the [variance][variance], provide a `correction` argument.
118118

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

134134
- If provided an empty array, the function returns `NaN`.
135-
- If provided a `correction` argument which is greater than or equal to the number of elements in a provided input 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 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/nanvariancepn/docs/repl.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
Degrees of freedom adjustment. Setting this parameter to a value other
1515
than `0` has the effect of adjusting the divisor during the calculation
1616
of the variance according to `N - c` where `N` corresponds to the number
17-
of array elements and `c` corresponds to the provided degrees of freedom
18-
adjustment. When computing the variance of a population, setting this
19-
parameter to `0` is the standard choice (i.e., the provided array
17+
of non-NaN array elements and `c` corresponds to the provided degrees of
18+
freedom adjustment. When computing the variance of a population, setting
19+
this parameter to `0` is the standard choice (i.e., the provided array
2020
contains data constituting an entire population). When computing the
2121
unbiased sample variance, setting this parameter to `1` is the standard
2222
choice (i.e., the provided array contains data sampled from a larger

0 commit comments

Comments
 (0)