Struct im::ordset::OrdSet

pub struct OrdSet<A>(_);

Ordered Set

This is implemented as an OrdMap with no values, so it shares the exact performance characteristics of OrdMap.

Methods

impl<A> OrdSet<A>

pub fn new() -> Self

Construct an empty set.

pub fn singleton<R>(a: R) -> Self where
    R: Shared<A>, 

Construct a set with a single value.

Examples

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

Important traits for Iter<A>

impl<A> Iterator for Iter<A> where
    A: Ord,  type Item = Arc<A>;

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

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()
);

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 get_min(&self) -> Option<Arc<A>>

Get the smallest value in a set.

If the set is empty, returns None.

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

Get the largest value in a set.

If the set is empty, returns None.

impl<A: Ord> OrdSet<A>

pub fn insert<R>(&self, a: R) -> Self where
    R: Shared<A>, 

Insert a value into a set.

Time: O(log n)

Examples

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

pub fn insert_mut<R>(&mut self, a: R) where
    R: Shared<A>, 

Insert a value into a set.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

Examples

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

pub fn contains(&self, a: &A) -> bool

Test if a value is part of a set.

Time: O(log n)

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

Remove a value from a set.

Time: O(log n)

pub fn remove_mut<R>(&mut self, a: &A)

Remove a value from a set.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

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

Construct the union of two sets.

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

Construct the union of multiple sets.

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

Construct the difference between two sets.

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

Construct the intersection of two sets.

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

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.

pub fn split_member(&self, split: &A) -> (Self, bool, Self)

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 maps and a boolean which is true if the split value existed in the original set, and false otherwise.

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.

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.

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

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

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

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

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

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

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

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

pub fn remove_min(&self) -> Self

Discard the smallest value from a set, returning the updated set.

pub fn remove_max(&self) -> Self

Discard the largest value from a set, returning the updated set.

Trait Implementations

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 + PartialEq> PartialEq for OrdSet<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 !=.

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

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

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

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

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

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

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

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

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> 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.

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> Default for OrdSet<A>

fn default() -> Self

Returns the "default value" for a type.

impl<'a, A: Ord> Add 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, A: Ord> Mul 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 + Debug> Debug for OrdSet<A>

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

Formats the value using the given formatter.

impl<A: Ord, RA> FromIterator<RA> for OrdSet<A> where
    RA: Shared<A>, 

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

Creates a value from an iterator.

impl<'a, A> IntoIterator for &'a OrdSet<A> where
    A: Ord, 

type Item = Arc<A>

The type of the elements being iterated over.

type IntoIter = Iter<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, 

type Item = Arc<A>

The type of the elements being iterated over.

type IntoIter = Iter<A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

Performs the conversion.

impl<'a, A: Ord> From<&'a [Arc<A>]> for OrdSet<A>

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

Performs the conversion.

impl<A: Ord> 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, A: Ord> From<&'a Vec<Arc<A>>> for OrdSet<A>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<A: Ord> 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, A: Ord> From<&'a BTreeSet<Arc<A>>> for OrdSet<A>

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

Performs the conversion.

impl<A: Ord, S> From<HashSet<A, S>> for OrdSet<A>

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

Performs the conversion.

impl<'a, A: Ord, S> From<&'a HashSet<A, S>> for OrdSet<A>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.