Alternatively, install the 'string-comparisons' package using yarn

Or, install the 'string-comparisons' package using pnpm

Docs

String Similarity Algorithm Comparison

| Algorithm | Normalized | Metric | Similarity | Distance | Space Complexity |
|------------------------|------------|-----------------------------------------|------------|----------|------------------|
| cosine.js | Yes | Vector Space Model | ✓ | | O(n) |
| jaro.js | No | Edit Distance | ✓ | | O(min(n, m)) |
| jaccard.js | No | Set Theory | ✓ | | O(min(n, m)) |
| damerauLevenshtein.js | No | Edit Distance | | ✓ | O(max(n, m)²) |
| hammingDistance.js | No | Bitwise Operations | ✓ | | O(1) |
| jaroWinkler.js | No | Edit Distance | ✓ | | O(min(n, m)) |
| levenshtein.js | No | Edit Distance | | ✓ | O(max(n, m)²) |
| smithWaterman.js | No | Dynamic Programming (Local Alignment) | ✓ | | O(n * m) |
| sorensenDice.js | No | Set Theory | ✓ | | O(min(n, m)) |
| trigram.js | No | N-gram Overlap | ✓ | | O(n²) |
| szymkiewiczSimpsonOverlap.js | Yes | Overlap Coefficient | ✓ | | O(min(m, n)) |
| nGram.js | Yes | Jaccard similarity coefficient | ✓ | | O(m * n) |
| qGram.js | Yes | Jaccard similarity coefficient | ✓ | | O(n + m) |
| optimalStringAlignment.js | No | Edit distance | | ✓ | O(max(n, m)²) |

Explanation of Columns:

- Normalized: Indicates whether the algorithm produces a score between 0 and 1 (normalized).
- Metric: The underlying mathematical concept used for comparison.
- Similarity: Whether the algorithm outputs a higher score for more similar strings.
- Distance: Whether the algorithm outputs a lower score for more similar strings. (One algorithm might use similarity, another distance - they provide the opposite information).
- Space Complexity: The amount of extra memory the algorithm needs to run the comparison.

Notes:

- ✓ indicates the algorithm applies to that category.
- Some algorithms can be used for both similarity and distance calculations depending on the interpretation of the score.

Example Usage