Trait indexical::bitset::BitSet

pub trait BitSet: Clone + PartialEq {
    type Iter<'a>: Iterator<Item = usize>
       where Self: 'a;

    // Required methods
    fn empty(size: usize) -> Self;
    fn insert(&mut self, index: usize) -> bool;
    fn contains(&self, index: usize) -> bool;
    fn iter(&self) -> Self::Iter<'_>;
    fn len(&self) -> usize;
    fn union(&mut self, other: &Self);
    fn intersect(&mut self, other: &Self);
    fn subtract(&mut self, other: &Self);
    fn invert(&mut self);
    fn clear(&mut self);
    fn insert_all(&mut self);
    fn copy_from(&mut self, other: &Self);

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn union_changed(&mut self, other: &Self) -> bool { ... }
    fn intersect_changed(&mut self, other: &Self) -> bool { ... }
    fn subtract_changed(&mut self, other: &Self) -> bool { ... }
    fn superset(&self, other: &Self) -> bool { ... }
}

Interface for bit-set implementations.

Implement this trait if you want to provide a custom bit-set beneath the indexical abstractions.

Required Associated Types

type Iter<'a>: Iterator<Item = usize> where Self: 'a

Type of iterator returned by iter.

Required Methods

fn empty(size: usize) -> Self

Constructs a new bit-set with a domain of size size.

fn insert(&mut self, index: usize) -> bool

Sets index to 1, returning true if self changed.

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

Returns true if index is 1.

fn iter(&self) -> Self::Iter<'_>

Returns an iterator over all the indices of ones in the bit-set.

fn len(&self) -> usize

Returns the number of ones in the bit-set.

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

Adds all ones from other to self.

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

Removes all ones in self not in other.

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

Removes all ones from other in self.

fn invert(&mut self)

Flips all bits in self.

fn clear(&mut self)

Sets all bits to 0.

fn insert_all(&mut self)

Adds every element of the domain to self.

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

Copies other into self. Must have the same lengths.

Provided Methods

fn is_empty(&self) -> bool

Returns true if there are no ones in the bit-set.

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

Adds all ones from other to self, returning true if self changed.

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

Removes all ones in self not in other, returning true if self changed.

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

Removes all ones from other in self, returning true if self changed.

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

Returns true if all ones in other are a one in self.

Object Safety

This trait is not object safe.

Implementors

impl BitSet for BitVec

Available on crate feature bitvec only.

type Iter<'a> = IterOnes<'a, usize, Lsb0>

impl BitSet for RoaringSet

Available on crate feature roaring only.

type Iter<'a> = Map<Iter<'a>, fn(_: u32) -> usize>

impl<T: SimdSetElement, const N: usize> BitSet for SimdBitset<T, N>where LaneCount<N>: SupportedLaneCount, Simd<T, N>: for<'a> BitOr<&'a Simd<T, N>, Output = Simd<T, N>>, Simd<T, N>: for<'a> BitAnd<&'a Simd<T, N>, Output = Simd<T, N>>,

Available on crate feature simd only.

type Iter<'a> = SimdSetIter<'a, T, N>