Skip to content

Commit 97af938

Browse files
committed
docs: fix signature and parameter order
--- 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: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 5c78c73 commit 97af938

File tree

1 file changed

+2
-2
lines changed
  • lib/node_modules/@stdlib/stats/strided/dvarmtk

1 file changed

+2
-2
lines changed

lib/node_modules/@stdlib/stats/strided/dvarmtk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@ var v = dvarmtk( x.length, 1, 1.0/3.0, x, 1 );
114114
The function has the following parameters:
115115

116116
- **N**: number of indexed elements.
117-
- **mean**: mean.
118117
- **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 `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).
118+
- **mean**: mean.
119119
- **x**: input [`Float64Array`][@stdlib/array/float64].
120120
- **strideX**: stride length for `x`.
121121

@@ -144,7 +144,7 @@ var v = dvarmtk( 4, 1, 1.25, x1, 2 );
144144
// returns 6.25
145145
```
146146

147-
#### dvarmtk.ndarray( N, mean, correction, x, strideX, offsetX )
147+
#### dvarmtk.ndarray( N, correction, mean, x, strideX, offsetX )
148148

149149
Computes the [variance][variance] of a double-precision floating-point strided array provided a known `mean` and using a one-pass textbook algorithm and alternative indexing semantics.
150150

0 commit comments

Comments
 (0)