Skip to main content

MinHashSignature

Struct MinHashSignature 

Source
pub struct MinHashSignature {
    pub values: Vec<u32>,
    pub doc_id: usize,
}
Expand description

A MinHash signature for a document.

The signature is a vector of hash values (typically 64-256 values). Similar documents will have similar signatures.

Fields§

§values: Vec<u32>

The hash values forming this signature.

§doc_id: usize

Document index (if part of a collection).

Implementations§

Source§

impl MinHashSignature

Source

pub fn new(values: Vec<u32>, doc_id: usize) -> Self

Create a new signature from raw values.

Source

pub fn similarity(&self, other: &Self) -> f64

Compute estimated Jaccard similarity with another signature.

The similarity is the fraction of hash values that match between the two signatures. This approximates the true Jaccard similarity of the original sets.

Source

pub fn band(&self, start: usize, length: usize) -> &[u32]

Get a band of the signature for LSH.

Returns the slice values[start .. start + length], gracefully clamped to the signature bounds: a start at or past the end yields an empty slice, and an over-long length is truncated to the available tail. It never panics.

This clamp is safe (not a silent recall loss) because the callers that require exact band tiling, the LshIndex, validate signature.len() == num_bands * rows_per_band before slicing, so a band is never silently shortened on the indexing path.

Source

pub fn band_hash(&self, start: usize, length: usize) -> u64

Compute a band hash for LSH bucketing.

This combines all values in a band into a single hash value that can be used as a bucket key.

Source

pub fn len(&self) -> usize

Get the number of hash values in this signature.

Source

pub fn is_empty(&self) -> bool

Check if this signature is empty.

Trait Implementations§

Source§

impl Clone for MinHashSignature

Source§

fn clone(&self) -> MinHashSignature

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MinHashSignature

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MinHashSignature

Source§

impl Hash for MinHashSignature

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for MinHashSignature

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MinHashSignature

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more