@syncfusion/ej2-calculate 35.1.37

package/src/formulas/statistical-correlation.d.ts

@@ -0,0 +1,75 @@
+import { IBasicFormula } from '../common/index';
+import { FormulaOwner } from './formula-owner';
+import { StatisticalSampleBase } from './statistical-sample-base';
+/**
+ * Covariance, correlation, and regression slope/intercept between paired data sets.
+ *
+ * Registered functions: CORREL, COVAR, PEARSON, FORECAST, STEYX.
+ *
+ * @hidden
+ */
+export declare class StatisticalCorrelationFormulas extends StatisticalSampleBase {
+    /** Formula definitions registered with {@link BasicFormulas}. */
+    formulas: IBasicFormula[];
+    /**
+     * @hidden
+     * @param {FormulaOwner} owner - Formula registration owner ({@link BasicFormulas}).
+     */
+    constructor(owner: FormulaOwner);
+    private regressionStats;
+    /**
+     * Returns the correlation coefficient between two data sets.
+     *
+     * Excel: `CORREL(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     *
+     * @example
+     * ```ts
+     * engine.computeFormula('=CORREL(1)');
+     * ```
+     */
+    ComputeCORREL(...args: string[]): string | number;
+    /**
+     * Returns the Pearson product moment correlation coefficient.
+     *
+     * Excel: `PEARSON(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputePEARSON(...args: string[]): string | number;
+    /**
+     * Returns covariance, the average of the products of paired deviations.
+     *
+     * Excel: `COVAR(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeCOVAR(...args: string[]): string | number;
+    /**
+     * Returns a value along a linear trend.
+     *
+     * Excel: `FORECAST(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeFORECAST(...args: string[]): string | number;
+    /**
+     * Returns the standard error of the predicted y-value for each x in the regression.
+     *
+     * Excel: `STEYX(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeSTEYX(...args: string[]): string | number;
+}

package/src/formulas/statistical-correlation.js

@@ -0,0 +1,198 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+import { FormulasErrorsStrings, CommonErrors } from '../common/index';
+import { isNullOrUndefined } from '@syncfusion/ej2-base';
+import { StatisticalSampleBase } from './statistical-sample-base';
+/**
+ * Covariance, correlation, and regression slope/intercept between paired data sets.
+ *
+ * Registered functions: CORREL, COVAR, PEARSON, FORECAST, STEYX.
+ *
+ * @hidden
+ */
+var StatisticalCorrelationFormulas = /** @class */ (function (_super) {
+    __extends(StatisticalCorrelationFormulas, _super);
+    /**
+     * @hidden
+     * @param {FormulaOwner} owner - Formula registration owner ({@link BasicFormulas}).
+     */
+    function StatisticalCorrelationFormulas(owner) {
+        var _this = _super.call(this, owner) || this;
+        /** Formula definitions registered with {@link BasicFormulas}. */
+        _this.formulas = [
+            { formulaName: 'CORREL', category: 'Statistical', description: 'Returns the correlation coefficient between two data sets.' },
+            { formulaName: 'COVAR', category: 'Statistical', description: 'Returns covariance, the average of the products of paired deviations.' },
+            { formulaName: 'PEARSON', category: 'Statistical', description: 'Returns the Pearson product moment correlation coefficient.' },
+            { formulaName: 'FORECAST', category: 'Statistical', description: 'Returns a value along a linear trend.' },
+            { formulaName: 'STEYX', category: 'Statistical', description: 'Returns the standard error of the predicted y-value for each x in the regression.' }
+        ];
+        return _this;
+    }
+    StatisticalCorrelationFormulas.prototype.regressionStats = function (args) {
+        var errCollection = this.parent.getErrorStrings();
+        if (isNullOrUndefined(args) || args.length !== 2) {
+            return this.parent.formulaErrorStrings[FormulasErrorsStrings.WrongNumberArguments];
+        }
+        var pair = this.collectPair(args);
+        if (typeof pair === 'string') {
+            return pair;
+        }
+        var x = pair.x, y = pair.y;
+        if (x.length < 2) {
+            return errCollection[CommonErrors.DivZero];
+        }
+        var meanX = this.mean(x);
+        var meanY = this.mean(y);
+        var sxx = 0;
+        var syy = 0;
+        var sxy = 0;
+        for (var i = 0; i < x.length; i++) {
+            var dx = x[i] - meanX;
+            var dy = y[i] - meanY;
+            sxx += dx * dx;
+            syy += dy * dy;
+            sxy += dx * dy;
+        }
+        return { n: x.length, meanX: meanX, meanY: meanY, sxx: sxx, syy: syy, sxy: sxy };
+    };
+    /**
+     * Returns the correlation coefficient between two data sets.
+     *
+     * Excel: `CORREL(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     *
+     * @example
+     * ```ts
+     * engine.computeFormula('=CORREL(1)');
+     * ```
+     */
+    StatisticalCorrelationFormulas.prototype.ComputeCORREL = function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        var errCollection = this.parent.getErrorStrings();
+        var stats = this.regressionStats(args);
+        if (typeof stats === 'string') {
+            return stats;
+        }
+        if (stats.sxx === 0 || stats.syy === 0) {
+            return errCollection[CommonErrors.DivZero];
+        }
+        return (stats.sxy / Math.sqrt(stats.sxx * stats.syy)).toString();
+    };
+    /**
+     * Returns the Pearson product moment correlation coefficient.
+     *
+     * Excel: `PEARSON(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    StatisticalCorrelationFormulas.prototype.ComputePEARSON = function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        return this.ComputeCORREL.apply(this, args);
+    };
+    /**
+     * Returns covariance, the average of the products of paired deviations.
+     *
+     * Excel: `COVAR(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    StatisticalCorrelationFormulas.prototype.ComputeCOVAR = function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        var errCollection = this.parent.getErrorStrings();
+        var stats = this.regressionStats(args);
+        if (typeof stats === 'string') {
+            return stats;
+        }
+        if (stats.n < 2) {
+            return errCollection[CommonErrors.DivZero];
+        }
+        return (stats.sxy / (stats.n - 1)).toString();
+    };
+    /**
+     * Returns a value along a linear trend.
+     *
+     * Excel: `FORECAST(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    StatisticalCorrelationFormulas.prototype.ComputeFORECAST = function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        var errCollection = this.parent.getErrorStrings();
+        if (isNullOrUndefined(args) || args.length !== 3) {
+            return this.parent.formulaErrorStrings[FormulasErrorsStrings.WrongNumberArguments];
+        }
+        var xVal = this.resolveNumberArg(args[0]);
+        if (typeof xVal === 'string') {
+            return xVal;
+        }
+        var stats = this.regressionStats([args[2], args[1]]);
+        if (typeof stats === 'string') {
+            return stats;
+        }
+        if (stats.sxx === 0) {
+            return errCollection[CommonErrors.DivZero];
+        }
+        var slope = stats.sxy / stats.sxx;
+        var intercept = stats.meanY - slope * stats.meanX;
+        return (intercept + slope * xVal).toString();
+    };
+    /**
+     * Returns the standard error of the predicted y-value for each x in the regression.
+     *
+     * Excel: `STEYX(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    StatisticalCorrelationFormulas.prototype.ComputeSTEYX = function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        var errCollection = this.parent.getErrorStrings();
+        var stats = this.regressionStats([args[1], args[0]]);
+        if (typeof stats === 'string') {
+            return stats;
+        }
+        if (stats.n <= 2 || stats.sxx === 0) {
+            return errCollection[CommonErrors.DivZero];
+        }
+        var ssRes = stats.syy - (stats.sxy * stats.sxy) / stats.sxx;
+        return Math.sqrt(ssRes / (stats.n - 2)).toString();
+    };
+    return StatisticalCorrelationFormulas;
+}(StatisticalSampleBase));
+export { StatisticalCorrelationFormulas };

package/src/formulas/statistical-dispersion.d.ts

@@ -0,0 +1,108 @@
+import { IBasicFormula } from '../common/index';
+import { FormulaOwner } from './formula-owner';
+import { FormulaModuleBase } from './formula-module-base';
+/**
+ * Variability measures: variance, standard deviation, and average deviation for samples and populations.
+ *
+ * Registered functions: STDEV, STDEVP, VAR, VARP, MODE, RANK, MAXA, MINA.
+ *
+ * @hidden
+ */
+export declare class StatisticalDispersionFormulas extends FormulaModuleBase {
+    /** Formula definitions registered with {@link BasicFormulas}. */
+    formulas: IBasicFormula[];
+    /**
+     * @hidden
+     * @param {FormulaOwner} owner - Formula registration owner ({@link BasicFormulas}).
+     */
+    constructor(owner: FormulaOwner);
+    private collectSample;
+    private variance;
+    /**
+     * Estimates standard deviation based on a sample.
+     *
+     * Excel: `STDEV(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     *
+     * @example
+     * ```ts
+     * engine.computeFormula('=STDEV(1)');
+     * ```
+     */
+    ComputeSTDEV(...args: string[]): string | number;
+    /**
+     * Calculates standard deviation based on the entire population.
+     *
+     * Excel: `STDEVP(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeSTDEVP(...args: string[]): string | number;
+    /**
+     * Estimates variance based on a sample.
+     *
+     * Excel: `VAR(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeVAR(...args: string[]): string | number;
+    /**
+     * Calculates variance based on the entire population.
+     *
+     * Excel: `VARP(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeVARP(...args: string[]): string | number;
+    private stdevVar;
+    /**
+     * Returns the most common value in a data set.
+     *
+     * Excel: `MODE(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeMODE(...args: string[]): string | number;
+    /**
+     * Returns the rank of a number in a list of numbers.
+     *
+     * Excel: `RANK(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeRANK(...args: string[]): string | number;
+    /**
+     * Returns the maximum value in a list of arguments, including text and logicals.
+     *
+     * Excel: `MAXA(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeMAXA(...args: string[]): string | number;
+    /**
+     * Returns the minimum value in a list of arguments, including text and logicals.
+     *
+     * Excel: `MINA(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeMINA(...args: string[]): string | number;
+    private minMaxA;
+}