statistical-js/src/statistical.js

Simple to use, completely useful

'use strict';

import hook from './utils/hook';
import cacheManager from './utils/cacheManager';
import Validator from './utils/validator';
import StatisticalMethod from './methods/StatisticalMethod';
import Perceptron from './machineLearning/Perceptron';

class Statistical {
    /**
     * Create a new object that provide all method and configuration of the library.
     */
    constructor() {
        this._validator = new Validator();
        this._settings = {
            cache: {
                enabled: true,
                rootElementCount: 10,
                subElementCount: 30
            }
        };
    }

    /**
     * Return settings used in statistical class.
     *
     * @returns {*}
     */
    get settings() {
        return this._settings;
    }

    /**
     * Allow to updates statistical settings.
     *
     * @param {object} options
     * @param {object} options.cache - options about the cache
     * @param {boolean} options.cache.enabled - enabled or disabled the cache
     * @param {number} options.cache.rootElementCount - number of called method cached
     * @param {number} options.cache.subElementCount - number of result for each called method cached
     */
    set settings(options) {
        this._settings = {
            cache: {
                enabled: options.cache.enabled,
                rootElementCount: options.cache.rootElementCount || this._settings.cache.rootElementCount,
                subElementCount: options.cache.subElementCount || this._settings.cache.subElementCount
            }
        };
        cacheManager.settings = this._settings.cache;
    }

    /**
     * Basics plus advanced statistics are provided in this member.
     *
     * @returns {*}
     */
    get methods() {
        return hook.cache(new StatisticalMethod(), cacheManager);
    }

    /**
     * Predictive model are provided in this member.
     *
     * @returns {{Perceptron: Perceptron}}
     */
    get ml() {
        return {
            Perceptron: Perceptron
        };
    }
}

const statistical = new Statistical();
export default statistical;