#fuzzy-search #light-weight #pattern #strsim

simsearch

A simple and lightweight fuzzy search engine that works in memory, searching for similar strings (a pun here)

8 releases

0.2.4 Feb 6, 2023
0.2.3 Apr 11, 2021
0.2.2 Dec 3, 2020
0.2.1 Jul 19, 2020
0.1.4 Apr 16, 2019

#249 in Algorithms

Download history 1973/week @ 2023-11-20 3121/week @ 2023-11-27 2404/week @ 2023-12-04 2365/week @ 2023-12-11 2323/week @ 2023-12-18 1714/week @ 2023-12-25 1834/week @ 2024-01-01 2183/week @ 2024-01-08 3001/week @ 2024-01-15 2956/week @ 2024-01-22 2775/week @ 2024-01-29 1422/week @ 2024-02-05 395/week @ 2024-02-12 1874/week @ 2024-02-19 2996/week @ 2024-02-26 2558/week @ 2024-03-04

7,853 downloads per month
Used in 5 crates

MIT/Apache

19KB
210 lines

simsearch

Build Status crates.io docs.rs

A simple and lightweight fuzzy search engine that works in memory, searching for similar strings (a pun here).

Documentation

Usage

Add the following to your Cargo.toml:

[dependencies]
simsearch = "0.2"

Example

use simsearch::SimSearch;

let mut engine: SimSearch<u32> = SimSearch::new();

engine.insert(1, "Things Fall Apart");
engine.insert(2, "The Old Man and the Sea");
engine.insert(3, "James Joyce");

let results: Vec<u32> = engine.search("thngs");

assert_eq!(results, &[1]);

By default, Jaro-Winkler distance is used. An alternative Levenshtein distance, which is SIMD-accelerated but only works for ASCII byte strings, can be specified with custom SearchOptions:

use simsearch::{SimSearch, SearchOptions};

let options = SearchOptions::new().levenshtein(true);
let mut engine: SimSearch<u32> = SimSearch::new_with(options);

Also try the interactive demo by:

$ cargo run --release --example books

Contribution

All kinds of contribution are welcomed.

  • Issus. Feel free to open an issue when you find typos, bugs, or have any question.
  • Pull requests. New collection, better implementation, more tests, more documents and typo fixes are all welcomed.

License

Licensed under MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Dependencies

~270–445KB