datasketch-minhash-lsh 0.0.1

A Rust version of the min-hash LSH part of the Python datasketch library
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
36
37
38

use std::{error, fmt};

#[derive(Debug)]
// https://doc.rust-lang.org/rust-by-example/error/multiple_error_types/wrap_error.html for from
//  example if we need it
pub enum MinHashingError {
    DifferentSeeds,
    DifferentNumPermFuncs,
    WrongThresholdInterval,
    NumPermFuncsTooLow,
    WrongWeightThreshold,
    UnexpectedSumWeight,
    KeyDoesNotExist,
}

impl fmt::Display for MinHashingError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            MinHashingError::DifferentSeeds => write!(
                f,
                "computing jaccard similarity between minhashes only works if they \
                use the same seed"
            ),
            MinHashingError::DifferentNumPermFuncs => write!(
                f,
                "computing jaccard similarity between minhashes only works if they \
                use the same number of permutation functions"
            ),
            MinHashingError::WrongThresholdInterval => write!(f, "threshold must be in [0.0, 1.0]"),
            MinHashingError::NumPermFuncsTooLow => write!(f, "Too few permutation functions"),
            MinHashingError::WrongWeightThreshold => write!(f, "Weight must be in [0.0, 1.0]"),
            MinHashingError::UnexpectedSumWeight => write!(f, "Weights must sum to 1.0"),
            MinHashingError::KeyDoesNotExist => write!(f, "Attempted to remove a non-existing key"),
        }
    }
}

impl error::Error for MinHashingError {}