cmpstr 3.2.1 → 3.3.0

package/dist/cjs/CmpStrAsync.cjs

@@ -1,6 +1,7 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
+var Errors = require('./utils/Errors.cjs');
 var Filter = require('./utils/Filter.cjs');
 var Normalizer = require('./utils/Normalizer.cjs');
 var Registry = require('./utils/Registry.cjs');
@@ -45,27 +46,33 @@ class CmpStrAsync extends CmpStr.CmpStr {
   async computeAsync(a, b, opt, mode, raw, skip) {
     const resolved = this.resolveOptions(opt);
     this.assert('metric', resolved.metric);
-    const A = skip ? a : await this.prepareAsync(a, resolved);
-    const B = skip ? b : await this.prepareAsync(b, resolved);
-    if (
-      resolved.safeEmpty &&
-      ((Array.isArray(A) && A.length === 0) ||
-        (Array.isArray(B) && B.length === 0) ||
-        A === '' ||
-        B === '')
-    ) {
-      return [];
-    }
-    const metric = Registry.factory['metric'](
-      resolved.metric,
-      A,
-      B,
-      resolved.opt
+    return Errors.ErrorUtil.wrapAsync(
+      async () => {
+        const A = skip ? a : await this.prepareAsync(a, resolved);
+        const B = skip ? b : await this.prepareAsync(b, resolved);
+        if (
+          resolved.safeEmpty &&
+          ((Array.isArray(A) && A.length === 0) ||
+            (Array.isArray(B) && B.length === 0) ||
+            A === '' ||
+            B === '')
+        ) {
+          return [];
+        }
+        const metric = Registry.factory['metric'](
+          resolved.metric,
+          A,
+          B,
+          resolved.opt
+        );
+        if (resolved.output !== 'prep') metric.setOriginal(a, b);
+        await metric.runAsync(mode);
+        const result = this.postProcess(metric.getResults(), resolved);
+        return this.output(result, raw ?? resolved.raw);
+      },
+      `Failed to compute metric <${opt?.metric ?? this.options.metric}> for the given inputs`,
+      { a, b, opt }
     );
-    if (resolved.output !== 'prep') metric.setOriginal(a, b);
-    await metric.runAsync(mode);
-    const result = this.postProcess(metric.getResults(), resolved);
-    return this.output(result, raw ?? resolved.raw);
   }
   async testAsync(a, b, opt) {
     return this.computeAsync(a, b, opt, 'single');
@@ -103,23 +110,40 @@ class CmpStrAsync extends CmpStr.CmpStr {
     const resolved = this.resolveOptions({ flags, processors });
     const test = await this.prepareAsync(needle, resolved);
     const hstk = await this.prepareAsync(haystack, resolved);
-    return haystack.filter((_, i) => hstk[i].includes(test));
+    const out = [];
+    for (let i = 0; i < hstk.length; i++) {
+      if (hstk[i].includes(test)) out.push(haystack[i]);
+    }
+    return out;
   }
   async matrixAsync(input, opt) {
-    input = await this.prepareAsync(input, this.resolveOptions(opt));
-    return Promise.all(
-      input.map(
-        async (a) =>
-          await this.computeAsync(
-            a,
-            input,
-            undefined,
-            'batch',
-            true,
-            true
-          ).then((r) => r.map((b) => b.res ?? 0))
-      )
-    );
+    const resolved = this.resolveOptions(opt);
+    const arr = await this.prepareAsync(input, resolved);
+    const n = arr.length;
+    const out = Array.from({ length: n }, () => new Array(n).fill(0));
+    for (let i = 0; i < n; i++) {
+      await Promise.all(
+        Array.from({ length: n - i }, (_, k) => i + k).map(async (j) => {
+          if (i === j) {
+            out[i][j] = 1;
+          } else {
+            const score = (
+              await this.computeAsync(
+                arr[i],
+                arr[j],
+                resolved,
+                'single',
+                true,
+                true
+              )
+            ).res;
+            out[i][j] = score;
+            out[j][i] = score;
+          }
+        })
+      );
+    }
+    return out;
   }
   async phoneticIndexAsync(input, algo, opt) {
     const { algo: a, opt: o } = this.options.processors?.phonetic ?? {};
@@ -165,4 +189,3 @@ class CmpStrAsync extends CmpStr.CmpStr {
 }
 
 exports.CmpStrAsync = CmpStrAsync;
-//# sourceMappingURL=CmpStrAsync.cjs.map

package/dist/cjs/index.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var CmpStr = require('./CmpStr.cjs');
@@ -12,4 +12,3 @@ exports.CmpStrAsync = CmpStrAsync.CmpStrAsync;
 exports.DiffChecker = DiffChecker.DiffChecker;
 exports.Normalizer = Normalizer.Normalizer;
 exports.TextAnalyzer = TextAnalyzer.TextAnalyzer;
-//# sourceMappingURL=index.cjs.map

package/dist/cjs/metric/Cosine.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -43,4 +43,3 @@ class CosineSimilarity extends Metric.Metric {
 Metric.MetricRegistry.add('cosine', CosineSimilarity);
 
 exports.CosineSimilarity = CosineSimilarity;
-//# sourceMappingURL=Cosine.cjs.map

package/dist/cjs/metric/DamerauLevenshtein.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -47,4 +47,3 @@ class DamerauLevenshteinDistance extends Metric.Metric {
 Metric.MetricRegistry.add('damerau', DamerauLevenshteinDistance);
 
 exports.DamerauLevenshteinDistance = DamerauLevenshteinDistance;
-//# sourceMappingURL=DamerauLevenshtein.cjs.map

package/dist/cjs/metric/DiceSorensen.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -36,4 +36,3 @@ class DiceSorensenCoefficient extends Metric.Metric {
 Metric.MetricRegistry.add('dice', DiceSorensenCoefficient);
 
 exports.DiceSorensenCoefficient = DiceSorensenCoefficient;
-//# sourceMappingURL=DiceSorensen.cjs.map

package/dist/cjs/metric/Hamming.cjs

@@ -1,7 +1,8 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Metric = require('./Metric.cjs');
+var Errors = require('../utils/Errors.cjs');
 
 class HammingDistance extends Metric.Metric {
   constructor(a, b, opt = {}) {
@@ -14,9 +15,10 @@ class HammingDistance extends Metric.Metric {
         if (n < maxLen) b = b.padEnd(maxLen, this.options.pad);
         m = n = maxLen;
       } else
-        throw new Error(
+        throw new Errors.CmpStrUsageError(
           `Strings must be of equal length for Hamming Distance, a=${m} and b=${n} given, ` +
-            `use option.pad for automatic adjustment`
+            `use option.pad for automatic adjustment`,
+          { a: m, b: n }
         );
     }
     let dist = 0;
@@ -30,4 +32,3 @@ class HammingDistance extends Metric.Metric {
 Metric.MetricRegistry.add('hamming', HammingDistance);
 
 exports.HammingDistance = HammingDistance;
-//# sourceMappingURL=Hamming.cjs.map

package/dist/cjs/metric/Jaccard.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -29,4 +29,3 @@ class JaccardIndex extends Metric.Metric {
 Metric.MetricRegistry.add('jaccard', JaccardIndex);
 
 exports.JaccardIndex = JaccardIndex;
-//# sourceMappingURL=Jaccard.cjs.map

package/dist/cjs/metric/JaroWinkler.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -61,4 +61,3 @@ class JaroWinklerDistance extends Metric.Metric {
 Metric.MetricRegistry.add('jaroWinkler', JaroWinklerDistance);
 
 exports.JaroWinklerDistance = JaroWinklerDistance;
-//# sourceMappingURL=JaroWinkler.cjs.map

package/dist/cjs/metric/LCS.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -36,4 +36,3 @@ class LCSMetric extends Metric.Metric {
 Metric.MetricRegistry.add('lcs', LCSMetric);
 
 exports.LCSMetric = LCSMetric;
-//# sourceMappingURL=LCS.cjs.map

package/dist/cjs/metric/Levenshtein.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -36,4 +36,3 @@ class LevenshteinDistance extends Metric.Metric {
 Metric.MetricRegistry.add('levenshtein', LevenshteinDistance);
 
 exports.LevenshteinDistance = LevenshteinDistance;
-//# sourceMappingURL=Levenshtein.cjs.map

package/dist/cjs/metric/Metric.cjs

@@ -1,6 +1,7 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
+var Errors = require('../utils/Errors.cjs');
 var HashTable = require('../utils/HashTable.cjs');
 var Profiler = require('../utils/Profiler.cjs');
 var Registry = require('../utils/Registry.cjs');
@@ -17,15 +18,24 @@ class Metric {
   optKey;
   symmetric;
   results;
-  static clear = () => this.cache.clear();
-  static swap = (a, b, m, n) => (m > n ? [b, a, n, m] : [a, b, m, n]);
-  static clamp = (res) => Math.max(0, Math.min(1, res));
+  static clear() {
+    this.cache.clear();
+  }
+  static swap(a, b, m, n) {
+    return m > n ? [b, a, n, m] : [a, b, m, n];
+  }
+  static clamp(res) {
+    return Math.max(0, Math.min(1, res));
+  }
   constructor(metric, a, b, opt = {}, symmetric = false) {
     this.metric = metric;
     this.a = Array.isArray(a) ? a : [a];
     this.b = Array.isArray(b) ? b : [b];
-    if (this.a.length === 0 || this.b.length === 0)
-      throw new Error(`Inputs <a> and <b> must not be empty`);
+    Errors.ErrorUtil.assert(
+      this.a.length > 0 && this.b.length > 0,
+      `Inputs <a> and <b> must not be empty`,
+      { a: this.a, b: this.b }
+    );
     this.options = opt;
     this.optKey = HashTable.Hasher.fastFNV1a(
       JSON.stringify(opt, Object.keys(opt).sort())
@@ -38,37 +48,46 @@ class Metric {
     return undefined;
   }
   compute(a, b, m, n, maxLen) {
-    throw new Error(`Method compute() must be overridden in a subclass`);
+    throw new Errors.CmpStrInternalError(
+      `Method compute() must be overridden in a subclass`
+    );
   }
   runSingle(i, j) {
-    let a = String(this.a[i]),
-      A = a;
-    let b = String(this.b[j]),
-      B = b;
-    let m = A.length,
-      n = B.length;
-    let result = this.preCompute(A, B, m, n);
-    if (!result) {
-      result = profiler.run(() => {
-        if (this.symmetric) [A, B, m, n] = Metric.swap(A, B, m, n);
-        const key =
-          Metric.cache.key(this.metric, [A, B], this.symmetric) + this.optKey;
-        return (
-          Metric.cache.get(key || '') ??
-          (() => {
-            const res = this.compute(A, B, m, n, Math.max(m, n));
-            if (key) Metric.cache.set(key, res);
-            return res;
-          })()
-        );
-      });
-    }
-    return {
-      metric: this.metric,
-      a: this.origA[i] ?? a,
-      b: this.origB[j] ?? b,
-      ...result
-    };
+    return Errors.ErrorUtil.wrap(
+      () => {
+        let a = String(this.a[i]),
+          A = a;
+        let b = String(this.b[j]),
+          B = b;
+        let m = A.length,
+          n = B.length;
+        let result = this.preCompute(A, B, m, n);
+        if (!result) {
+          result = profiler.run(() => {
+            if (this.symmetric) [A, B, m, n] = Metric.swap(A, B, m, n);
+            let key = Metric.cache.key(this.metric, [A, B], this.symmetric);
+            if (key) key += this.optKey;
+            return (
+              Metric.cache.get(key || '') ??
+              (() => {
+                const maxLen = m > n ? m : n;
+                const res = this.compute(A, B, m, n, maxLen);
+                if (key) Metric.cache.set(key, res);
+                return res;
+              })()
+            );
+          });
+        }
+        return {
+          metric: this.metric,
+          a: this.origA.length > i ? this.origA[i] : a,
+          b: this.origB.length > j ? this.origB[j] : b,
+          ...result
+        };
+      },
+      `Failed to compute metric for inputs at indices a[${i}] and b[${j}]`,
+      { i, j }
+    );
   }
   async runSingleAsync(i, j) {
     return Promise.resolve(this.runSingle(i, j));
@@ -81,11 +100,11 @@ class Metric {
     this.results = results;
   }
   async runBatchAsync() {
-    const results = [];
+    const tasks = [];
     for (let i = 0; i < this.a.length; i++)
       for (let j = 0; j < this.b.length; j++)
-        results.push(await this.runSingleAsync(i, j));
-    this.results = results;
+        tasks.push(this.runSingleAsync(i, j));
+    this.results = await Promise.all(tasks);
   }
   runPairwise() {
     const results = [];
@@ -93,29 +112,42 @@ class Metric {
     this.results = results;
   }
   async runPairwiseAsync() {
-    const results = [];
+    const tasks = [];
     for (let i = 0; i < this.a.length; i++)
-      results.push(await this.runSingleAsync(i, i));
-    this.results = results;
+      tasks.push(this.runSingleAsync(i, i));
+    this.results = await Promise.all(tasks);
   }
   setOriginal(a, b) {
     if (a) this.origA = Array.isArray(a) ? a : [a];
     if (b) this.origB = Array.isArray(b) ? b : [b];
     return this;
   }
-  isBatch = () => this.a.length > 1 || this.b.length > 1;
-  isSingle = () => !this.isBatch();
+  isBatch() {
+    return this.a.length > 1 || this.b.length > 1;
+  }
+  isSingle() {
+    return !this.isBatch();
+  }
   isPairwise(safe = false) {
     return this.isBatch() && this.a.length === this.b.length
       ? true
       : !safe &&
           (() => {
-            throw new Error(`Mode <pairwise> requires arrays of equal length`);
+            throw new Errors.CmpStrUsageError(
+              `Mode <pairwise> requires arrays of equal length`,
+              { a: this.a, b: this.b }
+            );
           })();
   }
-  isSymmetrical = () => this.symmetric;
-  whichMode = (mode) => mode ?? this.options?.mode ?? 'default';
-  clear = () => (this.results = undefined);
+  isSymmetrical() {
+    return this.symmetric;
+  }
+  whichMode(mode) {
+    return mode ?? this.options.mode ?? 'default';
+  }
+  clear() {
+    this.results = undefined;
+  }
   run(mode, clear = true) {
     if (clear) this.clear();
     switch (this.whichMode(mode)) {
@@ -134,7 +166,7 @@ class Metric {
         if (this.isPairwise()) this.runPairwise();
         break;
       default:
-        throw new Error(`Unsupported mode <${mode}>`);
+        throw new Errors.CmpStrInternalError(`Unsupported mode <${mode}>`);
     }
   }
   async runAsync(mode, clear = true) {
@@ -155,13 +187,19 @@ class Metric {
         if (this.isPairwise()) await this.runPairwiseAsync();
         break;
       default:
-        throw new Error(`Unsupported async mode <${mode}>`);
+        throw new Errors.CmpStrInternalError(
+          `Unsupported async mode <${mode}>`
+        );
     }
   }
-  getMetricName = () => this.metric;
+  getMetricName() {
+    return this.metric;
+  }
   getResults() {
-    if (this.results === undefined)
-      throw new Error(`run() must be called before getResult()`);
+    Errors.ErrorUtil.assert(
+      this.results !== undefined,
+      `run() must be called before getResults()`
+    );
     return this.results;
   }
 }
@@ -169,4 +207,3 @@ const MetricRegistry = Registry.Registry('metric', Metric);
 
 exports.Metric = Metric;
 exports.MetricRegistry = MetricRegistry;
-//# sourceMappingURL=Metric.cjs.map

package/dist/cjs/metric/NeedlemanWunsch.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -43,4 +43,3 @@ class NeedlemanWunschDistance extends Metric.Metric {
 Metric.MetricRegistry.add('needlemanWunsch', NeedlemanWunschDistance);
 
 exports.NeedlemanWunschDistance = NeedlemanWunschDistance;
-//# sourceMappingURL=NeedlemanWunsch.cjs.map

package/dist/cjs/metric/QGram.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -37,4 +37,3 @@ class QGramSimilarity extends Metric.Metric {
 Metric.MetricRegistry.add('qGram', QGramSimilarity);
 
 exports.QGramSimilarity = QGramSimilarity;
-//# sourceMappingURL=QGram.cjs.map

package/dist/cjs/metric/SmithWaterman.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Pool = require('../utils/Pool.cjs');
@@ -44,4 +44,3 @@ class SmithWatermanDistance extends Metric.Metric {
 Metric.MetricRegistry.add('smithWaterman', SmithWatermanDistance);
 
 exports.SmithWatermanDistance = SmithWatermanDistance;
-//# sourceMappingURL=SmithWaterman.cjs.map

package/dist/cjs/phonetic/Caverphone.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Phonetic = require('./Phonetic.cjs');
@@ -116,4 +116,3 @@ Phonetic.PhoneticMappingRegistry.add('caverphone', 'en2', {
 });
 
 exports.Caverphone = Caverphone;
-//# sourceMappingURL=Caverphone.cjs.map

package/dist/cjs/phonetic/Cologne.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Phonetic = require('./Phonetic.cjs');
@@ -67,4 +67,3 @@ Phonetic.PhoneticMappingRegistry.add('cologne', 'default', {
 });
 
 exports.Cologne = Cologne;
-//# sourceMappingURL=Cologne.cjs.map

package/dist/cjs/phonetic/Metaphone.cjs

@@ -1,4 +1,4 @@
-// CmpStr v3.2.1 build-3439ccb-260130 by Paul Köhler @komed3 / MIT License
+// CmpStr v3.3.0 build-3699f85-260318 by Paul Köhler @komed3 / MIT License
 'use strict';
 
 var Phonetic = require('./Phonetic.cjs');
@@ -97,4 +97,3 @@ Phonetic.PhoneticMappingRegistry.add('metaphone', 'en90', {
 });
 
 exports.Metaphone = Metaphone;
-//# sourceMappingURL=Metaphone.cjs.map