58 lines
1.3 KiB
JavaScript
58 lines
1.3 KiB
JavaScript
|
/**
|
||
|
|
* @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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Compute an arithmetic mean and corrected sample standard deviation incrementally.
|
||
|
|
*
|
||
|
|
* @module @stdlib/stats/incr/meanstdev
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var incrmeanstdev = require( '@stdlib/stats/incr/meanstdev' );
|
||
|
|
*
|
||
|
|
* var accumulator = incrmeanstdev();
|
||
|
|
*
|
||
|
|
* var ms = accumulator();
|
||
|
|
* // returns null
|
||
|
|
*
|
||
|
|
* ms = accumulator( 2.0 );
|
||
|
|
* // returns [ 2.0, 0.0 ]
|
||
|
|
*
|
||
|
|
* ms = accumulator( -5.0 );
|
||
|
|
* // returns [ -1.5, ~4.95 ]
|
||
|
|
*
|
||
|
|
* ms = accumulator( 3.0 );
|
||
|
|
* // returns [ 0.0, ~4.36 ]
|
||
|
|
*
|
||
|
|
* ms = accumulator( 5.0 );
|
||
|
|
* // returns [ 1.25, ~4.35 ]
|
||
|
|
*
|
||
|
|
* ms = accumulator();
|
||
|
|
* // returns [ 1.25, ~4.35 ]
|
||
|
|
*/
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var incrmeanstdev = require( './main.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = incrmeanstdev;
|