@syncfusion/ej2-calculate 35.1.37

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

@@ -0,0 +1,125 @@
+import { IBasicFormula } from '../common/index';
+import { FormulaOwner } from './formula-owner';
+import { FormulaModuleBase } from './formula-module-base';
+/**
+ * Extended statistical summaries including ranked averages, modes, and specialized aggregates.
+ *
+ * Registered functions: SMALL, LARGE, MEDIAN, SLOPE, INTERCEPT, RSQ, GEOMEAN.
+ *
+ * @hidden
+ */
+export declare class StatisticalAdvancedFormulas extends FormulaModuleBase {
+    /** Formula definitions registered with {@link BasicFormulas}. */
+    formulas: IBasicFormula[];
+    /**
+     * @hidden
+     * @param {FormulaOwner} owner - Formula registration owner ({@link BasicFormulas}).
+     */
+    constructor(owner: FormulaOwner);
+    /**
+     * Returns the median of the given set of numbers.
+     *
+     * Excel: `MEDIAN(...)`.
+     *
+     * @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('=MEDIAN(1)');
+     * ```
+     */
+    ComputeMEDIAN(...args: string[]): string | number;
+    /**
+     * Returns the k-th smallest value in a given array.
+     *
+     * Excel: `SMALL(...)`.
+     *
+     * @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`.
+     */
+    ComputeSMALL(...args: string[]): string | number;
+    /**
+     * Returns the k-th largest value in a given array.
+     *
+     * Excel: `LARGE(...)`.
+     *
+     * @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`.
+     */
+    ComputeLARGE(...args: string[]): string | number;
+    /**
+     * Returns the slope of the line from linear regression of the data points.
+     *
+     * Excel: `SLOPE(...)`.
+     *
+     * @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`.
+     */
+    ComputeSLOPE(...args: string[]): string | number;
+    /**
+     * Calculates the point of the Y-intercept line via linear regression.
+     *
+     * Excel: `INTERCEPT(...)`.
+     *
+     * @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`.
+     */
+    ComputeINTERCEPT(...args: string[]): string | number;
+    /**
+     * Returns the geometric mean of an array or range of positive data.
+     *
+     * Excel: `GEOMEAN(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {boolean} - Boolean result, nested-formula numeric string (`"0"`/`"1"`), or an Excel error token.
+     */
+    ComputeGEOMEAN(...args: string[]): boolean | string;
+    /**
+     * Returns the square of the Pearson product moment correlation coefficient based on data points in known_ys and known_xs.
+     *
+     * Excel: `RSQ(...)`.
+     *
+     * @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`.
+     */
+    ComputeRSQ(...args: string[]): string | number;
+    /**
+     * @hidden
+     * @param {string[]} xValues - specify the x values
+     * @param {string[]} yValues - specify the y values
+     * @param {number} meanX - specify the mean of x values
+     * @param {number} meanY - specify the mean of y values
+     * @returns {number} - Returns correlation value
+     */
+    /**
+     * @hidden
+     * @param {string[]} xValues - specify the x values
+     * @param {string[]} yValues - specify the y values
+     * @param {number} meanX - specify the mean of x values
+     * @param {number} meanY - specify the mean of y values
+     * @returns {number} - Returns correlation value
+     */
+    private getCorrelation;
+    /**
+     * @hidden
+     * @param {string[]} xValues - specify the x values
+     * @param {string[]} yValues - specify the y values
+     * @returns {number[]} meanX - returns array of mean values of x and y values
+     */
+    /**
+     * @hidden
+     * @param {string[]} xValues - specify the x values
+     * @param {string[]} yValues - specify the y values
+     * @returns {number[]} meanX - returns array of mean values of x and y values
+     */
+    private getMeanArray;
+    private getDataCollection;
+}