Struct im_rc::ordset::OrdSet

pub struct OrdSet<A> { /* fields omitted */ }

An ordered set.

An immutable ordered set implemented as a [B-tree] 1.

Most operations on this type of set are O(log n). A HashSet is usually a better choice for performance, but the OrdSet has the advantage of only requiring an Ord constraint on its values, and of being ordered, so values always come out from lowest to highest, where a HashSet has no guaranteed ordering.

Methods

impl<A> OrdSet<A>

#[must_use]

pub fn new() -> Self

Construct an empty set.

#[must_use]

pub fn unit(a: A) -> Self

Construct a set with a single value.

Examples

let set = OrdSet::unit(123);
assert!(set.contains(&123));

#[must_use]

pub fn is_empty(&self) -> bool

Test whether a set is empty.

Time: O(1)

Examples

assert!(
  !ordset![1, 2, 3].is_empty()
);
assert!(
  OrdSet::<i32>::new().is_empty()
);

#[must_use]

pub fn len(&self) -> usize

Get the size of a set.

Time: O(1)

Examples

assert_eq!(3, ordset![1, 2, 3].len());

pub fn clear(&mut self)

Discard all elements from the set.

This leaves you with an empty set, and all elements that were previously inside it are dropped.

Time: O(n)

Examples

let mut set = ordset![1, 2, 3];
set.clear();
assert!(set.is_empty());

impl<A> OrdSet<A> where
    A: Ord, 

#[must_use]

pub fn get_min(&self) -> Option<&A>

Get the smallest value in a set.

If the set is empty, returns None.

Time: O(log n)

#[must_use]

pub fn get_max(&self) -> Option<&A>

Get the largest value in a set.

If the set is empty, returns None.

Time: O(log n)

Important traits for Iter<'a, A>

impl<'a, A> Iterator for Iter<'a, A> where
    A: 'a + Ord,  type Item = &'a A;

#[must_use]

pub fn iter(&self) -> Iter<A>

Important traits for RangedIter<'a, A>

impl<'a, A> Iterator for RangedIter<'a, A> where
    A: 'a + Ord,  type Item = &'a A;

#[must_use]

pub fn range<R, BA: ?Sized>(&self, range: R) -> RangedIter<A> where
    R: RangeBounds<BA>,
    A: Borrow<BA>,
    BA: Ord, 

Important traits for DiffIter<'a, A>

impl<'a, A> Iterator for DiffIter<'a, A> where
    A: 'a + Ord + PartialEq,  type Item = DiffItem<'a, A>;

#[must_use]

pub fn diff<'a>(&'a self, other: &'a Self) -> DiffIter<A>

Get an iterator over the differences between this set and another, i.e. the set of entries to add or remove to this set in order to make it equal to the other set.

This function will avoid visiting nodes which are shared between the two sets, meaning that even very large sets can be compared quickly if most of their structure is shared.

Time: O(n) (where n is the number of unique elements across the two sets, minus the number of elements belonging to nodes shared between them)

#[must_use]

pub fn contains<BA: ?Sized>(&self, a: &BA) -> bool where
    BA: Ord,
    A: Borrow<BA>, 

Test if a value is part of a set.

Time: O(log n)

Examples

let mut set = ordset!{1, 2, 3};
assert!(set.contains(&1));
assert!(!set.contains(&4));

#[must_use]

pub fn is_subset<RS>(&self, other: RS) -> bool where
    RS: Borrow<Self>, 

Test whether a set is a subset of another set, meaning that all values in our set must also be in the other set.

Time: O(n log m) where m is the size of the other set

#[must_use]

pub fn is_proper_subset<RS>(&self, other: RS) -> bool where
    RS: Borrow<Self>, 

Test whether a set is a proper subset of another set, meaning that all values in our set must also be in the other set. A proper subset must also be smaller than the other set.

Time: O(n log m) where m is the size of the other set

impl<A> OrdSet<A> where
    A: Ord + Clone, 

pub fn insert(&mut self, a: A) -> Option<A>

Insert a value into a set.

Time: O(log n)

Examples

let mut set = ordset!{};
set.insert(123);
set.insert(456);
assert_eq!(
  set,
  ordset![123, 456]
);

pub fn remove<BA: ?Sized>(&mut self, a: &BA) -> Option<A> where
    BA: Ord,
    A: Borrow<BA>, 

Remove a value from a set.

Time: O(log n)

pub fn remove_min(&mut self) -> Option<A>

Remove the smallest value from a set.

Time: O(log n)

pub fn remove_max(&mut self) -> Option<A>

Remove the largest value from a set.

Time: O(log n)

#[must_use]

pub fn update(&self, a: A) -> Self

Construct a new set from the current set with the given value added.

Time: O(log n)

Examples

let set = ordset![456];
assert_eq!(
  set.update(123),
  ordset![123, 456]
);

#[must_use]

pub fn without<BA: ?Sized>(&self, a: &BA) -> Self where
    BA: Ord,
    A: Borrow<BA>, 

Construct a new set with the given value removed if it's in the set.

Time: O(log n)

#[must_use]

pub fn without_min(&self) -> (Option<A>, Self)

Remove the smallest value from a set, and return that value as well as the updated set.

Time: O(log n)

#[must_use]

pub fn without_max(&self) -> (Option<A>, Self)

Remove the largest value from a set, and return that value as well as the updated set.

Time: O(log n)

#[must_use]

pub fn union(self, other: Self) -> Self

Construct the union of two sets.

Time: O(n log n)

Examples

let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1, 2, 3};
assert_eq!(expected, set1.union(set2));

#[must_use]

pub fn unions<I>(i: I) -> Self where
    I: IntoIterator<Item = Self>, 

Construct the union of multiple sets.

Time: O(n log n)

#[must_use]

pub fn difference(self, other: Self) -> Self

Construct the symmetric difference between two sets.

This is an alias for the [symmetric_difference][symmetric_difference] method.

Time: O(n log n)

Examples

let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1, 3};
assert_eq!(expected, set1.difference(set2));

#[must_use]

pub fn symmetric_difference(self, other: Self) -> Self

Construct the symmetric difference between two sets.

Time: O(n log n)

Examples

let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1, 3};
assert_eq!(expected, set1.symmetric_difference(set2));

#[must_use]

pub fn relative_complement(self, other: Self) -> Self

Construct the relative complement between two sets, that is the set of values in self that do not occur in other.

Time: O(m log n) where m is the size of the other set

Examples

let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1};
assert_eq!(expected, set1.relative_complement(set2));

#[must_use]

pub fn intersection(self, other: Self) -> Self

Construct the intersection of two sets.

Time: O(n log n)

Examples

let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{2};
assert_eq!(expected, set1.intersection(set2));

#[must_use]

pub fn split<BA: ?Sized>(self, split: &BA) -> (Self, Self) where
    BA: Ord,
    A: Borrow<BA>, 

Split a set into two, with the left hand set containing values which are smaller than split, and the right hand set containing values which are larger than split.

The split value itself is discarded.

Time: O(n)

#[must_use]

pub fn split_member<BA: ?Sized>(self, split: &BA) -> (Self, bool, Self) where
    BA: Ord,
    A: Borrow<BA>, 

Split a set into two, with the left hand set containing values which are smaller than split, and the right hand set containing values which are larger than split.

Returns a tuple of the two sets and a boolean which is true if the split value existed in the original set, and false otherwise.

Time: O(n)

#[must_use]

pub fn take(&self, n: usize) -> Self

Construct a set with only the n smallest values from a given set.

Time: O(n)

#[must_use]

pub fn skip(&self, n: usize) -> Self

Construct a set with the n smallest values removed from a given set.

Time: O(n)

Trait Implementations

impl<A> Default for OrdSet<A>

fn default() -> Self

Returns the "default value" for a type.

impl<A> Clone for OrdSet<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: Ord> Ord for OrdSet<A>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<A, R> Extend<R> for OrdSet<A> where
    A: Ord + Clone + From<R>, 

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

Extends a collection with the contents of an iterator.

impl<'s, 'a, A: ?Sized, OA> From<&'s OrdSet<&'a A>> for OrdSet<OA> where
    A: ToOwned<Owned = OA> + Ord,
    OA: Borrow<A> + Ord + Clone, 

fn from(set: &OrdSet<&A>) -> Self

Performs the conversion.

impl<'a, A> From<&'a [A]> for OrdSet<A> where
    A: Ord + Clone, 

fn from(slice: &'a [A]) -> Self

Performs the conversion.

impl<A: Ord + Clone> From<Vec<A>> for OrdSet<A>

fn from(vec: Vec<A>) -> Self

Performs the conversion.

impl<'a, A: Ord + Clone> From<&'a Vec<A>> for OrdSet<A>

fn from(vec: &Vec<A>) -> Self

Performs the conversion.

impl<A: Eq + Hash + Ord + Clone> From<HashSet<A, RandomState>> for OrdSet<A>

fn from(hash_set: HashSet<A>) -> Self

Performs the conversion.

impl<'a, A: Eq + Hash + Ord + Clone> From<&'a HashSet<A, RandomState>> for OrdSet<A>

fn from(hash_set: &HashSet<A>) -> Self

Performs the conversion.

impl<A: Ord + Clone> From<BTreeSet<A>> for OrdSet<A>

fn from(btree_set: BTreeSet<A>) -> Self

Performs the conversion.

impl<'a, A: Ord + Clone> From<&'a BTreeSet<A>> for OrdSet<A>

fn from(btree_set: &BTreeSet<A>) -> Self

Performs the conversion.

impl<A: Hash + Eq + Ord + Clone, S: BuildHasher> From<HashSet<A, S>> for OrdSet<A>

fn from(hashset: HashSet<A, S>) -> Self

Performs the conversion.

impl<'a, A: Hash + Eq + Ord + Clone, S: BuildHasher> From<&'a HashSet<A, S>> for OrdSet<A>

fn from(hashset: &HashSet<A, S>) -> Self

Performs the conversion.

impl<A, S> From<OrdSet<A>> for HashSet<A, S> where
    A: Ord + Hash + Eq + Clone,
    S: BuildHasher + Default, 

fn from(ordset: OrdSet<A>) -> Self

Performs the conversion.

impl<'a, A, S> From<&'a OrdSet<A>> for HashSet<A, S> where
    A: Ord + Hash + Eq + Clone,
    S: BuildHasher + Default, 

fn from(ordset: &OrdSet<A>) -> Self

Performs the conversion.

impl<A: Ord + Eq> Eq for OrdSet<A>

impl<A: Ord> PartialOrd<OrdSet<A>> for OrdSet<A>

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl<A: Ord> PartialEq<OrdSet<A>> for OrdSet<A>

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<'a, A> IntoIterator for &'a OrdSet<A> where
    A: 'a + Ord, 

type Item = &'a A

The type of the elements being iterated over.

type IntoIter = Iter<'a, A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A> IntoIterator for OrdSet<A> where
    A: Ord + Clone, 

type Item = A

The type of the elements being iterated over.

type IntoIter = ConsumingIter<A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A: Ord + Debug> Debug for OrdSet<A>

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

Formats the value using the given formatter.

impl<A: Ord + Clone> Add<OrdSet<A>> for OrdSet<A>

type Output = OrdSet<A>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<'a, A: Ord + Clone> Add<&'a OrdSet<A>> for &'a OrdSet<A>

type Output = OrdSet<A>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<A: Ord + Clone> Mul<OrdSet<A>> for OrdSet<A>

type Output = OrdSet<A>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<'a, A: Ord + Clone> Mul<&'a OrdSet<A>> for &'a OrdSet<A>

type Output = OrdSet<A>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<A: Ord + Hash> Hash for OrdSet<A>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<A: Ord + Clone> Sum<OrdSet<A>> for OrdSet<A>

fn sum<I>(it: I) -> Self where
    I: Iterator<Item = Self>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl<A, R> FromIterator<R> for OrdSet<A> where
    A: Ord + Clone + From<R>, 

fn from_iter<T>(i: T) -> Self where
    T: IntoIterator<Item = R>, 

Creates a value from an iterator.