simhash 0.3.0

Simhash algorithm for 64-bit locality-sensitive hashing and similarity calculation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# Simhash for Rust
[![CI](https://github.com/bartolsthoorn/simhash-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/bartolsthoorn/simhash-rs/actions/workflows/ci.yml)
[![crates.io](https://img.shields.io/crates/v/simhash.svg)](https://crates.io/crates/simhash)

Simhash algorithm (developed by [Moses Charikar](http://www.cs.princeton.edu/courses/archive/spring04/cos598B/bib/CharikarEstim.pdf)) implemented in Rust. It generates 64-bit simhashes and can calculate similarities using the [Hamming distance](http://en.wikipedia.org/wiki/Hamming_distance).

## Usage

Add `simhash` to your `Cargo.toml`:
```toml
[dependencies]
simhash = "0.3"
```

```rust
fn main() {
    let hash = simhash::simhash("The cat sat on the mat");
    println!("{hash}");

    let similarity = simhash::similarity("The cat sat on the mat", "The cat sat under the mat");
    println!("{similarity}");
}
```

## Features

By default, simhash uses [SipHash](https://crates.io/crates/siphasher) as its internal hasher. You can switch to [FNV](https://crates.io/crates/fnv) instead:
```toml
[dependencies]
simhash = { version = "0.3", default-features = false, features = ["hasher-fnv"] }
```

## License

MIT