HashedAs

Struct HashedAs 

Source
pub struct HashedAs<T>(/* private fields */);
Expand description

HashedAs<U> can encode any feature that’s hashable. Here, U can be u8, u16, u32 or u64. Hash collisions are usually not a big problem for most uses (especially with HashedAs<u64>) HashedAs can really speed things up where you need to do a lot of equality comparisons and your feature is longer that U. It can also provide more balanced nodes in a BTree. Currently uses FxHash.

§Example: Succinctly implementing MinHash

use creature_feature::ftzrs::bigram;
use creature_feature::traits::*;
use creature_feature::HashedAs;
use std::cmp::Reverse;
use std::collections::BinaryHeap;

// jaccard similarity is very fast on two sorted vecs, left as an exercise
fn min_hash(s: &str, n: usize) -> Vec<HashedAs<u64>> {

   let heap: BinaryHeap<Reverse<HashedAs<u64>>> = bigram().featurize(s);

   heap
    .into_iter_sorted()
    .map(|r| r.0)
    .take(10)
    .collect()
}

Trait Implementations§

Source§

impl<T: Clone> Clone for HashedAs<T>

Source§

fn clone(&self) -> HashedAs<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for HashedAs<T>

Source§

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

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

impl<T: Hash> FeatureFrom<T> for HashedAs<u16>

Source§

fn from(token_group: T) -> Self

Source§

impl<T: Hash> FeatureFrom<T> for HashedAs<u32>

Source§

fn from(token_group: T) -> Self

Source§

impl<T: Hash> FeatureFrom<T> for HashedAs<u64>

Source§

fn from(token_group: T) -> Self

Source§

impl<T: Hash> FeatureFrom<T> for HashedAs<u8>

Source§

fn from(token_group: T) -> Self

Source§

impl<T: Hash, V: Hash> From<GapPair<T, V>> for HashedAs<u16>

Source§

fn from(x: GapPair<T, V>) -> Self

Converts to this type from the input type.
Source§

impl<T: Hash, V: Hash> From<GapPair<T, V>> for HashedAs<u32>

Source§

fn from(x: GapPair<T, V>) -> Self

Converts to this type from the input type.
Source§

impl<T: Hash, V: Hash> From<GapPair<T, V>> for HashedAs<u64>

Source§

fn from(x: GapPair<T, V>) -> Self

Converts to this type from the input type.
Source§

impl<T: Hash, V: Hash> From<GapPair<T, V>> for HashedAs<u8>

Source§

fn from(x: GapPair<T, V>) -> Self

Converts to this type from the input type.
Source§

impl<A: Hash> FromIterator<A> for HashedAs<u16>

Source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = A>,

Creates a value from an iterator. Read more
Source§

impl<A: Hash> FromIterator<A> for HashedAs<u32>

Source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = A>,

Creates a value from an iterator. Read more
Source§

impl<A: Hash> FromIterator<A> for HashedAs<u64>

Source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = A>,

Creates a value from an iterator. Read more
Source§

impl<A: Hash> FromIterator<A> for HashedAs<u8>

Source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = A>,

Creates a value from an iterator. Read more
Source§

impl<T: Hash> Hash for HashedAs<T>

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 Into<u16> for HashedAs<u16>

Source§

fn into(self) -> u16

Converts this type into the (usually inferred) input type.
Source§

impl Into<u32> for HashedAs<u32>

Source§

fn into(self) -> u32

Converts this type into the (usually inferred) input type.
Source§

impl Into<u64> for HashedAs<u64>

Source§

fn into(self) -> u64

Converts this type into the (usually inferred) input type.
Source§

impl Into<u8> for HashedAs<u8>

Source§

fn into(self) -> u8

Converts this type into the (usually inferred) input type.
Source§

impl<T: Ord> Ord for HashedAs<T>

Source§

fn cmp(&self, other: &HashedAs<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq> PartialEq for HashedAs<T>

Source§

fn eq(&self, other: &HashedAs<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: PartialOrd> PartialOrd for HashedAs<T>

Source§

fn partial_cmp(&self, other: &HashedAs<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Copy> Copy for HashedAs<T>

Source§

impl<T: Eq> Eq for HashedAs<T>

Source§

impl IsEnabled for HashedAs<u16>

Source§

impl IsEnabled for HashedAs<u32>

Source§

impl IsEnabled for HashedAs<u64>

Source§

impl IsEnabled for HashedAs<u8>

Source§

impl<T> StructuralPartialEq for HashedAs<T>

Auto Trait Implementations§

§

impl<T> Freeze for HashedAs<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for HashedAs<T>
where T: RefUnwindSafe,

§

impl<T> Send for HashedAs<T>
where T: Send,

§

impl<T> Sync for HashedAs<T>
where T: Sync,

§

impl<T> Unpin for HashedAs<T>
where T: Unpin,

§

impl<T> UnwindSafe for HashedAs<T>
where T: UnwindSafe,

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, 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.