56 lines
1.2 KiB
JavaScript
56 lines
1.2 KiB
JavaScript
|
/**
|
||
|
* @license Apache-2.0
|
||
|
*
|
||
|
* Copyright (c) 2019 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.
|
||
|
*/
|
||
|
|
||
|
'use strict';
|
||
|
|
||
|
/**
|
||
|
* Create an iterator which iteratively computes a cumulative arithmetic mean.
|
||
|
*
|
||
|
* @module @stdlib/stats/iter/cumean
|
||
|
*
|
||
|
* @example
|
||
|
* var runif = require( '@stdlib/random/iter/uniform' );
|
||
|
* var itercumean = require( '@stdlib/stats/iter/cumean' );
|
||
|
*
|
||
|
* var rand = runif( -10.0, 10.0, {
|
||
|
* 'iter': 100
|
||
|
* });
|
||
|
*
|
||
|
* var it = itercumean( rand );
|
||
|
*
|
||
|
* var v = it.next().value;
|
||
|
* // returns <number>
|
||
|
*
|
||
|
* v = it.next().value;
|
||
|
* // returns <number>
|
||
|
*
|
||
|
* v = it.next().value;
|
||
|
* // returns <number>
|
||
|
*
|
||
|
* // ...
|
||
|
*/
|
||
|
|
||
|
// MODULES //
|
||
|
|
||
|
var iterator = require( './main.js' );
|
||
|
|
||
|
|
||
|
// EXPORTS //
|
||
|
|
||
|
module.exports = iterator;
|