@ic3/reporting-api 8.0.0-alpha.6 → 8.0.0-rc.3

package/dist/PublicTidyColumn.js

@@ -1,16 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TidyTableNumberExprColumnMetas = exports.TidyTableTextExprColumnMetas = exports.ITidyColumnNamedProperties = void 0;
+exports.TidyTableNumberExprColumnMetas = exports.TidyTableTextExprColumnMetas = exports.CharacterTidyColumnProperties = exports.ITidyColumnNamedProperties = void 0;
 /**
  * Properties with a special meaning
  */
 var ITidyColumnNamedProperties;
 (function (ITidyColumnNamedProperties) {
+    /**
+     * The formatted value of a cell. For example, 5003 in euros is formatted as €5,003
+     */
     ITidyColumnNamedProperties["mdxCellFormattedValue"] = "formattedValue";
+    /**
+     * MDX related colorings
+     */
     ITidyColumnNamedProperties["mdxCellBackColor"] = "mdxCellBackColor";
+    /**
+     * MDX related colorings
+     */
     ITidyColumnNamedProperties["mdxCellForeColor"] = "mdxCellForeColor";
+    /**
+     * The format string for the cell value. For example, euros are formatted using €#,###.
+     * and percentages using #0.00%.
+     */
     ITidyColumnNamedProperties["mdxCellFormatString"] = "mdxCellFormatString";
+    /**
+     * The main color of the cell
+     */
     ITidyColumnNamedProperties["mdxCellColor"] = "color";
+    /**
+     * Column defined to fire an app. notification.
+     *
+     * The name of the notification (e.g., print-report).
+     */
+    ITidyColumnNamedProperties["appNotificationType"] = "appNotificationType";
+    /**
+     * Column defined to fire an app. notification.
+     *
+     * The parameters of the notification (e.g., page size, filename, ...) as a JSON or a string.
+     */
+    ITidyColumnNamedProperties["appNotificationPayload"] = "appNotificationPayload";
     /**
      * Column defined to fire events, the name of the event
      */
@@ -34,15 +62,30 @@ var ITidyColumnNamedProperties;
     /**
      * Column defined as an MDX axis, the key of the column
      */
-    ITidyColumnNamedProperties["key"] = "key";
+    ITidyColumnNamedProperties["mdxCellKey"] = "key";
+    /**
+     * Show this when hovering over the cell (or the visualisation representing the cell)
+     */
     ITidyColumnNamedProperties["tooltip"] = "tooltip";
 })(ITidyColumnNamedProperties = exports.ITidyColumnNamedProperties || (exports.ITidyColumnNamedProperties = {}));
+exports.CharacterTidyColumnProperties = new Set([
+    ITidyColumnNamedProperties.mdxCellFormattedValue,
+    ITidyColumnNamedProperties.uniqueName,
+    ITidyColumnNamedProperties.mdxCellFormatString,
+    ITidyColumnNamedProperties.appNotificationType,
+    ITidyColumnNamedProperties.eventName,
+    ITidyColumnNamedProperties.caption,
+    ITidyColumnNamedProperties.tooltip,
+]);
 exports.TidyTableTextExprColumnMetas = [
     { caption: "total", method: "sum" },
     { caption: "average", method: "mean" },
     { caption: "median", method: "median" },
     { caption: "min", method: "min" },
     { caption: "max", method: "max" },
+    { caption: "variance", method: "variance" },
+    { caption: "standardDeviation", method: "standardDeviation" },
+    { caption: "count", method: "count" },
     { caption: "percent", method: "percent", argRow: true },
     { caption: "caption", method: "getCaption" },
 ];
@@ -52,6 +95,9 @@ exports.TidyTableNumberExprColumnMetas = [
     { caption: "median", method: "median" },
     { caption: "min", method: "min" },
     { caption: "max", method: "max" },
+    { caption: "variance", method: "variance" },
+    { caption: "standardDeviation", method: "standardDeviation" },
+    { caption: "count", method: "count" },
     { caption: "percent", method: "percent", argRow: true },
     // {caption: "caption", method: "getCaption"},
 ];

package/dist/PublicTidyColumn.js.map

@@ -1 +1 @@
-{"version":3,"file":"PublicTidyColumn.js","sourceRoot":"","sources":["../src/PublicTidyColumn.ts"],"names":[],"mappings":";;;AAgBA;;GAEG;AACH,IAAY,0BAuCX;AAvCD,WAAY,0BAA0B;IAElC,sEAAwC,CAAA;IACxC,mEAAqC,CAAA;IACrC,mEAAqC,CAAA;IACrC,yEAA2C,CAAA;IAC3C,oDAAsB,CAAA;IAEtB;;OAEG;IACH,qDAAuB,CAAA;IAEvB;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,6DAA+B,CAAA;IAE/B;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,iDAAmB,CAAA;IAEnB;;OAEG;IACH,yCAAW,CAAA;IAEX,iDAAmB,CAAA;AACvB,CAAC,EAvCW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAuCrC;AAglBY,QAAA,4BAA4B,GAA8B;IAEnE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAE/B,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAC;CAE7C,CAAC;AAEW,QAAA,8BAA8B,GAA8B;IAErE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAE/B,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,8CAA8C;CAEjD,CAAC"}
+{"version":3,"file":"PublicTidyColumn.js","sourceRoot":"","sources":["../src/PublicTidyColumn.ts"],"names":[],"mappings":";;;AA6CA;;GAEG;AACH,IAAY,0BA4EX;AA5ED,WAAY,0BAA0B;IAElC;;OAEG;IACH,sEAAwC,CAAA;IAExC;;OAEG;IACH,mEAAqC,CAAA;IAErC;;OAEG;IACH,mEAAqC,CAAA;IAErC;;;OAGG;IACH,yEAA2C,CAAA;IAE3C;;OAEG;IACH,oDAAsB,CAAA;IAEtB;;;;OAIG;IACH,yEAA2C,CAAA;IAE3C;;;;OAIG;IACH,+EAAiD,CAAA;IAEjD;;OAEG;IACH,qDAAuB,CAAA;IAEvB;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,6DAA+B,CAAA;IAE/B;;OAEG;IACH,uDAAyB,CAAA;IAEzB;;OAEG;IACH,iDAAmB,CAAA;IAEnB;;OAEG;IACH,gDAAkB,CAAA;IAElB;;OAEG;IACH,iDAAmB,CAAA;AACvB,CAAC,EA5EW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QA4ErC;AAEY,QAAA,6BAA6B,GAAG,IAAI,GAAG,CAAS;IAEzD,0BAA0B,CAAC,qBAAqB;IAChD,0BAA0B,CAAC,UAAU;IAErC,0BAA0B,CAAC,mBAAmB;IAE9C,0BAA0B,CAAC,mBAAmB;IAC9C,0BAA0B,CAAC,SAAS;IAEpC,0BAA0B,CAAC,OAAO;IAClC,0BAA0B,CAAC,OAAO;CAErC,CAAC,CAAC;AA4mBU,QAAA,4BAA4B,GAA8B;IAEnE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAC;IACzC,EAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAC;IAC3D,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAC;IAEnC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAC;CAE7C,CAAC;AAEW,QAAA,8BAA8B,GAA8B;IAErE,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAC;IACjC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAC;IACpC,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC;IACrC,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;IAC/B,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAC;IACzC,EAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAC;IAC3D,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAC;IAEnC,EAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAC;IAErD,8CAA8C;CAEjD,CAAC"}

package/dist/PublicTidyHistogram.d.ts

@@ -0,0 +1,24 @@
+import { SortingType } from "./PublicTidyTableTypes";
+import { FormFieldObject, FormFields } from "./PublicTemplateForm";
+export declare enum TidyHistogramBucketFormat {
+    INTERVAL = "interval",
+    MATH_INTERVAL = "mathInterval",
+    MATH_INTERVAL_REVERSED = "mathIntervalReversed",
+    FROM_ONLY = "fromOnly",
+    TO_ONLY = "toOnly"
+}
+export declare enum TidyHistogramBucketType {
+    LEFT_CLOSED = "leftClosed",
+    RIGHT_CLOSED = "rightClosed"
+}
+export interface TidyHistogramOptions extends FormFieldObject {
+    binType: "automatic" | "userDefined";
+    numberOfBins: number;
+    customBins: string;
+    sortBins: SortingType;
+    bucketFormat: TidyHistogramBucketFormat;
+    intervalType: TidyHistogramBucketType;
+}
+export declare const TidyHistogramMetaOptions: (group?: string | undefined, hideSort?: boolean) => FormFields<TidyHistogramOptions>;
+export declare const TidyHistogramBucketColName = "bucket";
+export declare const TidyHistogramCountColName = "count";

package/dist/PublicTidyHistogram.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TidyHistogramCountColName = exports.TidyHistogramBucketColName = exports.TidyHistogramMetaOptions = exports.TidyHistogramBucketType = exports.TidyHistogramBucketFormat = void 0;
+const PublicTidyTableTypes_1 = require("./PublicTidyTableTypes");
+var TidyHistogramBucketFormat;
+(function (TidyHistogramBucketFormat) {
+    TidyHistogramBucketFormat["INTERVAL"] = "interval";
+    TidyHistogramBucketFormat["MATH_INTERVAL"] = "mathInterval";
+    TidyHistogramBucketFormat["MATH_INTERVAL_REVERSED"] = "mathIntervalReversed";
+    TidyHistogramBucketFormat["FROM_ONLY"] = "fromOnly";
+    TidyHistogramBucketFormat["TO_ONLY"] = "toOnly";
+})(TidyHistogramBucketFormat = exports.TidyHistogramBucketFormat || (exports.TidyHistogramBucketFormat = {}));
+var TidyHistogramBucketType;
+(function (TidyHistogramBucketType) {
+    TidyHistogramBucketType["LEFT_CLOSED"] = "leftClosed";
+    TidyHistogramBucketType["RIGHT_CLOSED"] = "rightClosed";
+})(TidyHistogramBucketType = exports.TidyHistogramBucketType || (exports.TidyHistogramBucketType = {}));
+const TidyHistogramMetaOptions = (group, hideSort = false) => {
+    return {
+        'binType': {
+            group,
+            fieldType: "option",
+            editorConf: {
+                allowDuplicate: true,
+                optionValues: ["automatic", "userDefined"],
+                optionName: "HistogramBinType"
+            },
+            defaultValue: "automatic"
+        },
+        'numberOfBins': {
+            group,
+            fieldType: "number",
+            defaultValue: 10,
+            dependsOn: "binType",
+            dependsOnVisibility: dependsOnValue => dependsOnValue === "automatic"
+        },
+        'customBins': {
+            group,
+            fieldType: "json",
+            defaultValue: '[{"to": 10},{"from":10,"to":100},{"from":100}]',
+            dependsOn: "binType",
+            dependsOnVisibility: dependsOnValue => dependsOnValue === "userDefined"
+        },
+        'sortBins': {
+            group,
+            fieldType: "option",
+            editorConf: {
+                optionValues: Object.values(PublicTidyTableTypes_1.SortingType),
+                optionName: "SortingType",
+            },
+            defaultValue: PublicTidyTableTypes_1.SortingType.ASCENDING,
+            visibility: !hideSort
+        },
+        'bucketFormat': {
+            group,
+            fieldType: "option",
+            defaultValue: TidyHistogramBucketFormat.INTERVAL,
+            editorConf: {
+                optionValues: Object.values(TidyHistogramBucketFormat),
+                optionName: "TidyHistogramBucketFormat"
+            }
+        },
+        "intervalType": {
+            group,
+            fieldType: 'option',
+            defaultValue: TidyHistogramBucketType.RIGHT_CLOSED,
+            editorConf: {
+                optionValues: Object.values(TidyHistogramBucketType),
+                optionName: "TidyHistogramBucketType"
+            }
+        }
+    };
+};
+exports.TidyHistogramMetaOptions = TidyHistogramMetaOptions;
+exports.TidyHistogramBucketColName = "bucket";
+exports.TidyHistogramCountColName = "count";
+//# sourceMappingURL=PublicTidyHistogram.js.map

package/dist/PublicTidyHistogram.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublicTidyHistogram.js","sourceRoot":"","sources":["../src/PublicTidyHistogram.ts"],"names":[],"mappings":";;;AAAA,iEAAmD;AAGnD,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACjC,kDAAqB,CAAA;IACrB,2DAA8B,CAAA;IAC9B,4EAA+C,CAAA;IAC/C,mDAAsB,CAAA;IACtB,+CAAkB,CAAA;AACtB,CAAC,EANW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAMpC;AAED,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,qDAA0B,CAAA;IAC1B,uDAA4B,CAAA;AAChC,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC;AAWM,MAAM,wBAAwB,GAAG,CAAC,KAAc,EAAE,QAAQ,GAAG,KAAK,EAAoC,EAAE;IAC3G,OAAO;QACH,SAAS,EAAE;YACP,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE;gBACR,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,CAAC,WAAW,EAAE,aAAa,CAAC;gBAC1C,UAAU,EAAE,kBAAkB;aACjC;YACD,YAAY,EAAE,WAAW;SAC5B;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,EAAE;YAChB,SAAS,EAAE,SAAS;YACpB,mBAAmB,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,KAAK,WAAW;SACxE;QACD,YAAY,EAAE;YACV,KAAK;YACL,SAAS,EAAE,MAAM;YACjB,YAAY,EAAE,gDAAgD;YAC9D,SAAS,EAAE,SAAS;YACpB,mBAAmB,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,KAAK,aAAa;SAC1E;QACD,UAAU,EAAE;YACR,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,kCAAW,CAAC;gBACxC,UAAU,EAAE,aAAa;aAC5B;YACD,YAAY,EAAE,kCAAW,CAAC,SAAS;YACnC,UAAU,EAAE,CAAC,QAAQ;SACxB;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,yBAAyB,CAAC,QAAQ;YAChD,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC;gBACtD,UAAU,EAAE,2BAA2B;aAC1C;SACJ;QACD,cAAc,EAAE;YACZ,KAAK;YACL,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,uBAAuB,CAAC,YAAY;YAClD,UAAU,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC;gBACpD,UAAU,EAAE,yBAAyB;aACxC;SACJ;KACJ,CAAA;AACL,CAAC,CAAA;AAvDY,QAAA,wBAAwB,4BAuDpC;AAEY,QAAA,0BAA0B,GAAG,QAAQ,CAAC;AACtC,QAAA,yBAAyB,GAAG,OAAO,CAAC"}

package/dist/PublicTidyMath.d.ts

@@ -1,110 +1,114 @@
-import { ITidyBaseColumn, ITidyColumn, ITidyNumericColumn } from "./PublicTidyColumn";
-import { HistogramData } from "./PublicTidyTableTypes";
-export declare type RealValuedFunction = (x: number) => number;
-interface ITidyMath {
+import { ITidyBaseColumnReadonly } from "./PublicTidyColumn";
+import { HistogramData, HistogramOptions } from "./PublicTidyTableTypes";
+export interface ITidyMath {
     /**
-     * Mathematical functions, null is counted as zero in the sum.
+     * Sum of all values in the column.
      */
-    sum(column: ITidyNumericColumn): number;
+    sum(column: ITidyBaseColumnReadonly<number | null>): number | null;
     /**
      * Get the extreme value of the column. Null values are skipped.
      * @param column
      * @returns the minimum value of the column. Returns undefined if the column has no values or if the column contains
      * a NaN-value.
      */
-    min<T>(column: ITidyBaseColumn<T>): T | undefined;
+    min<T>(column: ITidyBaseColumnReadonly<T>): T | undefined;
     /**
      * Get the extreme value of the column. Null values are skipped.
      * @param column
      * @returns the maximum value of the column. Returns undefined if the column has no values or if the column contains
      * a NaN-value.
      */
-    max<T>(column: ITidyBaseColumn<T>): T | undefined;
+    max<T>(column: ITidyBaseColumnReadonly<T>): T | undefined;
+    /**
+     * Get the maximum of the absolute values of the column.
+     * @param column
+     * @returns If x_1, x_2, ..., x_n are the columns values, then it returns max(|x_1|, ..., |x_n|). Null values are
+     * skipped.
+     */
+    absoluteMax(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
     /**
      * Sum all values matching the lowest depth level of axis column
      */
-    sumOnRoot(column: ITidyNumericColumn, tree: ITidyColumn): number;
+    sumOnRoot(column: ITidyBaseColumnReadonly<number | null>, tree: ITidyBaseColumnReadonly<any>): number;
     /**
      * Estimate the population mean of the column, skipping null values.
      *
      * @returns the mean of the numeric column. Returns undefined if the column has no values or if the column contains
      * a NaN-value.
      */
-    mean(column: ITidyNumericColumn): number | undefined;
+    mean(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
     /**
      * Estimate the population variance of the column. Null values are skipped.
      * @param column
      * @returns the variance of the column. Returns undefined if the column has no values or if the column contains a
      * NaN-value.
      */
-    variance(column: ITidyNumericColumn): number | undefined;
+    variance(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
+    /**
+     * Estimate the population standard deviation of the column. Null values are skipped.
+     * @param column
+     * @returns the standard deviation of the column. Returns undefined if the column has no values or if the column
+     * contains a NaN-value.
+     */
+    standardDeviation(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
     /**
      * Return the number of non-null values in the column.
      */
-    count(column: ITidyColumn): number;
+    count(column: ITidyBaseColumnReadonly<any>): number;
     /**
      * Calculate the median of the column. Null-values are ignored.
      * @param column
      * @returns the median of the numeric column. Returns undefined if the column has no values or if the column contains
      * a NaN-value.
      */
-    median(column: ITidyNumericColumn): number | undefined;
+    median(column: ITidyBaseColumnReadonly<number | null>): number | undefined;
     /**
      * Creates a histogram data object from the column.
      * @param column
-     * @param numberOfBins the maximum number of bins.
+     * @param options see HistogramOptions
+     *
+     * @Returns an array of histogram buckets
      */
-    hist(column: ITidyNumericColumn, numberOfBins?: number): HistogramData[];
-    ols(column: ITidyNumericColumn): RealValuedFunction | undefined;
+    hist(column: ITidyBaseColumnReadonly<number | null>, options: Partial<HistogramOptions>): HistogramData[];
+    /**
+     * Return a regression model with one predictor: y = a0 + a1*x + error
+     * @param y column x
+     * @param x column y
+     */
+    ols(y: ITidyBaseColumnReadonly<number | null>, x: ITidyBaseColumnReadonly<number | null>): ((x: number) => number) | undefined;
     /**
      * Calculate the percentage w.r.t. the total of the column.
      * @param column
      * @param idx row index of the cell to calculate the percentage of.
      */
-    percent(column: ITidyNumericColumn, idx: number): number | undefined;
+    percent(column: ITidyBaseColumnReadonly<number | null>, idx: number): number | undefined;
     /**
      * Count the values in the column. For example: [a, b, b] -> {a: 1, b: 2}.
      */
-    valueCounts<T>(column: ITidyBaseColumn<T>): Map<T, number>;
+    valueCounts<T>(column: ITidyBaseColumnReadonly<T>): Map<T, number>;
     /**
-     * Scale a numeric column so that its values are on [-1, 1].
-     * For each value x, return x / max(|x_1|, ..., |x_n|).
+     * Normalize a numeric column so that its values are on [0, 1].
+     * For each value x, return (x - x_min) / (x_max - x_min).
      *
      * @returns undefined if one of the values in the scalar could not be calculated.
      */
-    scaleMaxAbsolute(column: ITidyNumericColumn): RealValuedFunction | undefined;
+    scaleNormalize(column: ITidyBaseColumnReadonly<number | null> | undefined, idx: number, min: number | undefined, max: number | undefined, val: number | undefined): number | undefined;
     /**
-     * Normalize a numeric column so that its values are on [0, 1].
-     * For each value x, return (x - x_min) / (x_max - x_min).
+     * Scale a numeric column so that its values are on [-1, 1].
+     * For each value x, return x / max(|x_1|, ..., |x_n|).
      *
      * @returns undefined if one of the values in the scalar could not be calculated.
      */
-    scaleNormalize(column: ITidyNumericColumn): RealValuedFunction | undefined;
+    scaleMaxAbsolute(column: ITidyBaseColumnReadonly<number | null>, idx: number): number | undefined;
     /**
      * Standardize the column.
      * For each value x, return (x - x_mean) / x_stdev.
      *
      * @returns undefined if one of the values in the scalar could not be calculated.
      */
-    scaleStandardize(column: ITidyNumericColumn): RealValuedFunction | undefined;
-}
-declare class TidyMathImpl implements ITidyMath {
-    percent(column: ITidyNumericColumn, idx: number): number | undefined;
-    scaleMaxAbsolute(column: ITidyNumericColumn): RealValuedFunction | undefined;
-    scaleNormalize_(column: ITidyNumericColumn, idx: number, min: number | undefined, max: number | undefined, val: number | undefined): number | undefined;
-    scaleNormalize(column: ITidyNumericColumn): RealValuedFunction | undefined;
-    scaleStandardize(column: ITidyNumericColumn): RealValuedFunction | undefined;
-    variance(column: ITidyNumericColumn): number | undefined;
-    sum(column: ITidyNumericColumn): number;
-    min<T>(column: ITidyBaseColumn<T>): T | undefined;
-    max<T>(column: ITidyBaseColumn<T>): T | undefined;
-    sumOnRoot(column: ITidyNumericColumn, tree: ITidyBaseColumn<any>): number;
-    count(column: ITidyColumn): number;
-    mean(column: ITidyNumericColumn): number | undefined;
-    median(column: ITidyNumericColumn): number | undefined;
-    hist(column: ITidyNumericColumn, numberOfBins?: number): HistogramData[];
-    ols(column: ITidyNumericColumn): RealValuedFunction | undefined;
-    valueCounts<T>(column: ITidyBaseColumn<T>): Map<T, number>;
+    scaleStandardize(column: ITidyBaseColumnReadonly<number | null>, idx: number): number | undefined;
+    /**
+     * Returns the covariance between two columns. Nulls are interpreted as zeros.
+     */
+    covariance(x: ITidyBaseColumnReadonly<number | null>, y: ITidyBaseColumnReadonly<number | null>): number | undefined;
 }
-export declare const TidyMath: TidyMathImpl;
-export {};

package/dist/PublicTidyMath.js

@@ -1,283 +1,3 @@
 "use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TidyMath = void 0;
-class TidyMathImpl {
-    percent(column, idx) {
-        const value = column.getValue(idx);
-        if (value != null) {
-            return value / this.sum(column);
-        }
-        return undefined;
-    }
-    scaleMaxAbsolute(column) {
-        let max = 0;
-        for (let i = 0; i < column.length(); i++) {
-            const val = column.getValue(i);
-            if (val != null) {
-                if (isNaN(val))
-                    return undefined;
-                const v = Math.abs(val);
-                if (v > max)
-                    max = v;
-            }
-        }
-        return (x) => x / max;
-    }
-    scaleNormalize_(column, idx, min, max, val) {
-        var _a, _b, _c;
-        if (min == null) {
-            min = (_a = exports.TidyMath.min(column)) !== null && _a !== void 0 ? _a : undefined;
-        }
-        if (max == null) {
-            max = (_b = exports.TidyMath.max(column)) !== null && _b !== void 0 ? _b : undefined;
-        }
-        if (val == null) {
-            val = (_c = column.getValue(idx)) !== null && _c !== void 0 ? _c : undefined;
-        }
-        if (min == null || max == null || val == null) {
-            return undefined;
-        }
-        if (min === max) {
-            return 1;
-        }
-        return (val - min) / (max - min);
-    }
-    scaleNormalize(column) {
-        const max = this.max(column);
-        const min = this.min(column);
-        if (min == null || max == null) {
-            return undefined;
-        }
-        const range = max - min;
-        return (x) => (x - min) / range;
-    }
-    scaleStandardize(column) {
-        const mean = this.mean(column);
-        const variance = this.variance(column);
-        if (variance == null || mean == null) {
-            return undefined;
-        }
-        const stdev = Math.sqrt(variance);
-        return (x) => (x - mean) / stdev;
-    }
-    variance(column) {
-        const count = this.count(column);
-        const columnMean = this.mean(column);
-        if (columnMean == null) {
-            return undefined;
-        }
-        let sum_errors_squared = 0;
-        for (let i = 0; i < column.length(); i++) {
-            const value = column.getValue(i);
-            if (value != null) {
-                sum_errors_squared += Math.pow((value - columnMean), 2);
-            }
-        }
-        const dof = count - 1;
-        if (dof === 0)
-            return undefined;
-        return sum_errors_squared / dof;
-    }
-    sum(column) {
-        var _a;
-        if (column.length() === 0) {
-            return 0; // https://en.wikipedia.org/wiki/Empty_sum
-        }
-        return (_a = column.getValues().reduce((a, b) => (a !== null && a !== void 0 ? a : 0) + (b !== null && b !== void 0 ? b : 0))) !== null && _a !== void 0 ? _a : 0;
-    }
-    min(column) {
-        let result = undefined;
-        for (let i = 0; i < column.length(); i++) {
-            const value = column.getValue(i);
-            if (typeof value === "number" && isNaN(value)) {
-                return undefined;
-            }
-            if (value == null) {
-                continue;
-            }
-            if (result === undefined) {
-                result = value;
-            }
-            else if (column.compare(value, result) < 0) {
-                result = value;
-            }
-        }
-        return result;
-    }
-    max(column) {
-        let result = undefined;
-        for (let i = 0; i < column.length(); i++) {
-            const value = column.getValue(i);
-            if (typeof value === "number" && isNaN(value)) {
-                return undefined;
-            }
-            if (value == null) {
-                continue;
-            }
-            if (result === undefined) {
-                result = value;
-            }
-            else if (column.compare(value, result) > 0) {
-                result = value;
-            }
-        }
-        return result;
-    }
-    sumOnRoot(column, tree) {
-        var _a;
-        if (tree.isHierarchy() && tree.length()) {
-            let sum = 0;
-            const N = column.length();
-            for (let i = 0; i < N; i++) {
-                const cLevel = tree.getLevelDepth(i) || 0;
-                if (cLevel <= 0) {
-                    sum += (_a = column.getValue(i)) !== null && _a !== void 0 ? _a : 0;
-                }
-            }
-            return sum;
-        }
-        else {
-            return this.sum(column);
-        }
-    }
-    count(column) {
-        let count = 0;
-        column.getValues().forEach(v => v != null && count++);
-        return count;
-    }
-    mean(column) {
-        const count = this.count(column);
-        if (count !== 0) {
-            const sum = this.sum(column);
-            if (sum != null && !isNaN(sum)) {
-                return sum / count;
-            }
-        }
-        return undefined;
-    }
-    median(column) {
-        const values = [];
-        for (const v of column.getValues()) {
-            if (v != null) {
-                if (isNaN(v))
-                    return undefined;
-                values.push(v);
-            }
-        }
-        if (values.length === 0) {
-            return undefined;
-        }
-        if (values.length === 1) {
-            return values[0];
-        }
-        values.sort();
-        const half = Math.floor(values.length / 2);
-        if (values.length % 2)
-            return values[half];
-        return (values[half - 1] + values[half]) / 2.0;
-    }
-    hist(column, numberOfBins = 10) {
-        const valueMin = this.min(column);
-        const valueMax = this.max(column);
-        if (numberOfBins <= 0 || column.length() === 0 || valueMin == null || valueMax == null) {
-            return [];
-        }
-        const valueRange = valueMax - valueMin;
-        if (valueRange === 0) {
-            return [{
-                    from: valueMin,
-                    to: valueMax,
-                    count: column.length()
-                }];
-        }
-        const valueStep = valueRange / numberOfBins;
-        const binData = new Array(numberOfBins);
-        for (let b = 0; b < numberOfBins; b++) {
-            binData[b] = {
-                from: valueMin + valueStep * b,
-                to: valueMin + valueStep * (b + 1),
-                count: 0
-            };
-        }
-        column.getValues().forEach(value => {
-            if (value != null) {
-                const b = Math.floor((value - valueMin) / valueRange * (numberOfBins - 1));
-                binData[b].count++;
-            }
-        });
-        return binData;
-    }
-    ols(column) {
-        const values = [];
-        column.getValues().forEach(v => v && values.push(v));
-        const data = values.map((value, index) => [index, value]);
-        if (data.length < 2) {
-            return undefined;
-        }
-        const sum_y = data.reduce((a, b) => a + b[1], 0);
-        const sum_x = data.reduce((a, b) => a + b[0], 0);
-        const sum_x_squared = data.reduce((a, b) => a + b[0] * b[0], 0);
-        const variance_x = sum_x_squared - sum_x * sum_x / data.length;
-        const cov = data.reduce((a, b) => a + b[0] * b[1], 0) - sum_x * sum_y / data.length;
-        const b = cov / variance_x;
-        const a = sum_y / data.length - b * sum_x / data.length;
-        if (isNaN(b) || isNaN(a)) {
-            return undefined;
-        }
-        return (x) => {
-            return a + b * x;
-        };
-    }
-    valueCounts(column) {
-        const counts = new Map();
-        column.getValues().forEach(value => {
-            var _a;
-            counts.set(value, ((_a = counts.get(value)) !== null && _a !== void 0 ? _a : 0) + 1);
-        });
-        return counts;
-    }
-}
-__decorate([
-    cached
-], TidyMathImpl.prototype, "variance", null);
-__decorate([
-    cached
-], TidyMathImpl.prototype, "sum", null);
-__decorate([
-    cached
-], TidyMathImpl.prototype, "min", null);
-__decorate([
-    cached
-], TidyMathImpl.prototype, "max", null);
-__decorate([
-    cached
-], TidyMathImpl.prototype, "count", null);
-__decorate([
-    cached
-], TidyMathImpl.prototype, "mean", null);
-__decorate([
-    cached
-], TidyMathImpl.prototype, "median", null);
-/**
- * Cache the result of the function in the column. Note, the function should have one argument which is the column.
- */
-function cached(target, propertyName, descriptor) {
-    const originalMethod = descriptor.value;
-    descriptor.value = function (column) {
-        const cachedValue = column.getCachedValue(propertyName);
-        if (cachedValue != null) {
-            return cachedValue;
-        }
-        const returnValue = originalMethod === null || originalMethod === void 0 ? void 0 : originalMethod.apply(this, [column]);
-        column.setCachedValue(propertyName, returnValue);
-        return returnValue;
-    };
-}
-exports.TidyMath = new TidyMathImpl();
 //# sourceMappingURL=PublicTidyMath.js.map