Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/febeling/edit-distance
Levenshtein edit distance in Rust
https://github.com/febeling/edit-distance
algorithm levenshtein-distance rust search spelling text-processing
Last synced: 2 days ago
JSON representation
Levenshtein edit distance in Rust
- Host: GitHub
- URL: https://github.com/febeling/edit-distance
- Owner: febeling
- License: apache-2.0
- Created: 2015-04-15T21:45:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T12:38:20.000Z (2 months ago)
- Last Synced: 2024-10-05T15:06:36.299Z (about 1 month ago)
- Topics: algorithm, levenshtein-distance, rust, search, spelling, text-processing
- Language: Rust
- Homepage:
- Size: 567 KB
- Stars: 43
- Watchers: 5
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/febeling/edit-distance/actions/workflows/rust.yml)
# edit-distance
Calculate Levenshtein distance between two strings.
The Levenshtein edit distance is a measure for the similarity between
two strings. It's helpful for spelling correction, fuzzy completion,
type-ahead and similar use cases.
This implementation supports Unicode.
## Installation
In Cargo.toml add
```toml
[dependencies]
edit-distance = "2.1.3"
```
Then re-run `cargo build`. That fetches the dependencies and builds
the code.
## Usage
```rust
extern crate edit_distance;
edit_distance("kitten", "sitting"); // => 3
```
## Development
Test changes before comitting.
```shell
cargo clean
cargo fmt --all -- --check
cargo build
cargo test
```
## Release
- change Cargo.toml version
- change install instructions (version)
- update History section
- commit with version as comment
- tag with version, then:
```shell
cargo publish
git push
git push --tags
```
## History
2024-09-04 2.1.3 Update dev-dependency
2024-06-26 2.1.2 Fix formatting
2024-06-26 2.1.1 Replace CI badge, maintenance
2019-03-02 2.1.0 Optimize memory usage
2018-01-02 2.0.1 Update dev-dependencies
2017-07-02 2.0.0
2015-05-01 1.0.0 Release
2015-04-18 0.0.1 Initial upload
## Contributing
Before sending a pull-request that goes beyond a bugfix, please open an issue to discuss. PRs without clear objective or separation of concerns aren't likely to be accepted.
## Credits
Thanks to @skade for very helpful criticism of my first rust lib.
## License
APL 2.0, see LICENSE file.