128 lines
3.0 KiB
Markdown
128 lines
3.0 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# incrmean
|
||
|
|
|
||
|
|
> Compute an [arithmetic mean][arithmetic-mean] incrementally.
|
||
|
|
|
||
|
|
<section class="intro">
|
||
|
|
|
||
|
|
The [arithmetic mean][arithmetic-mean] is defined as
|
||
|
|
|
||
|
|
<!-- <equation class="equation" label="eq:arithmetic_mean" align="center" raw="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" alt="Equation for the arithmetic mean."> -->
|
||
|
|
|
||
|
|
<div class="equation" align="center" data-raw-text="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:arithmetic_mean">
|
||
|
|
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@49d8cabda84033d55d7b8069f19ee3dd8b8d1496/lib/node_modules/@stdlib/stats/incr/mean/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </equation> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.intro -->
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var incrmean = require( '@stdlib/stats/incr/mean' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### incrmean()
|
||
|
|
|
||
|
|
Returns an accumulator `function` which incrementally computes an [arithmetic mean][arithmetic-mean].
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var accumulator = incrmean();
|
||
|
|
```
|
||
|
|
|
||
|
|
#### accumulator( \[x] )
|
||
|
|
|
||
|
|
If provided an input value `x`, the accumulator function returns an updated mean. If not provided an input value `x`, the accumulator function returns the current mean.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var accumulator = incrmean();
|
||
|
|
|
||
|
|
var mu = accumulator( 2.0 );
|
||
|
|
// returns 2.0
|
||
|
|
|
||
|
|
mu = accumulator( 1.0 );
|
||
|
|
// returns 1.5
|
||
|
|
|
||
|
|
mu = accumulator( 3.0 );
|
||
|
|
// returns 2.0
|
||
|
|
|
||
|
|
mu = accumulator();
|
||
|
|
// returns 2.0
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="notes">
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **all** future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.notes -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var randu = require( '@stdlib/random/base/randu' );
|
||
|
|
var incrmean = require( '@stdlib/stats/incr/mean' );
|
||
|
|
|
||
|
|
var accumulator;
|
||
|
|
var v;
|
||
|
|
var i;
|
||
|
|
|
||
|
|
// Initialize an accumulator:
|
||
|
|
accumulator = incrmean();
|
||
|
|
|
||
|
|
// For each simulated datum, update the mean...
|
||
|
|
for ( i = 0; i < 100; i++ ) {
|
||
|
|
v = randu() * 100.0;
|
||
|
|
accumulator( v );
|
||
|
|
}
|
||
|
|
console.log( accumulator() );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|