https://github.com/sumn2u/string-comparisons
A collection of string comparisons algorithms
https://github.com/sumn2u/string-comparisons
algorithms cosine-similarity damerau-levenshtein distance hamming-distance jaccard-similarity jaro-winkler-distance javascript levenshtein-distance similarity-measures smith-waterman sorensen-dice-distance string-comparison string-distance trigrams
Last synced: 7 months ago
JSON representation
A collection of string comparisons algorithms
- Host: GitHub
- URL: https://github.com/sumn2u/string-comparisons
- Owner: sumn2u
- License: mit
- Created: 2019-03-02T08:10:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T20:13:50.000Z (over 1 year ago)
- Last Synced: 2025-03-17T10:54:32.573Z (7 months ago)
- Topics: algorithms, cosine-similarity, damerau-levenshtein, distance, hamming-distance, jaccard-similarity, jaro-winkler-distance, javascript, levenshtein-distance, similarity-measures, smith-waterman, sorensen-dice-distance, string-comparison, string-distance, trigrams
- Language: JavaScript
- Homepage: https://sumn2u.github.io/string-comparisons/
- Size: 700 KB
- Stars: 14
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# String Comparisons
[](https://github.com/sumn2u/string-comparisons/stargazers)
[](https://github.com/sumn2u/string-comparisons/blob/master/LICENCE)
This library offers a range of functions to calculate text similarity, allowing you to measure the likeness of text data in an application. It implements well-established similarity metrics. The library currently supports the following algorithms:
- **Cosine Similarity**
- **Jaccard Similarity**
- **Jaro Similarity**
- **Damerau-Levenshtein Distance**
- **Hamming Distance**
- **Levenshtein Distance**
- **Smith-Waterman Alignment**
- **Sørensen-Dice Coefficient**
- **Jaccard Similarity based on Trigrams**
- **Szymkiewicz Simpson Overlap**
- **N-Gram**
- **Q-Gram**
- **Optimal String Alignment**
## Installation
Assuming you have [Node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com)/[yarn](https://yarnpkg.com)/[pnpm](https://pnpm.io/) installed, install the library using:
```bash
# Install the 'string-comparisons' package using npm
npm install string-comparisons
# Alternatively, install the 'string-comparisons' package using yarn
yarn add string-comparisons
# Or, install the 'string-comparisons' package using pnpm
pnpm add string-comparisons
```
## Docs
Find more information on the algorithms by accessing the [class documentation](https://sumn2u.github.io/string-comparisons) of each implemented [algorithm](algorithms.md).
## 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
```javascript
import StringComparisons from 'string-comparisons';
const { Cosine, Jaccard, Jaro, DamerauLevenshtein, HammingDistance, JaroWrinker, Levenshtein, SmithWaterman, SorensenDice, Trigram } = StringComparisons;
const string1 = 'programming';
const string2 = 'programmer';
console.log('Jaro-Winkler similarity:', JaroWrinker.similarity(string1, string2)); // Output: ~0.9054545454545454
console.log('Levenshtein distance:', Levenshtein.similarity(string1, string2)); // Output: 3
console.log('Smith-Waterman similarity:', SmithWaterman.similarity(string1, string2)); // Output: 16
const set1 = new Set([1, 2, 3]);
const set2 = new Set([2, 3, 4]);
console.log('Sørensen-Dice similarity:', SorensenDice.similarity(set1, set2)); // Output: 0.6666666666666667
const trigram1 = 'hello';
const trigram2 = 'world';
console.log('Trigram Jaccard similarity:', Trigram.similarity(trigram1, trigram2)); // Output: 0 (no shared trigrams)
// so on
```
## Contributing
We encourage contributions to this library! Feel free to fork the repository, make your changes, and submit pull requests.
If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us get visibility and allow the community to grow. 🙏
## Contact Us
If you have any questions or feedback, please don't hesitate to contact us at sumn2u@gmail.com, or reach out to Suman directly. We hope you find this resource helpful 💜.
## License Information
This project is licensed under the [MIT](./LICENSE) , which means that you are free to use, modify, and distribute the code as long as you comply with the terms of the license.
## Resources
- [String Similarity Comparison in JS with Examples](https://sumn2u.medium.com/string-similarity-comparision-in-js-with-examples-4bae35f13968)
- [Cosine similarity between two sentences](https://sumn2u.medium.com/cosine-similarity-between-two-sentences-8f6630b0ebb7)
- [The complete guide to string similarity algorithms](https://yassineelkhal.medium.com/the-complete-guide-to-string-similarity-algorithms-1290ad07c6b7)
- [N-Gram Similarity and Distance](https://webdocs.cs.ualberta.ca/~kondrak/papers/spire05.pdf)
- [Approximate string-matching with q-grams and maximal matches](https://www.sciencedirect.com/science/article/pii/0304397592901434)
- [Research on string similarity algorithm based on Levenshtein Distance](https://ieeexplore.ieee.org/document/8054419)
- [String similarity search and join: a survey](https://link.springer.com/article/10.1007/s11704-015-5900-5)