Struct indexical::IndexSet

pub struct IndexSet<'a, T: IndexedValue + 'a, S: BitSet, P: PointerFamily<'a>> { /* private fields */ }

An unordered collections of Ts, implemented with a bit-set.

Implementations

impl<'a, T, S, P> IndexSet<'a, T, S, P>where T: IndexedValue + 'a, S: BitSet, P: PointerFamily<'a>,

pub fn new(domain: &P::Pointer<IndexedDomain<T>>) -> Self

Creates an empty index set.

pub fn indices(&self) -> impl Iterator<Item = T::Index> + '_

Returns an iterator over all the indices contained in self.

pub fn iter(&self) -> impl Iterator<Item = &T> + Captures<'a> + '_

Returns an iterator over all the objects contained in self.

pub fn iter_enumerated( &self ) -> impl Iterator<Item = (T::Index, &T)> + Captures<'a> + '_

Returns an iterator over the pairs of indices and objects contained in self.

pub fn contains<M>(&self, index: impl ToIndex<T, M>) -> bool

Returns true if index is contained in self.

pub fn len(&self) -> usize

Returns the number of elements in self.

pub fn is_empty(&self) -> bool

Return true if self has no elements.

pub fn is_superset(&self, other: &IndexSet<'a, T, S, P>) -> bool

Returns true if every element in other is also in self.

pub fn insert<M>(&mut self, elt: impl ToIndex<T, M>) -> bool

Adds the element elt to self, returning true if self changed.

pub fn union(&mut self, other: &IndexSet<'a, T, S, P>)

Adds each element of other to self.

pub fn union_changed(&mut self, other: &IndexSet<'a, T, S, P>) -> bool

Adds each element of other to self, returning true if self changed.

pub fn subtract(&mut self, other: &IndexSet<'a, T, S, P>)

Removes every element of other from self.

pub fn subtract_changed(&mut self, other: &IndexSet<'a, T, S, P>) -> bool

Removes every element of other from self, returning true if self changed.

pub fn intersect(&mut self, other: &IndexSet<'a, T, S, P>)

Removes every element of self not in other.

pub fn intersect_changed(&mut self, other: &IndexSet<'a, T, S, P>) -> bool

Removes every element of self not in other, returning true if self changed.

pub fn insert_all(&mut self)

Adds every element of the domain to self.

pub fn clear(&mut self)

Removes every element from self.

pub fn inner(&self) -> &S

Returns a reference to the inner set.

Trait Implementations

impl<'a, T, S, P> Clone for IndexSet<'a, T, S, P>where T: IndexedValue + 'a, S: BitSet, P: PointerFamily<'a>,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T, S, P> Debug for IndexSet<'a, T, S, P>where T: IndexedValue + Debug + 'a, S: BitSet, P: PointerFamily<'a>,

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

Formats the value using the given formatter.

impl<'a, T, U, S, M, P> FromIndexicalIterator<'a, T, P, M, U> for IndexSet<'a, T, S, P>where T: IndexedValue + 'a, S: BitSet, P: PointerFamily<'a>, U: ToIndex<T, M>,

fn from_indexical_iter( iter: impl Iterator<Item = U>, domain: &P::Pointer<IndexedDomain<T>> ) -> Self

Converts an iterator into a collection within the given domain.

impl<'a, T, S, P> PartialEq for IndexSet<'a, T, S, P>where T: IndexedValue + 'a, S: BitSet, P: PointerFamily<'a>,

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

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

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

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

impl<'a, T, S, P> Eq for IndexSet<'a, T, S, P>where T: IndexedValue + 'a, S: BitSet, P: PointerFamily<'a>,