time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (2878B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
     24 var incrmsum = require( './../../../incr/msum' );
     25 var incrmmean = require( './../../../incr/mmean' );
     26 var incrmvariance = require( './../../../incr/mvariance' );
     27 var incrmstdev = require( './../../../incr/mstdev' );
     28 var incrmmin = require( './../../../incr/mmin' );
     29 var incrmmax = require( './../../../incr/mmax' );
     30 var incrmrange = require( './../../../incr/mrange' );
     31 var incrmmidrange = require( './../../../incr/mmidrange' );
     32 
     33 
     34 // MAIN //
     35 
     36 /**
     37 * Returns an accumulator function which incrementally computes a moving statistical summary.
     38 *
     39 * @param {PositiveInteger} W - window size
     40 * @throws {TypeError} must provide a positive integer
     41 * @returns {Function} accumulator function
     42 *
     43 * @example
     44 * var accumulator = incrmsummary( 3 );
     45 *
     46 * var summary = accumulator();
     47 * // returns {}
     48 *
     49 * summary = accumulator( 2.0 );
     50 * // returns {...}
     51 *
     52 * summary = accumulator( -5.0 );
     53 * // returns {...}
     54 *
     55 * summary = accumulator();
     56 * // returns {...}
     57 */
     58 function incrmsummary( W ) {
     59 	var mvariance;
     60 	var mmidrange;
     61 	var summary;
     62 	var mrange;
     63 	var mstdev;
     64 	var mmean;
     65 	var msum;
     66 	var mmax;
     67 	var mmin;
     68 	if ( !isPositiveInteger( W ) ) {
     69 		throw new TypeError( 'invalid argument. Must provide a positive integer. Value: `' + W + '`.' );
     70 	}
     71 	mvariance = incrmvariance( W );
     72 	mmidrange = incrmmidrange( W );
     73 	mrange = incrmrange( W );
     74 	mstdev = incrmstdev( W );
     75 	mmean = incrmmean( W );
     76 	msum = incrmsum( W );
     77 	mmin = incrmmin( W );
     78 	mmax = incrmmax( W );
     79 	summary = {};
     80 
     81 	return accumulator;
     82 
     83 	/**
     84 	* If provided a value, the accumulator function returns an updated summary. If not provided a value, the accumulator function returns the current summary.
     85 	*
     86 	* @private
     87 	* @param {number} [x] - new value
     88 	* @returns {Object} summary
     89 	*/
     90 	function accumulator( x ) {
     91 		if ( arguments.length === 0 ) {
     92 			return summary;
     93 		}
     94 		summary.window = W;
     95 		summary.sum = msum( x );
     96 		summary.mean = mmean( x );
     97 		summary.variance = mvariance( x );
     98 		summary.stdev = mstdev( x );
     99 		summary.min = mmin( x );
    100 		summary.max = mmax( x );
    101 		summary.range = mrange( x );
    102 		summary.midrange = mmidrange( x );
    103 		return summary;
    104 	}
    105 }
    106 
    107 
    108 // EXPORTS //
    109 
    110 module.exports = incrmsummary;