wink-statistics
Version:
Fast and Numerically Stable Statistical Analysis Utilities
146 lines (133 loc) • 4.83 kB
JavaScript
// wink-statistics
// Fast and Numerically Stable Statistical Analysis Utilities.
//
// Copyright (C) GRAYPE Systems Private Limited
//
// This file is part of “wink-statistics”.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
var ws = Object.create( null );
/**
* Probability
* @namespace probability
*/
ws.probability = Object.create( null );
// 1. range4CI
ws.probability.range4CI = require( './probability-range-4ci.js' );
// 2. aggregate
ws.probability.aggregate = require( './probability-aggregate.js' );
/**
* Data
* @namespace data
*/
ws.data = Object.create( null );
// 1. boxplot
ws.data.boxplot = require( './data-boxplot.js' );
// 2. difference
ws.data.difference = require( './data-difference' );
// 3. fiveNumSummary
ws.data.fiveNumSummary = require( './data-five-num-summary.js' );
// 4. histogram
ws.data.histogram = require( './data-histogram.js' );
// 5. mad
ws.data.mad = require( './data-mad.js' );
// 6. max
ws.data.max = require( './data-max.js' );
// 7. mean
ws.data.mean = require( './data-mean.js' );
// 8. median
ws.data.median = require( './data-median.js' );
// 9. min
ws.data.min = require( './data-min.js' );
// 10. percentile
ws.data.percentile = require( './data-percentile.js' );
// 11. stdev
ws.data.stdev = require( './data-stdev.js' );
// Alias TODO
ws.stats = ws.data;
/**
* All members of streaming are higher order functions. Each function returns
* a {@link Stream}.
* @namespace streaming
*/
ws.streaming = Object.create( null );
// 1. cov
ws.streaming.cov = require( './streaming-cov.js' );
// 2. freqTable
ws.streaming.freqTable = require( './streaming-freq-table.js' );
// 3. max
ws.streaming.max = require( './streaming-max.js' );
// 4. mean
ws.streaming.mean = require( './streaming-mean.js' );
// 5. min
ws.streaming.min = require( './streaming-min.js' );
// 6. slr
ws.streaming.slr = require( './streaming-slr.js' );
ws.streaming.simpleLinearRegression = require( './streaming-slr.js' );
// 7. stdev
ws.streaming.stdev = require( './streaming-stdev.js' );
// 8. sum
ws.streaming.sum = require( './streaming-sum.js' );
// 9. summary
ws.streaming.summary = require( './streaming-summary.js' );
module.exports = ws;
/**
* @classdesc All functions under [`streaming`](https://winkjs.org/wink-statistics/streaming.html)
* namespace return an object of this class. These compute the required result(s) from the stream
* of data arriving in real time.
* @class Stream
* @hideconstructor
*/
/**
* Incrementally computes the results in real-time with each successive call.
*
* Number and type of input arguments depend on the API used.
*
* @method Stream#compute
*/
/**
* Probes the current value of primary result at any time.
*
* @method Stream#value
* @return {Number}
*/
/**
* Provides detailed result(s) from the computations carried out so far. The result(s)
* will vary as per the API used.
*
* It can be called, as and when required to return the accumulated result till that point.
*
* @method Stream#result
* @param {Number} [fractionDigits=4] number of decimals in the returned numerical values. May
* not apply in every case such as [`max()`](file:///Users/neilsbohr/dev/winkjs/wink-statistics/docs/streaming.html#.max)
* or [`min()`](file:///Users/neilsbohr/dev/winkjs/wink-statistics/docs/streaming.html#.min).
* @return {Object} Containing detailed results in form of name/value pairs.
*/
/**
* Alias for {@link Stream#compute}; currently applicable to
* [`freqTable()`](file:///Users/neilsbohr/dev/winkjs/wink-statistics/docs/streaming.html#.freqTable).
*
* @method Stream#build
*/
/**
* Resets all the computations carried out so far. Computations start afresh
* from this point again.
*
* @method Stream#reset
*/