Struct BitSet 

pub struct BitSet<A, V>(/* private fields */);

Implementations

impl<A: PrimStore, V> BitSet<A, V>

pub const fn new() -> Self

pub fn from_element(elem: V) -> Self

where V: AsPrimitive<usize>,

pub fn into_bits(self) -> A

pub fn union(&self, other: &A) -> BitSet<A, V>

where A: Copy + BitOr<Output = A>,

pub fn difference(&self, other: &A) -> BitSet<A, V>

where A: Copy + BitAnd<Output = A> + Not<Output = A>,

pub fn includes(&self, other: &A) -> bool

where A: Copy + BitAnd<Output = A> + PartialEq,

pub fn iter(&self) -> PrimBitSetIter<A, V>

where A: PrimInt,

Snapshot iterator over set bit positions. Copies the raw bits, so the bitset can be mutated while iterating.

pub fn load_store(&self) -> A

where A: Copy,

pub fn swap_store(&mut self, store: &mut A)

pub fn mut_store(&mut self, f: impl Fn(&mut A))

pub fn drain(&mut self) -> PrimBitSetIter<A, V>

where A: PrimInt + Zero,

pub fn union_from(&mut self, other: A)

where A: Copy + BitOrAssign<A>,

pub fn set(&mut self, id: V, value: bool)

where V: AsPrimitive<usize>,

pub fn insert(&mut self, id: V) -> bool

where V: AsPrimitive<usize>,

pub fn remove(&mut self, id: V) -> bool

where V: AsPrimitive<usize>,

pub fn toggle(&mut self, id: V)

where V: AsPrimitive<usize>,

impl<V> BitSet<u8, V>

pub const fn from_bits(raw: u8) -> Self

Const constructor from raw bits.

pub const fn bits(&self) -> u8

Raw bits accessor (const).

pub const fn from_index(idx: usize) -> Self

Const constructor from a single bit index.

pub const fn from_indices(indices: &[usize]) -> Self

Const constructor from a slice of bit indices.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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

Const bit-index membership test.

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

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

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

impl<V> BitSet<u16, V>

pub const fn from_bits(raw: u16) -> Self

Const constructor from raw bits.

pub const fn bits(&self) -> u16

Raw bits accessor (const).

pub const fn from_index(idx: usize) -> Self

Const constructor from a single bit index.

pub const fn from_indices(indices: &[usize]) -> Self

Const constructor from a slice of bit indices.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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

Const bit-index membership test.

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

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

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

impl<V> BitSet<u32, V>

pub const fn from_bits(raw: u32) -> Self

Const constructor from raw bits.

pub const fn bits(&self) -> u32

Raw bits accessor (const).

pub const fn from_index(idx: usize) -> Self

Const constructor from a single bit index.

pub const fn from_indices(indices: &[usize]) -> Self

Const constructor from a slice of bit indices.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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

Const bit-index membership test.

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

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

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

impl<V> BitSet<u64, V>

pub const fn from_bits(raw: u64) -> Self

Const constructor from raw bits.

pub const fn bits(&self) -> u64

Raw bits accessor (const).

pub const fn from_index(idx: usize) -> Self

Const constructor from a single bit index.

pub const fn from_indices(indices: &[usize]) -> Self

Const constructor from a slice of bit indices.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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

Const bit-index membership test.

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

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

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

impl<V> BitSet<u128, V>

pub const fn from_bits(raw: u128) -> Self

Const constructor from raw bits.

pub const fn bits(&self) -> u128

Raw bits accessor (const).

pub const fn from_index(idx: usize) -> Self

Const constructor from a single bit index.

pub const fn from_indices(indices: &[usize]) -> Self

Const constructor from a slice of bit indices.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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

Const bit-index membership test.

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

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

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

impl<V> BitSet<usize, V>

pub const fn from_bits(raw: usize) -> Self

Const constructor from raw bits.

pub const fn bits(&self) -> usize

Raw bits accessor (const).

pub const fn from_index(idx: usize) -> Self

Const constructor from a single bit index.

pub const fn from_indices(indices: &[usize]) -> Self

Const constructor from a slice of bit indices.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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

Const bit-index membership test.

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

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

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

impl<T: PrimStore, V, const N: usize> BitSet<[T; N], V>

pub const fn new() -> Self

pub const fn empty() -> Self

pub fn from_bits(raw: [T; N]) -> Self

pub fn from_element(id: V) -> Self

where T: PrimInt, V: AsPrimitive<usize>,

pub fn into_bits(self) -> [T; N]

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

where T: Copy + BitAnd<Output = T> + PartialEq,

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

where T: Copy + BitAnd<Output = T> + PartialEq,

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

where T: Copy + BitAnd<Output = T> + Zero,

pub fn as_slice(&self) -> &[T]

pub fn as_mut_slice(&mut self) -> &mut [T]

Methods from Deref<Target = BitSlice<A, V>>

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn first(&self) -> Option<V>

where V: TryFrom<usize>,

pub fn last(&self) -> Option<V>

where V: TryFrom<usize>,

pub fn pop_first(&mut self) -> Option<V>

where V: TryFrom<usize>,

pub fn pop_last(&mut self) -> Option<V>

where V: TryFrom<usize>,

pub fn contains(&self, id: &V) -> bool

where V: Copy + AsPrimitive<usize>,

pub fn set(&mut self, id: V, value: bool)

where V: AsPrimitive<usize>,

pub fn insert(&mut self, id: V) -> bool

where V: AsPrimitive<usize>,

pub fn remove(&mut self, id: V) -> bool

where V: AsPrimitive<usize>,

pub fn toggle(&mut self, id: V)

where V: AsPrimitive<usize>,

pub fn clear(&mut self)

pub fn retain(&mut self, f: impl FnMut(V) -> bool)

where V: TryFrom<usize>,

pub fn append(&mut self, other: &mut Self)

pub fn iter(&self) -> BitSliceIter<'_, T, V>

where T: BitAndAssign, V: TryFrom<usize>,

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

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

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

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

where T: BitAndAssign, V: TryFrom<usize>,

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

where T: BitAndAssign, V: TryFrom<usize>,

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

where T: BitAndAssign, V: TryFrom<usize>,

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

where T: BitAndAssign, V: TryFrom<usize>,

pub fn raw_words(&self) -> &[T]

Raw word slice accessor.

Trait Implementations

impl<A: PrimStore + Binary, V> Binary for BitSet<A, V>

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

Formats the value using the given formatter.

impl<T, V, const N: usize> BitAnd for BitSet<[T; N], V>

where T: PrimStore + BitAnd<Output = T> + Copy,

type Output = BitSet<[T; N], V>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl<A: PrimStore + Copy + BitAnd<Output = A>, V> BitAnd for BitSet<A, V>

type Output = BitSet<A, V>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl<T, V, const N: usize> BitAndAssign for BitSet<[T; N], V>

where T: PrimStore + BitAndAssign + Copy,

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<A: PrimStore + BitAndAssign, V> BitAndAssign for BitSet<A, V>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<T, V, const N: usize> BitOr for BitSet<[T; N], V>

where T: PrimStore + BitOr<Output = T> + Copy,

type Output = BitSet<[T; N], V>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl<A: PrimStore + Copy + BitOr<Output = A>, V> BitOr for BitSet<A, V>

type Output = BitSet<A, V>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl<T, V, const N: usize> BitOrAssign for BitSet<[T; N], V>

where T: PrimStore + BitOrAssign + Copy,

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<A: PrimStore + BitOrAssign, V> BitOrAssign for BitSet<A, V>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<T, V, const N: usize> BitXor for BitSet<[T; N], V>

where T: PrimStore + BitXor<Output = T> + Copy,

type Output = BitSet<[T; N], V>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl<A: PrimStore + Copy + BitXor<Output = A>, V> BitXor for BitSet<A, V>

type Output = BitSet<A, V>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl<T, V, const N: usize> BitXorAssign for BitSet<[T; N], V>

where T: PrimStore + BitXorAssign + Copy,

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<A: PrimStore + BitXorAssign, V> BitXorAssign for BitSet<A, V>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<A: Clone, V: Clone> Clone for BitSet<A, V>

fn clone(&self) -> BitSet<A, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: PrimInt, V, const N: usize> Debug for BitSet<[T; N], V>

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

Formats the value using the given formatter.

impl<A: PrimStore, V> Debug for BitSet<A, V>

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

Formats the value using the given formatter.

impl<T: PrimStore, V, const N: usize> Default for BitSet<[T; N], V>

fn default() -> Self

Returns the “default value” for a type.

impl<A: PrimStore, V> Default for BitSet<A, V>

fn default() -> Self

Returns the “default value” for a type.

impl<T, V, const N: usize> Deref for BitSet<[T; N], V>

type Target = BitSlice<T, V>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<A: PrimStore, V> Deref for BitSet<A, V>

type Target = BitSlice<A, V>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, V, const N: usize> DerefMut for BitSet<[T; N], V>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<A: PrimStore, V> DerefMut for BitSet<A, V>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: PrimStore + BitOrAssign + Copy, V, const N: usize> Extend<BitSet<[T; N], V>> for BitSet<[T; N], V>

fn extend<I: IntoIterator<Item = Self>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<A: PrimStore + BitOrAssign + Copy, V> Extend<BitSet<A, V>> for BitSet<A, V>

fn extend<I: IntoIterator<Item = Self>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: PrimStore, V: AsPrimitive<usize>, const N: usize> Extend<V> for BitSet<[T; N], V>

fn extend<I: IntoIterator<Item = V>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<A: Copy + PrimStore, V: AsPrimitive<usize>> Extend<V> for BitSet<A, V>

fn extend<I: IntoIterator<Item = V>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: PrimStore + BitOrAssign + Copy, V, const N: usize> FromIterator<BitSet<[T; N], V>> for BitSet<[T; N], V>

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

Creates a value from an iterator.

impl<A: PrimStore + BitOrAssign + Copy, V> FromIterator<BitSet<A, V>> for BitSet<A, V>

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

Creates a value from an iterator.

impl<T: PrimStore, V: AsPrimitive<usize>, const N: usize> FromIterator<V> for BitSet<[T; N], V>

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

Creates a value from an iterator.

impl<A: Copy + PrimStore, V: AsPrimitive<usize>> FromIterator<V> for BitSet<A, V>

fn from_iter<T: IntoIterator<Item = V>>(iter: T) -> Self

Creates a value from an iterator.

impl<T: Hash, V, const N: usize> Hash for BitSet<[T; N], V>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A: PrimStore + Hash, V> Hash for BitSet<A, V>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: PrimInt + BitAndAssign, V: TryFrom<usize>, const N: usize> IntoIterator for &'a BitSet<[T; N], V>

type Item = V

The type of the elements being iterated over.

type IntoIter = BitSliceIter<'a, T, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, A: PrimStore + BitAndAssign, V: TryFrom<usize>> IntoIterator for &'a BitSet<A, V>

type Item = V

The type of the elements being iterated over.

type IntoIter = BitSliceIter<'a, A, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A, V> IntoIterator for BitSet<A, V>

where A: PrimInt + BitAndAssign<A> + PrimStore, V: TryFrom<u8>,

type Item = V

The type of the elements being iterated over.

type IntoIter = PrimBitSetIter<A, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A: PrimStore + LowerHex, V> LowerHex for BitSet<A, V>

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

Formats the value using the given formatter.

impl<T, V, const N: usize> Not for BitSet<[T; N], V>

where T: PrimStore + Not<Output = T> + Copy,

type Output = BitSet<[T; N], V>

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl<A: PrimStore + Copy + Not<Output = A>, V> Not for BitSet<A, V>

type Output = BitSet<A, V>

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl<A: PrimStore + Octal, V> Octal for BitSet<A, V>

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

Formats the value using the given formatter.

impl<A: PrimStore + Ord, V> Ord for BitSet<A, V>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, V, const N: usize> PartialEq for BitSet<[T; N], V>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<A: PrimStore + PartialEq, V> PartialEq for BitSet<A, V>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<A: PrimStore + Ord, V> PartialOrd for BitSet<A, V>

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, V, const N: usize> Sub for BitSet<[T; N], V>

where T: PrimStore + BitAnd<Output = T> + Not<Output = T> + Copy,

type Output = BitSet<[T; N], V>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl<A, V> Sub for BitSet<A, V>

where A: PrimStore + Copy + BitAnd<Output = A> + Not<Output = A>,

type Output = BitSet<A, V>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl<T, V, const N: usize> SubAssign for BitSet<[T; N], V>

where T: PrimStore + Copy + Not<Output = T> + BitAndAssign,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<A, V> SubAssign for BitSet<A, V>

where A: PrimStore + Copy + BitAndAssign + Not<Output = A>,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<A: PrimStore + UpperHex, V> UpperHex for BitSet<A, V>

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

Formats the value using the given formatter.

impl<A: Copy, V: Copy> Copy for BitSet<A, V>

impl<T: Eq, V, const N: usize> Eq for BitSet<[T; N], V>

impl<A: PrimStore + Eq, V> Eq for BitSet<A, V>