Struct lilbits::LilBitSet

pub struct LilBitSet { /* fields omitted */ }

Set-like data structure for storing u8 elements. Cannot contains values >= 64.

Methods

impl LilBitSet

fn new() -> LilBitSet

Creates a new, empty LilBitSet.

fn largest_allowed() -> u8

Returns the largest u8 values that IS permitted to be inserted.

fn new_from_raw(raw: u64) -> Self

Constructs a LilBitSet from a u64. The indices of positive bits refers to the presence of a u8 in the set. ie '...1010' binary for 10 will represent the set {1,3}.

fn into_raw(self) -> u64

Inverse of new_from_raw

fn get(&self, element: u8) -> Option<u8>

Included only as it is a common function for the HashSet. Here it simply wraps contains.

Panics

panics when element > Self::largest_allowed().

fn contains(&self, element: u8) -> bool

Returns true IFF the given u8 is in the set.

Panics

panics when element > Self::largest_allowed().

fn is_empty(&self) -> bool

Returns true IFF the set is empty (contains no values).

fn universe() -> LilBitSet

Of course this set is not unqiue in its finite value-space for set elements. However, as there is the additional restriction of x <= Self::largest_allowed() for any element x, the UNIVERSE of missing elements can be useful

fn insert(&mut self, element: u8) -> bool

Attempts to insert the given u8 into the set. Returns true IFF successful.

Panics

panics when element > Self::largest_allowed().

fn remove(&mut self, element: u8) -> bool

Attempts to remove a given u8 from the set. Returns true IFF successful.

Panics

panics when element >= Self::largest_allowed().

fn union(&self, other: &Self) -> Self

Returns the set union of this, and the given LilBitSet.

fn itersection(&self, other: &Self) -> Self

Returns the set itersection of this, and the given LilBitSet.

fn len(&self) -> usize

Returns the set cardinality (number of elements of the set).

fn symmetric_difference(&self, other: &Self) -> Self

Returns the set symmetric difference of this, and the given LilBitSet.

fn complement(&self) -> LilBitSet

Relying on Self::universe(), this function can be useful in reasoning over missing elements in a more convenient way

Trait Implementations

impl Copy for LilBitSet

impl Clone for LilBitSet

fn clone(&self) -> LilBitSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for LilBitSet

impl PartialEq for LilBitSet

fn eq(&self, __arg_0: &LilBitSet) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &LilBitSet) -> bool

This method tests for !=.

impl Into<HashSet<u8>> for LilBitSet

fn into(self) -> HashSet<u8>

Performs the conversion.

impl Into<BTreeSet<u8>> for LilBitSet

fn into(self) -> BTreeSet<u8>

Performs the conversion.

impl Debug for LilBitSet

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

Formats the value using the given formatter.

impl IntoIterator for LilBitSet

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl FromIterator<u8> for LilBitSet

fn from_iter<I: IntoIterator<Item = u8>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> FromIterator<&'a u8> for LilBitSet

fn from_iter<I: IntoIterator<Item = &'a u8>>(iter: I) -> Self

Creates a value from an iterator.