Struct Set 

pub struct Set<K, const B: usize = 32, const S: usize = 8, ST = u8, H = WyHash>
where
    ST: PrimInt + Unsigned,
    H: Hasher + Default,
{ /* private fields */ }

An efficient, immutable set.

Implementations

impl<K, const B: usize, const S: usize, ST, H> Set<K, B, S, ST, H>

where K: Eq + Hash, ST: PrimInt + Unsigned, H: Hasher + Default,

pub fn from_iter_with_params<I>(iter: I, gamma: f32) -> Result<Self, MphfError>

where I: IntoIterator<Item = K>,

Constructs a Set from an iterator of keys and MPHF function parameters.

Examples

use entropy_map::{Set, DEFAULT_GAMMA};

let set: Set<u32> = Set::from_iter_with_params([1, 2, 3], DEFAULT_GAMMA).unwrap();
assert!(set.contains(&1));

pub fn contains<Q>(&self, key: &Q) -> bool

where K: Borrow<Q> + PartialEq<Q>, Q: Hash + Eq + ?Sized,

Returns true if the set contains the value.

Examples

let set = Set::try_from(HashSet::from([1, 2, 3])).unwrap();
assert_eq!(set.contains(&1), true);
assert_eq!(set.contains(&4), false);

pub fn len(&self) -> usize

Returns the number of elements in the set.

Examples

let set = Set::try_from(HashSet::from([1, 2, 3])).unwrap();
assert_eq!(set.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

Examples

let set = Set::try_from(HashSet::from([0u32; 0])).unwrap();
assert_eq!(set.is_empty(), true);
let set = Set::try_from(HashSet::from([1, 2, 3])).unwrap();
assert_eq!(set.is_empty(), false);

pub fn iter(&self) -> impl Iterator<Item = &K>

Returns an iterator visiting set elements in arbitrary order.

Examples

let set = Set::try_from(HashSet::from([1, 2, 3])).unwrap();
for x in set.iter() {
    println!("{x}");
}

pub fn size(&self) -> usize

Returns the total number of bytes occupied by Set.

Examples

let set = Set::try_from(HashSet::from([1, 2, 3])).unwrap();
assert_eq!(set.size(), 218);

Trait Implementations

impl<K: Default, const B: usize, const S: usize, ST, H> Default for Set<K, B, S, ST, H>

where ST: PrimInt + Unsigned + Default, H: Hasher + Default + Default,

fn default() -> Set<K, B, S, ST, H>

Returns the “default value” for a type.

impl<K> TryFrom<HashSet<K>> for Set<K>

where K: Eq + Hash,

Creates a Set from a HashSet.

type Error = MphfError

The type returned in the event of a conversion error.

fn try_from(value: HashSet<K>) -> Result<Self, Self::Error>

Performs the conversion.