Skip to content

Commit b73c3c7

Browse files
committed
feat: add the docs
--- 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: na - 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: 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 0cccb8c commit b73c3c7

File tree

2 files changed

+369
-0
lines changed

2 files changed

+369
-0
lines changed
Lines changed: 325 additions & 0 deletions
Loading
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
{{alias}}( [mean] )
3+
Returns an accumulator function which incrementally computes a weighted
4+
standard deviation.
5+
6+
If provided arguments, the accumulator function returns an updated weighted
7+
standard deviation. If not provided arguments, the accumulator function
8+
returns the current weighted standard deviation.
9+
10+
If provided `NaN` or a value which, when used in computations, results in
11+
`NaN`, the accumulated value is `NaN` for all future invocations.
12+
13+
The accumulator function accepts two arguments:
14+
15+
- x: value.
16+
- w: weight.
17+
18+
Parameters
19+
----------
20+
mean: number (optional)
21+
Known mean.
22+
23+
Returns
24+
-------
25+
acc: Function
26+
Accumulator function.
27+
28+
Examples
29+
--------
30+
> var accumulator = {{alias}}();
31+
> var mu = accumulator()
32+
null
33+
> mu = accumulator( 2.0, 1.0 )
34+
0.0
35+
> mu = accumulator( 3.0, 2.0 )
36+
~0.471
37+
> mu = accumulator( 2.0, 0.1 )
38+
~0.478
39+
> mu = accumulator()
40+
~0.478
41+
42+
See Also
43+
--------
44+

0 commit comments

Comments
 (0)