Struct fixed_bitset::Bitset

pub struct Bitset<N, B = usize> where
    B: Primitive,
    N: CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>,  { /* fields omitted */ }

A set of unsigned integers whose size is fixed at compile-time.

A Bitset can only store unsigned integers less than N, where N is a compile-time integer from typenum. A Bitset uses a single bit to indicate the presence or absence of each value.

Methods

impl<N, B> Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

pub fn new() -> Self

Returns an empty bitset.

pub fn contains(&self, value: usize) -> bool

Returns true if the bitset contains a value.

Panics if value >= N.

pub fn insert(&mut self, value: usize)

Inserts a value into the bitset.

If that value already exists in the bitset, this function has no effect.

Panics if value >= N.

pub fn remove(&mut self, value: usize)

Removes a value from the bitset.

If that value does not already exist in the bitset, this function has no effect.

Panics if value >= N.

pub fn is_empty(&self) -> bool

Returns true if the bitset contains no bits.

pub fn len(&self) -> usize

Returns the number of values contained in the bitset.

pub fn iter(&self) -> impl '_ + Iterator<Item = usize> + Clone

Returns an iterator over the values in the bitset.

pub fn clear(&mut self)

Clears the bitset, removing all values.

pub fn union<'a>(&'a self, other: &'a Self) -> impl 'a + Iterator<Item = usize>

Returns an iterator over self | other.

pub fn intersection<'a>(
    &'a self,
    other: &'a Self
) -> impl 'a + Iterator<Item = usize>

Returns an iterator over self & other.

pub fn symmetric_difference<'a>(
    &'a self,
    other: &'a Self
) -> impl 'a + Iterator<Item = usize>

Returns an iterator over self ^ other.

pub fn difference<'a>(
    &'a self,
    other: &'a Self
) -> impl 'a + Iterator<Item = usize>

Returns an iterator over self - other.

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

Returns true if self has no elements in common with other.

This is more efficient than self.intersection(other).next().is_none().

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

Returns true if every element in self exists in other.

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

Returns true if every element in other exists in self.

Trait Implementations

impl<N, B> Copy for Bitset<N, B> where
    B: Primitive,
    N: CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>,
    GenericArray<B, <N as CeilDiv<B::Size>>::Output>: Copy, 

impl<N, B> PartialEq<Bitset<N, B>> for Bitset<N, B> where
    B: Primitive,
    N: CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

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

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

#[must_use]

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

This method tests for !=.

impl<N, B> Default for Bitset<N, B> where
    B: Primitive,
    N: CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

fn default() -> Self

Returns the "default value" for a type.

impl<N, B> Clone for Bitset<N, B> where
    B: Primitive,
    N: CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, B> Eq for Bitset<N, B> where
    B: Primitive,
    N: CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

impl<N, B> Debug for Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

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

Formats the value using the given formatter.

impl<'a, 'b, N, B> Sub<&'b Bitset<N, B>> for &'a Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>,
    Bitset<N, B>: Clone, 

Difference

type Output = Bitset<N, B>

The resulting type after applying the - operator.

fn sub(self, other: &'b Bitset<N, B>) -> Self::Output

Performs the - operation.

impl<N, B, '_> SubAssign<&'_ Bitset<N, B>> for Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

Difference

fn sub_assign(&mut self, other: &Self)

Performs the -= operation.

impl<'a, 'b, N, B> BitAnd<&'b Bitset<N, B>> for &'a Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>,
    Bitset<N, B>: Clone, 

Intersection

type Output = Bitset<N, B>

The resulting type after applying the & operator.

fn bitand(self, other: &'b Bitset<N, B>) -> Self::Output

Performs the & operation.

impl<'a, 'b, N, B> BitOr<&'b Bitset<N, B>> for &'a Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>,
    Bitset<N, B>: Clone, 

Union

type Output = Bitset<N, B>

The resulting type after applying the | operator.

fn bitor(self, other: &'b Bitset<N, B>) -> Self::Output

Performs the | operation.

impl<'a, 'b, N, B> BitXor<&'b Bitset<N, B>> for &'a Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>,
    Bitset<N, B>: Clone, 

Symmetric Difference

type Output = Bitset<N, B>

The resulting type after applying the ^ operator.

fn bitxor(self, other: &'b Bitset<N, B>) -> Self::Output

Performs the ^ operation.

impl<N, B, '_> BitAndAssign<&'_ Bitset<N, B>> for Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

Intersection

fn bitand_assign(&mut self, other: &Self)

Performs the &= operation.

impl<N, B, '_> BitOrAssign<&'_ Bitset<N, B>> for Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

Union

fn bitor_assign(&mut self, other: &Self)

Performs the |= operation.

impl<N, B, '_> BitXorAssign<&'_ Bitset<N, B>> for Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

Symmetric Difference

fn bitxor_assign(&mut self, other: &Self)

Performs the ^= operation.

impl<N, B> FromIterator<usize> for Bitset<N, B> where
    B: Primitive,
    N: Unsigned + CeilDiv<B::Size>,
    <N as CeilDiv<B::Size>>::Output: ArrayLength<B>, 

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

Creates a value from an iterator.