#fuzzy #search #lightweight #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

#231 in Algorithms

Download history 4134/week @ 2023-11-02 2910/week @ 2023-11-09 1923/week @ 2023-11-16 2657/week @ 2023-11-23 2990/week @ 2023-11-30 2337/week @ 2023-12-07 2713/week @ 2023-12-14 2029/week @ 2023-12-21 1629/week @ 2023-12-28 2178/week @ 2024-01-04 3005/week @ 2024-01-11 3120/week @ 2024-01-18 2594/week @ 2024-01-25 2571/week @ 2024-02-01 474/week @ 2024-02-08 1122/week @ 2024-02-15

7,375 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–455KB