https://github.com/robertknight/approx-string-match-js
Fast approximate string matching library for JavaScript
https://github.com/robertknight/approx-string-match-js
algorithms javascript
Last synced: 4 months ago
JSON representation
Fast approximate string matching library for JavaScript
- Host: GitHub
- URL: https://github.com/robertknight/approx-string-match-js
- Owner: robertknight
- License: mit
- Created: 2017-06-19T10:55:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T13:24:57.000Z (11 months ago)
- Last Synced: 2024-12-28T16:29:08.721Z (4 months ago)
- Topics: algorithms, javascript
- Language: TypeScript
- Homepage:
- Size: 126 KB
- Stars: 50
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# approx-string-match
A library for approximate string matching.
This can be used to find occurrences of a pattern P (of length _m_) in a text T
(of length _n_) allowing for up to a given number of errors (_k_), where errors may
include insertions, substitutions or deletions of characters from the pattern.
For example the pattern "annd" occurs in the string "four score and seven" with
one error.
The implementation uses a bit-parallel algorithm by G. Myers [1] which, to the
best of my knowledge, is the state of the art algorithm for the online version
of the problem (where the text and pattern cannot be preprocessed in advance).
It runs in _O((k/w) \* n)_ expected-time where _k_ <= _m_ and _w_ is the word
size (32 in JavaScript). It also includes some additional optimizations
suggested in [3]. See comments in the code for more details.
## Usage
```
npm install --save approx-string-match
```
```js
import search from "approx-string-match";
const text = "Four score and seven";
const pattern = "annd";
const matches = search(text, pattern, 2 /* max errors */);
console.log(matches);
// Outputs `[{ start: 11, end: 14, errors: 1 }]`
```
## API
The library exports a single function `search(text, pattern, maxErrors)` which
returns an array of the closest matches for _pattern_ in _text_ allowing up to
_maxErrors_ errors.
```ts
interface Match {
start: number;
end: number;
errors: number;
}
search(text: string, pattern: string, maxErrors: number): Match[]
```
## Implementation notes
#### Word size
The algorithm uses bitwise operations on integers. Since JavaScript only
supports bitwise operations on 32-bit integers, that is the word size,
regardless of the platform.
If JS gains support for bitwise operations on larger integers in future, that
support could be used to speed up this library.
#### Unicode
The library currently works on _code units_ rather than _code points_, where the
code unit is a UTF-16 value. What this means is that a change to a unicode
character which requires multiple characters to represent in a JavaScript
string, such as emoji, would actually count as two changes rather than one. This
is because such chars require two elements to represent in a string (eg.
`"😊".length` is 2).
## Related reading
For an overview of the different approaches to approximate string matching and
the history of the development of solutions, there is a good survey paper [2].
## References
[1] G. Myers, “[A Fast Bit-Vector Algorithm for Approximate String Matching Based on
Dynamic
Programming](https://scholar.google.com/scholar?q=A+Fast+Bit-Vector+Algorithm+for+Approximate+String+Matching+Based+on+Dynamic+Programming),”
vol. 46, no. 3, pp. 395–415, 1999.
[2] G. Navarro, “[A guided tour to approximate string
matching](https://scholar.google.com/scholar?q=A+guided+tour+to+approximate+string+matching),”
ACM Comput. Surv., vol. 33, no. 1, pp. 31–88, 2001.
[3] Šošić, M. (2014). "[An SIMD dynamic programming c/c++ library](https://bib.irb.hr/datoteka/758607.diplomski_Martin_Sosic.pdf)" (Doctoral dissertation, Fakultet Elektrotehnike i računarstva, Sveučilište u Zagrebu).