@datagrok-libraries/utils 0.0.1 → 0.0.5

package/src/spe.js

@@ -0,0 +1,151 @@
+import { calculateEuclideanDistance, calcDistanceMatrix, fillRandomMatrix, vectorAdd, randomInt } from './operations';
+/**
+ * Implements stochastic proximity embedding.
+ *
+ * @export
+ * @class SPEBase
+ * @link doi:10.1016/S1093-3263(03)00155-4
+ */
+export class SPEBase {
+    /**
+     * Creates an instance of SPEBase.
+     * @param {Options} [options] Options to pass to the constructor.
+     * @memberof SPEBase
+     */
+    constructor(options) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        this.steps = (_a = options === null || options === void 0 ? void 0 : options.steps) !== null && _a !== void 0 ? _a : 0;
+        this.cycles = (_b = options === null || options === void 0 ? void 0 : options.cycles) !== null && _b !== void 0 ? _b : 1e6;
+        // Select a cutoff distance {cutoff} and ...
+        this.cutoff = (_c = options === null || options === void 0 ? void 0 : options.cutoff) !== null && _c !== void 0 ? _c : 0;
+        // ... an initial learning rate {lambda} > 0
+        this.lambda = (_d = options === null || options === void 0 ? void 0 : options.lambda) !== null && _d !== void 0 ? _d : 2.0;
+        this.dlambda = (_e = options === null || options === void 0 ? void 0 : options.dlambda) !== null && _e !== void 0 ? _e : 0.01;
+        this.lambda2 = this.lambda / 2.;
+        this.dlambda2 = this.dlambda / 2.;
+        this.epsilon = (_f = options === null || options === void 0 ? void 0 : options.epsilon) !== null && _f !== void 0 ? _f : 1e-10;
+        // eslint-disable-next-line brace-style
+        this.distanceFunction = (_g = options === null || options === void 0 ? void 0 : options.distance) !== null && _g !== void 0 ? _g : calculateEuclideanDistance;
+        this.distance = [];
+    }
+    /**
+     * Initializes distance matrix.
+     *
+     * @protected
+     * @param {Vectors} vectors Input vectors to calculate distance between.
+     * @memberof SPEBase
+     */
+    initDistance(vectors) {
+        this.distance = calcDistanceMatrix(vectors, this.distanceFunction);
+    }
+    /**
+     * Calculates distance between the two vectors given.
+     *
+     * @param {Vectors} vectors Set of vectors to calculate distances between.
+     * @param {number} index1 Index of the first vector of the pair.
+     * @param {number} index2 Index of the second vector of the pair.
+     * @return {number} Distance between these two vectors.
+     */
+    calcDistance(vectors, index1, index2) {
+        return this.distance[index1][index2];
+    }
+    /**
+     * Embeds the vectors given into a two-dimensional space.
+     *
+     * @param {Vectors} vectors D-dimensional coordinates.
+     * @return {Coordinates} SPE coordinates in D space.
+     */
+    embed(vectors) {
+        const nItems = vectors.length;
+        const areaWidth = 40;
+        // Initialize the D-dimensional coordinates of the N points.
+        const coordinates = fillRandomMatrix(nItems, SPEBase.dimension, areaWidth);
+        let lambda2 = this.lambda2;
+        if (this.steps == 0) {
+            this.steps = vectors.length - 1;
+        }
+        this.initDistance(vectors);
+        for (let cycle = 0; cycle < this.cycles; ++cycle) {
+            for (let step = 0; step < this.steps; ++step) {
+                // Select two points, i and j, at random, ...
+                const i = randomInt(nItems);
+                let j = randomInt(nItems);
+                while (i == j)
+                    j = randomInt(nItems);
+                const rowi = coordinates[i];
+                const rowj = coordinates[j];
+                // ... retrieve (or evaluate) their proximity in the input space, rij and ...
+                const r = this.calcDistance(vectors, i, j);
+                // ... compute their Euclidean distance on the D-dimensional map, dij.
+                const d = calculateEuclideanDistance(rowi, rowj);
+                // If rij <= rc, or if rij > rc and dij < rij ...
+                if ((this.cutoff == 0) || (r <= this.cutoff) || (d < r)) {
+                    const multiplier = lambda2 * (r - d) / (d + this.epsilon);
+                    // ... update the coordinates xi and xj.
+                    const diffIJ = vectorAdd(rowi, rowj, -1);
+                    coordinates[i] = vectorAdd(rowi, diffIJ, multiplier);
+                    coordinates[j] = vectorAdd(rowj, diffIJ, -multiplier);
+                }
+            }
+            // Decrease the learning rate {lambda} by a prescribed {dlambda}.
+            lambda2 -= this.dlambda2;
+            if (lambda2 <= 0.) {
+                break;
+            }
+        }
+        return coordinates;
+    }
+}
+SPEBase.dimension = 2;
+/**
+ * Implements modified stochastic proximity embedding.
+ *
+ * @export
+ * @class PSPEBase
+ * @link doi:10.1016/S1093-3263(03)00155-4
+ */
+export class PSPEBase extends SPEBase {
+    /**
+     * Embeds the vectors given into a two-dimensional space using a modified update rule.
+     *
+     * @param {Vectors} vectors D-dimensional coordinates.
+     * @return {Coordinates} SPE coordinates in D space.
+     */
+    embed(vectors) {
+        const nItems = vectors.length;
+        const areaWidth = 40;
+        //  Initialize the D-dimensional coordinates of the N points.
+        const coordinates = fillRandomMatrix(nItems, PSPEBase.dimension, areaWidth);
+        let lambda = this.lambda;
+        this.initDistance(vectors);
+        for (let cycle = 0; cycle < this.cycles; ++cycle) {
+            // Select a point, i, at random (pivot).
+            const i = randomInt(nItems);
+            const rowi = coordinates[i];
+            // For every point j != i ...
+            for (let j = 0; j < nItems; ++j) {
+                if (i == j)
+                    continue;
+                const rowj = coordinates[j];
+                // ... retrieve (or evaluate) its proximity to i in the input space, rij ...
+                const r = this.calcDistance(vectors, i, j);
+                // ... and compute their Euclidean distance on the D-dimensional map, dij.
+                const d = calculateEuclideanDistance(rowi, rowj);
+                // If rij <= rc, or if rij > rc and dij < rij ...
+                if ((this.cutoff == 0) || (r <= this.cutoff) || (d < r)) {
+                    const multiplier = lambda * (r - d) / (d + this.epsilon);
+                    const diffIJ = vectorAdd(rowi, rowj, -1);
+                    // ... update the coordinates xj.
+                    coordinates[j] = vectorAdd(rowj, diffIJ, -multiplier);
+                }
+            }
+            // Decrease the learning rate {lambda} by a prescribed {dlambda}.
+            lambda -= this.dlambda;
+            if (lambda <= 0.) {
+                break;
+            }
+        }
+        return coordinates;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"spe.js","sourceRoot":"","sources":["spe.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,0BAA0B,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,EAAC,MAAM,cAAc,CAAC;AAEpH;;;;;;GAMG;AACH,MAAM,OAAO,OAAO;IAalB;;;;OAIG;IACH,YAAY,OAAiB;;QAC3B,IAAI,CAAC,KAAK,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,GAAG,CAAC;QACrC,4CAA4C;QAC5C,IAAI,CAAC,MAAM,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,CAAC,CAAC;QACnC,4CAA4C;QAC5C,IAAI,CAAC,MAAM,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,GAAG,CAAC;QACrC,IAAI,CAAC,OAAO,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,IAAI,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,GAAC,EAAE,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,GAAC,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,KAAK,CAAC;QACzC,uCAAuC;QACvC,IAAI,CAAC,gBAAgB,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,0BAA0B,CAAC;QACxE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACO,YAAY,CAAC,OAAgB;QACrC,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACO,YAAY,CAAC,OAAgB,EAAE,MAAc,EAAE,MAAc;QACrE,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAgB;QAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,4DAA4D;QAC5D,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE3E,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE3B,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,EAAE;YACnB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,GAAC,CAAC,CAAC;SAC/B;QAED,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE;YAChD,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE;gBAC5C,6CAA6C;gBAC7C,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;gBAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;gBACvD,OAAO,CAAC,IAAI,CAAC;oBAAE,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;gBAErC,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;gBAAC,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;gBAEzD,6EAA6E;gBAC7E,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC3C,sEAAsE;gBACtE,MAAM,CAAC,GAAG,0BAA0B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAEjD,iDAAiD;gBACjD,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE;oBACvD,MAAM,UAAU,GAAG,OAAO,GAAC,CAAC,CAAC,GAAC,CAAC,CAAC,GAAC,CAAC,CAAC,GAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAClD,wCAAwC;oBACxC,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBACzC,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;oBACrD,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,UAAU,CAAC,CAAC;iBACvD;aACF;YACD,iEAAiE;YACjE,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC;YACzB,IAAI,OAAO,IAAI,EAAE,EAAE;gBACjB,MAAM;aACP;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;;AAzGgB,iBAAS,GAAG,CAAC,CAAC;AA4GjC;;;;;;GAMG;AACF,MAAM,OAAO,QAAS,SAAQ,OAAO;IACpC;;;;;OAKG;IACI,KAAK,CAAC,OAAgB;QAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,6DAA6D;QAC7D,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC5E,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAEzB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE;YAChD,wCAAwC;YACxC,MAAM,CAAC,GAAW,SAAS,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAE5B,6BAA6B;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/B,IAAI,CAAC,IAAI,CAAC;oBAAE,SAAS;gBACrB,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;gBAC5B,4EAA4E;gBAC5E,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC3C,0EAA0E;gBAC1E,MAAM,CAAC,GAAG,0BAA0B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACjD,iDAAiD;gBACjD,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE;oBACvD,MAAM,UAAU,GAAG,MAAM,GAAC,CAAC,CAAC,GAAC,CAAC,CAAC,GAAC,CAAC,CAAC,GAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACjD,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBACzC,iCAAiC;oBACjC,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,UAAU,CAAC,CAAC;iBACvD;aACF;YACD,iEAAiE;YACjE,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC;YACvB,IAAI,MAAM,IAAI,EAAE,EAAE;gBAChB,MAAM;aACP;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CACF","sourcesContent":["import {Options, Coordinates, Vectors, DistanceMetric} from './type_declarations';\r\nimport {calculateEuclideanDistance, calcDistanceMatrix, fillRandomMatrix, vectorAdd, randomInt} from './operations';\r\n\r\n/**\r\n * Implements stochastic proximity embedding.\r\n *\r\n * @export\r\n * @class SPEBase\r\n * @link doi:10.1016/S1093-3263(03)00155-4\r\n */\r\nexport class SPEBase {\r\n  protected static dimension = 2;\r\n  protected steps: number;\r\n  protected cycles: number;\r\n  protected cutoff: number;\r\n  protected lambda: number;\r\n  protected dlambda: number;\r\n  protected lambda2: number;\r\n  protected dlambda2: number;\r\n  protected epsilon: number;\r\n  protected distanceFunction: DistanceMetric;\r\n  protected distance: Coordinates;\r\n\r\n  /**\r\n   * Creates an instance of SPEBase.\r\n   * @param {Options} [options] Options to pass to the constructor.\r\n   * @memberof SPEBase\r\n   */\r\n  constructor(options?: Options) {\r\n    this.steps = options?.steps ?? 0;\r\n    this.cycles = options?.cycles ?? 1e6;\r\n    // Select a cutoff distance {cutoff} and ...\r\n    this.cutoff = options?.cutoff ?? 0;\r\n    // ... an initial learning rate {lambda} > 0\r\n    this.lambda = options?.lambda ?? 2.0;\r\n    this.dlambda = options?.dlambda ?? 0.01;\r\n    this.lambda2 = this.lambda/2.;\r\n    this.dlambda2 = this.dlambda/2.;\r\n    this.epsilon = options?.epsilon ?? 1e-10;\r\n    // eslint-disable-next-line brace-style\r\n    this.distanceFunction = options?.distance ?? calculateEuclideanDistance;\r\n    this.distance = [];\r\n  }\r\n\r\n  /**\r\n   * Initializes distance matrix.\r\n   *\r\n   * @protected\r\n   * @param {Vectors} vectors Input vectors to calculate distance between.\r\n   * @memberof SPEBase\r\n   */\r\n  protected initDistance(vectors: Vectors) {\r\n    this.distance = calcDistanceMatrix(vectors, this.distanceFunction);\r\n  }\r\n\r\n  /**\r\n   * Calculates distance between the two vectors given.\r\n   * \r\n   * @param {Vectors} vectors Set of vectors to calculate distances between.\r\n   * @param {number} index1 Index of the first vector of the pair.\r\n   * @param {number} index2 Index of the second vector of the pair.\r\n   * @return {number} Distance between these two vectors.\r\n   */\r\n  protected calcDistance(vectors: Vectors, index1: number, index2: number): number {\r\n    return this.distance[index1][index2];\r\n  }\r\n\r\n  /**\r\n   * Embeds the vectors given into a two-dimensional space.\r\n   * \r\n   * @param {Vectors} vectors D-dimensional coordinates.\r\n   * @return {Coordinates} SPE coordinates in D space.\r\n   */\r\n  public embed(vectors: Vectors): Coordinates {\r\n    const nItems = vectors.length;\r\n    const areaWidth = 40;\r\n    // Initialize the D-dimensional coordinates of the N points.\r\n    const coordinates = fillRandomMatrix(nItems, SPEBase.dimension, areaWidth);\r\n\r\n    let lambda2 = this.lambda2;\r\n\r\n    if (this.steps == 0) {\r\n      this.steps = vectors.length-1;\r\n    }\r\n\r\n    this.initDistance(vectors);\r\n\r\n    for (let cycle = 0; cycle < this.cycles; ++cycle) {\r\n      for (let step = 0; step < this.steps; ++step) {\r\n        // Select two points, i and j, at random, ...\r\n        const i = randomInt(nItems); let j = randomInt(nItems);\r\n        while (i == j) j = randomInt(nItems);\r\n\r\n        const rowi = coordinates[i]; const rowj = coordinates[j];\r\n\r\n        // ... retrieve (or evaluate) their proximity in the input space, rij and ...\r\n        const r = this.calcDistance(vectors, i, j);\r\n        // ... compute their Euclidean distance on the D-dimensional map, dij.\r\n        const d = calculateEuclideanDistance(rowi, rowj);\r\n\r\n        // If rij <= rc, or if rij > rc and dij < rij ...\r\n        if ((this.cutoff == 0) || (r <= this.cutoff) || (d < r)) {\r\n          const multiplier = lambda2*(r-d)/(d+this.epsilon);\r\n          // ... update the coordinates xi and xj.\r\n          const diffIJ = vectorAdd(rowi, rowj, -1);\r\n          coordinates[i] = vectorAdd(rowi, diffIJ, multiplier);\r\n          coordinates[j] = vectorAdd(rowj, diffIJ, -multiplier);\r\n        }\r\n      }\r\n      // Decrease the learning rate {lambda} by a prescribed {dlambda}.\r\n      lambda2 -= this.dlambda2;\r\n      if (lambda2 <= 0.) {\r\n        break;\r\n      }\r\n    }\r\n    return coordinates;\r\n  }\r\n}\r\n\r\n/**\r\n * Implements modified stochastic proximity embedding.\r\n *\r\n * @export\r\n * @class PSPEBase\r\n * @link doi:10.1016/S1093-3263(03)00155-4\r\n */\r\n export class PSPEBase extends SPEBase {\r\n  /**\r\n   * Embeds the vectors given into a two-dimensional space using a modified update rule.\r\n   * \r\n   * @param {Vectors} vectors D-dimensional coordinates.\r\n   * @return {Coordinates} SPE coordinates in D space.\r\n   */\r\n  public embed(vectors: Vectors): Coordinates {\r\n    const nItems = vectors.length;\r\n    const areaWidth = 40;\r\n    //  Initialize the D-dimensional coordinates of the N points.\r\n    const coordinates = fillRandomMatrix(nItems, PSPEBase.dimension, areaWidth);\r\n    let lambda = this.lambda;\r\n\r\n    this.initDistance(vectors);\r\n\r\n    for (let cycle = 0; cycle < this.cycles; ++cycle) {\r\n      // Select a point, i, at random (pivot).\r\n      const i: number = randomInt(nItems);\r\n      const rowi = coordinates[i];\r\n\r\n      // For every point j != i ...\r\n      for (let j = 0; j < nItems; ++j) {\r\n        if (i == j) continue;\r\n        const rowj = coordinates[j];\r\n        // ... retrieve (or evaluate) its proximity to i in the input space, rij ...\r\n        const r = this.calcDistance(vectors, i, j);\r\n        // ... and compute their Euclidean distance on the D-dimensional map, dij.\r\n        const d = calculateEuclideanDistance(rowi, rowj);\r\n        // If rij <= rc, or if rij > rc and dij < rij ...\r\n        if ((this.cutoff == 0) || (r <= this.cutoff) || (d < r)) {\r\n          const multiplier = lambda*(r-d)/(d+this.epsilon);\r\n          const diffIJ = vectorAdd(rowi, rowj, -1);\r\n          // ... update the coordinates xj.\r\n          coordinates[j] = vectorAdd(rowj, diffIJ, -multiplier);\r\n        }\r\n      }\r\n      // Decrease the learning rate {lambda} by a prescribed {dlambda}.\r\n      lambda -= this.dlambda;\r\n      if (lambda <= 0.) {\r\n        break;\r\n      }\r\n    }\r\n    return coordinates;\r\n  }\r\n}\r\n"]}

package/src/spe.ts

@@ -0,0 +1,172 @@
+import {Options, Coordinates, Vectors, DistanceMetric} from './type_declarations';
+import {calculateEuclideanDistance, calcDistanceMatrix, fillRandomMatrix, vectorAdd, randomInt} from './operations';
+
+/**
+ * Implements stochastic proximity embedding.
+ *
+ * @export
+ * @class SPEBase
+ * @link doi:10.1016/S1093-3263(03)00155-4
+ */
+export class SPEBase {
+  protected static dimension = 2;
+  protected steps: number;
+  protected cycles: number;
+  protected cutoff: number;
+  protected lambda: number;
+  protected dlambda: number;
+  protected lambda2: number;
+  protected dlambda2: number;
+  protected epsilon: number;
+  protected distanceFunction: DistanceMetric;
+  protected distance: Coordinates;
+
+  /**
+   * Creates an instance of SPEBase.
+   * @param {Options} [options] Options to pass to the constructor.
+   * @memberof SPEBase
+   */
+  constructor(options?: Options) {
+    this.steps = options?.steps ?? 0;
+    this.cycles = options?.cycles ?? 1e6;
+    // Select a cutoff distance {cutoff} and ...
+    this.cutoff = options?.cutoff ?? 0;
+    // ... an initial learning rate {lambda} > 0
+    this.lambda = options?.lambda ?? 2.0;
+    this.dlambda = options?.dlambda ?? 0.01;
+    this.lambda2 = this.lambda/2.;
+    this.dlambda2 = this.dlambda/2.;
+    this.epsilon = options?.epsilon ?? 1e-10;
+    // eslint-disable-next-line brace-style
+    this.distanceFunction = options?.distance ?? calculateEuclideanDistance;
+    this.distance = [];
+  }
+
+  /**
+   * Initializes distance matrix.
+   *
+   * @protected
+   * @param {Vectors} vectors Input vectors to calculate distance between.
+   * @memberof SPEBase
+   */
+  protected initDistance(vectors: Vectors) {
+    this.distance = calcDistanceMatrix(vectors, this.distanceFunction);
+  }
+
+  /**
+   * Calculates distance between the two vectors given.
+   * 
+   * @param {Vectors} vectors Set of vectors to calculate distances between.
+   * @param {number} index1 Index of the first vector of the pair.
+   * @param {number} index2 Index of the second vector of the pair.
+   * @return {number} Distance between these two vectors.
+   */
+  protected calcDistance(vectors: Vectors, index1: number, index2: number): number {
+    return this.distance[index1][index2];
+  }
+
+  /**
+   * Embeds the vectors given into a two-dimensional space.
+   * 
+   * @param {Vectors} vectors D-dimensional coordinates.
+   * @return {Coordinates} SPE coordinates in D space.
+   */
+  public embed(vectors: Vectors): Coordinates {
+    const nItems = vectors.length;
+    const areaWidth = 40;
+    // Initialize the D-dimensional coordinates of the N points.
+    const coordinates = fillRandomMatrix(nItems, SPEBase.dimension, areaWidth);
+
+    let lambda2 = this.lambda2;
+
+    if (this.steps == 0) {
+      this.steps = vectors.length-1;
+    }
+
+    this.initDistance(vectors);
+
+    for (let cycle = 0; cycle < this.cycles; ++cycle) {
+      for (let step = 0; step < this.steps; ++step) {
+        // Select two points, i and j, at random, ...
+        const i = randomInt(nItems); let j = randomInt(nItems);
+        while (i == j) j = randomInt(nItems);
+
+        const rowi = coordinates[i]; const rowj = coordinates[j];
+
+        // ... retrieve (or evaluate) their proximity in the input space, rij and ...
+        const r = this.calcDistance(vectors, i, j);
+        // ... compute their Euclidean distance on the D-dimensional map, dij.
+        const d = calculateEuclideanDistance(rowi, rowj);
+
+        // If rij <= rc, or if rij > rc and dij < rij ...
+        if ((this.cutoff == 0) || (r <= this.cutoff) || (d < r)) {
+          const multiplier = lambda2*(r-d)/(d+this.epsilon);
+          // ... update the coordinates xi and xj.
+          const diffIJ = vectorAdd(rowi, rowj, -1);
+          coordinates[i] = vectorAdd(rowi, diffIJ, multiplier);
+          coordinates[j] = vectorAdd(rowj, diffIJ, -multiplier);
+        }
+      }
+      // Decrease the learning rate {lambda} by a prescribed {dlambda}.
+      lambda2 -= this.dlambda2;
+      if (lambda2 <= 0.) {
+        break;
+      }
+    }
+    return coordinates;
+  }
+}
+
+/**
+ * Implements modified stochastic proximity embedding.
+ *
+ * @export
+ * @class PSPEBase
+ * @link doi:10.1016/S1093-3263(03)00155-4
+ */
+ export class PSPEBase extends SPEBase {
+  /**
+   * Embeds the vectors given into a two-dimensional space using a modified update rule.
+   * 
+   * @param {Vectors} vectors D-dimensional coordinates.
+   * @return {Coordinates} SPE coordinates in D space.
+   */
+  public embed(vectors: Vectors): Coordinates {
+    const nItems = vectors.length;
+    const areaWidth = 40;
+    //  Initialize the D-dimensional coordinates of the N points.
+    const coordinates = fillRandomMatrix(nItems, PSPEBase.dimension, areaWidth);
+    let lambda = this.lambda;
+
+    this.initDistance(vectors);
+
+    for (let cycle = 0; cycle < this.cycles; ++cycle) {
+      // Select a point, i, at random (pivot).
+      const i: number = randomInt(nItems);
+      const rowi = coordinates[i];
+
+      // For every point j != i ...
+      for (let j = 0; j < nItems; ++j) {
+        if (i == j) continue;
+        const rowj = coordinates[j];
+        // ... retrieve (or evaluate) its proximity to i in the input space, rij ...
+        const r = this.calcDistance(vectors, i, j);
+        // ... and compute their Euclidean distance on the D-dimensional map, dij.
+        const d = calculateEuclideanDistance(rowi, rowj);
+        // If rij <= rc, or if rij > rc and dij < rij ...
+        if ((this.cutoff == 0) || (r <= this.cutoff) || (d < r)) {
+          const multiplier = lambda*(r-d)/(d+this.epsilon);
+          const diffIJ = vectorAdd(rowi, rowj, -1);
+          // ... update the coordinates xj.
+          coordinates[j] = vectorAdd(rowj, diffIJ, -multiplier);
+        }
+      }
+      // Decrease the learning rate {lambda} by a prescribed {dlambda}.
+      lambda -= this.dlambda;
+      if (lambda <= 0.) {
+        break;
+      }
+    }
+    return coordinates;
+  }
+}

package/src/string-measure.js

@@ -0,0 +1,46 @@
+import * as fl from 'fastest-levenshtein';
+import { jaroWinkler } from 'jaro-winkler-typescript';
+import { assert } from './operations';
+/**
+ * Unified class implementing the different string measures.
+ *
+ * @export
+ * @class Measurer
+ */
+export class Measurer {
+    /**
+     * Creates an instance of Measurer.
+     * @param {string} method Method to calculate distance between strings.
+     * @memberof Measurer
+     */
+    constructor(method) {
+        this.receipt = {
+            'Levenshtein': fl.distance,
+            'Jaro-Winkler': jaroWinkler,
+        };
+        assert(this.availableMeasures.includes(method), 'The ${method} was not found.');
+        this.method = method;
+    }
+    /**
+     * Returns custom string distance function specified.
+     * @return {DistanceMetric} Callback of the measure chosen.
+     */
+    getMeasure() {
+        return this.receipt[this.method];
+    }
+    /**
+     * Returns available string distance metrics.
+     *
+     * @readonly
+     * @type {string[]}
+     * @memberof Measurer
+     */
+    get availableMeasures() {
+        let keys = [];
+        for (let key in this.receipt) {
+            keys.push(key);
+        }
+        return keys;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RyaW5nLW1lYXN1cmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJzdHJpbmctbWVhc3VyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQzFDLE9BQU8sRUFBQyxXQUFXLEVBQUMsTUFBTSx5QkFBeUIsQ0FBQztBQUdwRCxPQUFPLEVBQUMsTUFBTSxFQUFDLE1BQU0sY0FBYyxDQUFDO0FBRXBDOzs7OztHQUtHO0FBQ0gsTUFBTSxPQUFPLFFBQVE7SUFPakI7Ozs7T0FJRztJQUNILFlBQVksTUFBYztRQVZoQixZQUFPLEdBQXFDO1lBQ3BELGFBQWEsRUFBRSxFQUFFLENBQUMsUUFBUTtZQUMxQixjQUFjLEVBQUUsV0FBVztTQUM1QixDQUFDO1FBUUEsTUFBTSxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLEVBQUUsOEJBQThCLENBQUMsQ0FBQTtRQUMvRSxJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztJQUN2QixDQUFDO0lBRUQ7OztPQUdHO0lBQ0ksVUFBVTtRQUNmLE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDbkMsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILElBQVcsaUJBQWlCO1FBQzFCLElBQUksSUFBSSxHQUFHLEVBQUUsQ0FBQztRQUVkLEtBQUssSUFBSSxHQUFHLElBQUksSUFBSSxDQUFDLE9BQU8sRUFBRTtZQUM1QixJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1NBQ2hCO1FBQ0QsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0NBRUoiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBmbCBmcm9tICdmYXN0ZXN0LWxldmVuc2h0ZWluJztcclxuaW1wb3J0IHtqYXJvV2lua2xlcn0gZnJvbSAnamFyby13aW5rbGVyLXR5cGVzY3JpcHQnO1xyXG5cclxuaW1wb3J0IHtEaXN0YW5jZU1ldHJpY30gZnJvbSAnLi90eXBlX2RlY2xhcmF0aW9ucyc7XHJcbmltcG9ydCB7YXNzZXJ0fSBmcm9tICcuL29wZXJhdGlvbnMnO1xyXG5cclxuLyoqXHJcbiAqIFVuaWZpZWQgY2xhc3MgaW1wbGVtZW50aW5nIHRoZSBkaWZmZXJlbnQgc3RyaW5nIG1lYXN1cmVzLlxyXG4gKlxyXG4gKiBAZXhwb3J0XHJcbiAqIEBjbGFzcyBNZWFzdXJlclxyXG4gKi9cclxuZXhwb3J0IGNsYXNzIE1lYXN1cmVyIHtcclxuICAgIHByb3RlY3RlZCBtZXRob2Q6IHN0cmluZztcclxuICAgIHByb3RlY3RlZCByZWNlaXB0OiB7W25hbWU6IHN0cmluZ106IERpc3RhbmNlTWV0cmljfSA9IHtcclxuICAgICAgJ0xldmVuc2h0ZWluJzogZmwuZGlzdGFuY2UsXHJcbiAgICAgICdKYXJvLVdpbmtsZXInOiBqYXJvV2lua2xlcixcclxuICAgIH07XHJcblxyXG4gICAgLyoqXHJcbiAgICAgKiBDcmVhdGVzIGFuIGluc3RhbmNlIG9mIE1lYXN1cmVyLlxyXG4gICAgICogQHBhcmFtIHtzdHJpbmd9IG1ldGhvZCBNZXRob2QgdG8gY2FsY3VsYXRlIGRpc3RhbmNlIGJldHdlZW4gc3RyaW5ncy5cclxuICAgICAqIEBtZW1iZXJvZiBNZWFzdXJlclxyXG4gICAgICovXHJcbiAgICBjb25zdHJ1Y3RvcihtZXRob2Q6IHN0cmluZykge1xyXG4gICAgICBhc3NlcnQodGhpcy5hdmFpbGFibGVNZWFzdXJlcy5pbmNsdWRlcyhtZXRob2QpLCAnVGhlICR7bWV0aG9kfSB3YXMgbm90IGZvdW5kLicpXHJcbiAgICAgIHRoaXMubWV0aG9kID0gbWV0aG9kO1xyXG4gICAgfVxyXG5cclxuICAgIC8qKlxyXG4gICAgICogUmV0dXJucyBjdXN0b20gc3RyaW5nIGRpc3RhbmNlIGZ1bmN0aW9uIHNwZWNpZmllZC5cclxuICAgICAqIEByZXR1cm4ge0Rpc3RhbmNlTWV0cmljfSBDYWxsYmFjayBvZiB0aGUgbWVhc3VyZSBjaG9zZW4uXHJcbiAgICAgKi9cclxuICAgIHB1YmxpYyBnZXRNZWFzdXJlKCk6IERpc3RhbmNlTWV0cmljIHtcclxuICAgICAgcmV0dXJuIHRoaXMucmVjZWlwdFt0aGlzLm1ldGhvZF07XHJcbiAgICB9XHJcblxyXG4gICAgLyoqXHJcbiAgICAgKiBSZXR1cm5zIGF2YWlsYWJsZSBzdHJpbmcgZGlzdGFuY2UgbWV0cmljcy5cclxuICAgICAqXHJcbiAgICAgKiBAcmVhZG9ubHlcclxuICAgICAqIEB0eXBlIHtzdHJpbmdbXX1cclxuICAgICAqIEBtZW1iZXJvZiBNZWFzdXJlclxyXG4gICAgICovXHJcbiAgICBwdWJsaWMgZ2V0IGF2YWlsYWJsZU1lYXN1cmVzKCkgOiBzdHJpbmdbXSB7XHJcbiAgICAgIGxldCBrZXlzID0gW107XHJcblxyXG4gICAgICBmb3IgKGxldCBrZXkgaW4gdGhpcy5yZWNlaXB0KSB7XHJcbiAgICAgICAga2V5cy5wdXNoKGtleSk7XHJcbiAgICAgIH1cclxuICAgICAgcmV0dXJuIGtleXM7XHJcbiAgICB9XHJcbiAgICBcclxufVxyXG4iXX0=

package/src/string-measure.ts

@@ -0,0 +1,54 @@
+import * as fl from 'fastest-levenshtein';
+import {jaroWinkler} from 'jaro-winkler-typescript';
+
+import {DistanceMetric} from './type_declarations';
+import {assert} from './operations';
+
+/**
+ * Unified class implementing the different string measures.
+ *
+ * @export
+ * @class Measurer
+ */
+export class Measurer {
+    protected method: string;
+    protected receipt: {[name: string]: DistanceMetric} = {
+      'Levenshtein': fl.distance,
+      'Jaro-Winkler': jaroWinkler,
+    };
+
+    /**
+     * Creates an instance of Measurer.
+     * @param {string} method Method to calculate distance between strings.
+     * @memberof Measurer
+     */
+    constructor(method: string) {
+      assert(this.availableMeasures.includes(method), 'The ${method} was not found.')
+      this.method = method;
+    }
+
+    /**
+     * Returns custom string distance function specified.
+     * @return {DistanceMetric} Callback of the measure chosen.
+     */
+    public getMeasure(): DistanceMetric {
+      return this.receipt[this.method];
+    }
+
+    /**
+     * Returns available string distance metrics.
+     *
+     * @readonly
+     * @type {string[]}
+     * @memberof Measurer
+     */
+    public get availableMeasures() : string[] {
+      let keys = [];
+
+      for (let key in this.receipt) {
+        keys.push(key);
+      }
+      return keys;
+    }
+    
+}

package/src/string-utils.js

@@ -0,0 +1,9 @@
+export function tryParseJson(s) {
+    try {
+        return JSON.parse(s);
+    }
+    catch (_) {
+        return null;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RyaW5nLXV0aWxzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsic3RyaW5nLXV0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE1BQU0sVUFBVSxZQUFZLENBQUMsQ0FBUztJQUNsQyxJQUFJO1FBQ0EsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO0tBQ3hCO0lBQ0QsT0FBTyxDQUFDLEVBQUU7UUFDTixPQUFPLElBQUksQ0FBQztLQUNmO0FBQ0wsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBmdW5jdGlvbiB0cnlQYXJzZUpzb24oczogc3RyaW5nKSA6IGFueSB7XHJcbiAgICB0cnkge1xyXG4gICAgICAgIHJldHVybiBKU09OLnBhcnNlKHMpO1xyXG4gICAgfVxyXG4gICAgY2F0Y2ggKF8pIHtcclxuICAgICAgICByZXR1cm4gbnVsbDtcclxuICAgIH1cclxufSJdfQ==

package/src/string-utils.ts

@@ -0,0 +1,8 @@
+export function tryParseJson(s: string) : any {
+    try {
+        return JSON.parse(s);
+    }
+    catch (_) {
+        return null;
+    }
+}

package/src/table-validation.js

@@ -0,0 +1,47 @@
+import * as DG from "datagrok-api/dg";
+// @ts-ignore
+let ruleSet = {
+    name: 'SDTM DM rules',
+    rules: [
+        {
+            column: 'age',
+            type: 'int',
+            pattern: '18-90'
+        },
+        {
+            column: 'height',
+            type: 'numerical',
+            pattern: '18-90'
+        },
+        {
+            column: 'sex',
+            type: 'string',
+            pattern: 'in (F, M)'
+        },
+        {
+            column: 'started',
+            type: 'datetime',
+            pattern: '> 1/1/1900'
+        }
+    ]
+};
+/** Returns error message, or null if valid. */
+function validateCell(cell, ruleset) {
+    var _a;
+    let name = cell.column.name.toLowerCase();
+    for (let rule of ruleset.rules)
+        if (rule.column == name) {
+            rule.matcher = (_a = rule.matcher) !== null && _a !== void 0 ? _a : DG.ValueMatcher.forColumn(cell.column, rule.pattern);
+            let error = rule.matcher.validate(cell.value);
+            if (error !== null)
+                return error;
+        }
+    return null;
+}
+function main() {
+    console.log('foo');
+}
+let cell = { column: { name: 'age' }, value: 999 };
+validateCell(cell, ruleSet);
+console.log('ddd');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFibGUtdmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRhYmxlLXZhbGlkYXRpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBR0EsT0FBTyxLQUFLLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQWN0QyxhQUFhO0FBQ2IsSUFBSSxPQUFPLEdBQVk7SUFDckIsSUFBSSxFQUFFLGVBQWU7SUFDckIsS0FBSyxFQUFFO1FBQ0w7WUFDRSxNQUFNLEVBQUUsS0FBSztZQUNiLElBQUksRUFBRSxLQUFLO1lBQ1gsT0FBTyxFQUFFLE9BQU87U0FDakI7UUFDRDtZQUNFLE1BQU0sRUFBRSxRQUFRO1lBQ2hCLElBQUksRUFBRSxXQUFXO1lBQ2pCLE9BQU8sRUFBRSxPQUFPO1NBQ2pCO1FBQ0Q7WUFDRSxNQUFNLEVBQUUsS0FBSztZQUNiLElBQUksRUFBRSxRQUFRO1lBQ2QsT0FBTyxFQUFFLFdBQVc7U0FDckI7UUFDRDtZQUNFLE1BQU0sRUFBRSxTQUFTO1lBQ2pCLElBQUksRUFBRSxVQUFVO1lBQ2hCLE9BQU8sRUFBRSxZQUFZO1NBQ3RCO0tBQ0Y7Q0FDRixDQUFDO0FBRUYsK0NBQStDO0FBQy9DLFNBQVMsWUFBWSxDQUFDLElBQVMsRUFBRSxPQUFnQjs7SUFDL0MsSUFBSSxJQUFJLEdBQUcsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLENBQUM7SUFFMUMsS0FBSyxJQUFJLElBQUksSUFBSSxPQUFPLENBQUMsS0FBSztRQUM1QixJQUFJLElBQUksQ0FBQyxNQUFNLElBQUksSUFBSSxFQUFFO1lBQ3ZCLElBQUksQ0FBQyxPQUFPLFNBQUcsSUFBSSxDQUFDLE9BQU8sbUNBQUksRUFBRSxDQUFDLFlBQVksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDcEYsSUFBSSxLQUFLLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO1lBQzlDLElBQUksS0FBSyxLQUFLLElBQUk7Z0JBQ2hCLE9BQU8sS0FBSyxDQUFDO1NBQ2hCO0lBRUgsT0FBTyxJQUFJLENBQUM7QUFDZCxDQUFDO0FBRUQsU0FBUyxJQUFJO0lBQ1gsT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsQ0FBQztBQUNyQixDQUFDO0FBRUQsSUFBSSxJQUFJLEdBQUcsRUFBQyxNQUFNLEVBQUUsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLEVBQUUsS0FBSyxFQUFFLEdBQUcsRUFBRSxDQUFDO0FBQ2xELFlBQVksQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7QUFFNUIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qIERvIG5vdCBjaGFuZ2UgdGhlc2UgaW1wb3J0IGxpbmVzLiBEYXRhZ3JvayB3aWxsIGltcG9ydCBBUEkgbGlicmFyeSBpbiBleGFjdGx5IHRoZSBzYW1lIG1hbm5lciAqL1xyXG5pbXBvcnQgKiBhcyBncm9rIGZyb20gJ2RhdGFncm9rLWFwaS9ncm9rJztcclxuaW1wb3J0ICogYXMgdWkgZnJvbSAnZGF0YWdyb2stYXBpL3VpJztcclxuaW1wb3J0ICogYXMgREcgZnJvbSBcImRhdGFncm9rLWFwaS9kZ1wiO1xyXG5cclxuaW50ZXJmYWNlIFJ1bGUge1xyXG4gIGNvbHVtbjogc3RyaW5nO1xyXG4gIHR5cGU6IHN0cmluZztcclxuICBwYXR0ZXJuOiBzdHJpbmc7XHJcbiAgbWF0Y2hlcj86IGFueTtcclxufVxyXG5cclxuaW50ZXJmYWNlIFJ1bGVTZXQge1xyXG4gIG5hbWU6IHN0cmluZztcclxuICBydWxlczogUnVsZVtdO1xyXG59XHJcblxyXG4vLyBAdHMtaWdub3JlXHJcbmxldCBydWxlU2V0OiBSdWxlU2V0ID0ge1xyXG4gIG5hbWU6ICdTRFRNIERNIHJ1bGVzJyxcclxuICBydWxlczogW1xyXG4gICAge1xyXG4gICAgICBjb2x1bW46ICdhZ2UnLFxyXG4gICAgICB0eXBlOiAnaW50JyxcclxuICAgICAgcGF0dGVybjogJzE4LTkwJ1xyXG4gICAgfSxcclxuICAgIHtcclxuICAgICAgY29sdW1uOiAnaGVpZ2h0JyxcclxuICAgICAgdHlwZTogJ251bWVyaWNhbCcsXHJcbiAgICAgIHBhdHRlcm46ICcxOC05MCdcclxuICAgIH0sXHJcbiAgICB7XHJcbiAgICAgIGNvbHVtbjogJ3NleCcsXHJcbiAgICAgIHR5cGU6ICdzdHJpbmcnLFxyXG4gICAgICBwYXR0ZXJuOiAnaW4gKEYsIE0pJ1xyXG4gICAgfSxcclxuICAgIHtcclxuICAgICAgY29sdW1uOiAnc3RhcnRlZCcsXHJcbiAgICAgIHR5cGU6ICdkYXRldGltZScsXHJcbiAgICAgIHBhdHRlcm46ICc+IDEvMS8xOTAwJ1xyXG4gICAgfVxyXG4gIF1cclxufTtcclxuXHJcbi8qKiBSZXR1cm5zIGVycm9yIG1lc3NhZ2UsIG9yIG51bGwgaWYgdmFsaWQuICovXHJcbmZ1bmN0aW9uIHZhbGlkYXRlQ2VsbChjZWxsOiBhbnksIHJ1bGVzZXQ6IFJ1bGVTZXQpIDogc3RyaW5nIHwgbnVsbCB7XHJcbiAgbGV0IG5hbWUgPSBjZWxsLmNvbHVtbi5uYW1lLnRvTG93ZXJDYXNlKCk7XHJcblxyXG4gIGZvciAobGV0IHJ1bGUgb2YgcnVsZXNldC5ydWxlcylcclxuICAgIGlmIChydWxlLmNvbHVtbiA9PSBuYW1lKSB7XHJcbiAgICAgIHJ1bGUubWF0Y2hlciA9IHJ1bGUubWF0Y2hlciA/PyBERy5WYWx1ZU1hdGNoZXIuZm9yQ29sdW1uKGNlbGwuY29sdW1uLCBydWxlLnBhdHRlcm4pO1xyXG4gICAgICBsZXQgZXJyb3IgPSBydWxlLm1hdGNoZXIudmFsaWRhdGUoY2VsbC52YWx1ZSk7XHJcbiAgICAgIGlmIChlcnJvciAhPT0gbnVsbClcclxuICAgICAgICByZXR1cm4gZXJyb3I7XHJcbiAgICB9XHJcblxyXG4gIHJldHVybiBudWxsO1xyXG59XHJcblxyXG5mdW5jdGlvbiBtYWluKCkgOiB2b2lkIHtcclxuICBjb25zb2xlLmxvZygnZm9vJyk7XHJcbn1cclxuXHJcbmxldCBjZWxsID0ge2NvbHVtbjogeyBuYW1lOiAnYWdlJyB9LCB2YWx1ZTogOTk5IH07XHJcbnZhbGlkYXRlQ2VsbChjZWxsLCBydWxlU2V0KTtcclxuXHJcbmNvbnNvbGUubG9nKCdkZGQnKTsiXX0=

package/src/table-validation.ts

@@ -0,0 +1,67 @@
+/* Do not change these import lines. Datagrok will import API library in exactly the same manner */
+import * as grok from 'datagrok-api/grok';
+import * as ui from 'datagrok-api/ui';
+import * as DG from "datagrok-api/dg";
+
+interface Rule {
+  column: string;
+  type: string;
+  pattern: string;
+  matcher?: any;
+}
+
+interface RuleSet {
+  name: string;
+  rules: Rule[];
+}
+
+// @ts-ignore
+let ruleSet: RuleSet = {
+  name: 'SDTM DM rules',
+  rules: [
+    {
+      column: 'age',
+      type: 'int',
+      pattern: '18-90'
+    },
+    {
+      column: 'height',
+      type: 'numerical',
+      pattern: '18-90'
+    },
+    {
+      column: 'sex',
+      type: 'string',
+      pattern: 'in (F, M)'
+    },
+    {
+      column: 'started',
+      type: 'datetime',
+      pattern: '> 1/1/1900'
+    }
+  ]
+};
+
+/** Returns error message, or null if valid. */
+function validateCell(cell: any, ruleset: RuleSet) : string | null {
+  let name = cell.column.name.toLowerCase();
+
+  for (let rule of ruleset.rules)
+    if (rule.column == name) {
+      rule.matcher = rule.matcher ?? DG.ValueMatcher.forColumn(cell.column, rule.pattern);
+      let error = rule.matcher.validate(cell.value);
+      if (error !== null)
+        return error;
+    }
+
+  return null;
+}
+
+function main() : void {
+  console.log('foo');
+}
+
+let cell = {column: { name: 'age' }, value: 999 };
+validateCell(cell, ruleSet);
+
+console.log('ddd');