Struct PopulatedBTreeSet

Source

pub struct PopulatedBTreeSet<T>(/* private fields */);

Expand description

A populated (i.e. guaranteed to be non-empty) ordered set based on a B-Tree.

Implementations§

Source §

pub fn new(value: T) -> PopulatedBTreeSet<T>

Creates a singleton set with the given value.

Source

pub fn difference<'a>(&'a self, other: &'a BTreeSet<T>) -> Difference<'a, T>

Visits the elements representing the difference, i.e., the elements that are in self but not in other, in ascending order.

Source

pub fn symmetric_difference<'a>( &'a self, other: &'a BTreeSet<T>, ) -> SymmetricDifference<'a, T>

Visits the elements representing the symmetric difference, i.e., the elements that are in self or in other but not in both, in ascending order.

Source

pub fn intersection<'a>(&'a self, other: &'a BTreeSet<T>) -> Intersection<'a, T>

Visits the elements representing the intersection, i.e., the elements that are both in self and other, in ascending order.

Source

pub fn contains<Q: Ord + ?Sized>(&self, value: &Q) -> bool
where T: Borrow<Q>,

Returns true if the populated set contains an element equal to the value.

The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element type.

Source

pub fn get<Q: Ord + ?Sized>(&self, value: &Q) -> Option<&T>
where T: Borrow<Q>,

Returns a reference to the element in the populated set, if any, that is equal to the value.

The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element type.

Source

pub fn is_disjoint(&self, other: &BTreeSet<T>) -> bool

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

Source

pub fn is_subset(&self, other: &BTreeSet<T>) -> bool

Returns true if the set is a subset of another, i.e., other contains at least all the elements in self.

Source

pub fn is_superset(&self, other: &BTreeSet<T>) -> bool

Returns true if the set is a superset of another, i.e., self contains at least all the elements in other.

Source

pub fn first(&self) -> &T

Returns a reference to the first element in the populated set. This element is always the minimum of all elements in the set.

Source

pub fn last(&self) -> &T

Returns a reference to the last element in the populated set. This element is always the maximum of all elements in the set.

Source

pub fn pop_first(self) -> (T, BTreeSet<T>)

Removes the first element from the populated set and returns it along with the remaining set. The first element is always the minimum element in the set.

Source

pub fn pop_last(self) -> (BTreeSet<T>, T)

Removes the last element from the set and returns it, if any. The last element is always the maximum element in the set.

Source

pub fn insert(&mut self, value: T) -> bool

Adds a value to the populated set.

Returns whether the value was newly inserted. That is:

If the set did not previously contain an equal value, true is returned.
If the set already contained an equal value, false is returned, and the entry is not updated.

Source