Struct Config 

pub struct Config {
    pub min_tokens: usize,
    pub ident_mode: IdentMode,
    pub kgram: usize,
    pub window: usize,
    pub minhash_size: usize,
    pub bands: usize,
    pub fingerprint_levels: Vec<Level>,
    pub keep_tokens: bool,
}

Parameters of feature extraction.

Fields

min_tokens: usize

Functions with fewer N0 tokens get exact hashes only (no fingerprints / MinHash).

ident_mode: IdentMode

How identifiers are abstracted from N1.

kgram: usize

k of the k-grams used for fingerprints.

window: usize

Window size of winnowing.

minhash_size: usize

Length of MinHash signatures.

bands: usize

Number of LSH bands; minhash_size must be divisible by it.

fingerprint_levels: Vec<Level>

Levels for which fingerprints, MinHash and LSH buckets are computed.

keep_tokens: bool

Keep the normalized token sequences in the output (for debugging and research).

Implementations

impl Config

pub fn validate(&self) -> Result<(), Error>

Checks that the parameters can be used: kgram and window are positive, and minhash_size is a positive multiple of bands.

Errors

Error::InvalidConfig describing the first invalid parameter.

Examples

use pelicode_core::Config;

assert!(Config::default().validate().is_ok());

let config = Config { minhash_size: 100, bands: 32, ..Config::default() };
assert!(config.validate().is_err());

pub fn rows(&self) -> usize

Rows per LSH band.

Examples

use pelicode_core::Config;

let config = Config { minhash_size: 128, bands: 32, ..Config::default() };
assert_eq!(config.rows(), 4);

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq for Config

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config