Struct im::ordmap::OrdMap

pub struct OrdMap<K, V> { /* fields omitted */ }

Ordered Map

An immutable ordered map implemented as a B-tree.

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

Methods

impl<K, V> OrdMap<K, V>

pub fn new() -> Self

Construct an empty map.

pub fn singleton<RK, RV>(key: RK, value: RV) -> Self where
    RK: Shared<K>,
    RV: Shared<V>, 

Construct a map with a single mapping.

Examples

let map = OrdMap::singleton(123, "onetwothree");
assert_eq!(
  map.get(&123),
  Some(Arc::new("onetwothree"))
);

pub fn is_empty(&self) -> bool

Test whether a map is empty.

Time: O(1)

Examples

assert!(
  !ordmap!{1 => 2}.is_empty()
);
assert!(
  OrdMap::<i32, i32>::new().is_empty()
);

pub fn len(&self) -> usize

Get the size of a map.

Time: O(1)

Examples

assert_eq!(3, ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.len());

pub fn get_max(&self) -> Option<(Arc<K>, Arc<V>)>

Get the largest key in a map, along with its value. If the map is empty, return None.

Time: O(log n)

Examples

assert_eq!(Some((Arc::new(3), Arc::new(33))), ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.get_max());

pub fn get_min(&self) -> Option<(Arc<K>, Arc<V>)>

Get the smallest key in a map, along with its value. If the map is empty, return None.

Time: O(log n)

Examples

assert_eq!(Some((Arc::new(1), Arc::new(11))), ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.get_min());

impl<K: Ord, V> OrdMap<K, V>

pub fn iter(&self) -> Iter<(Arc<K>, Arc<V>)>

Get an iterator over the key/value pairs of a map.

Important traits for Keys<K, V>

impl<K, V> Iterator for Keys<K, V> where
    K: Ord,  type Item = Arc<K>;

pub fn keys(&self) -> Keys<K, V>

Get an iterator over a map's keys.

Important traits for Values<K, V>

impl<K, V> Iterator for Values<K, V> where
    K: Ord,  type Item = Arc<V>;

pub fn values(&self) -> Values<K, V>

Get an iterator over a map's values.

pub fn get(&self, k: &K) -> Option<Arc<V>>

Get the value for a key from a map.

Time: O(log n)

Examples

let map = ordmap!{123 => "lol"};
assert_eq!(
  map.get(&123),
  Some(Arc::new("lol"))
);

pub fn get_or<RV>(&self, k: &K, default: RV) -> Arc<V> where
    RV: Shared<V>, 

Get the value for a key from a map, or a default value if the key isn't in the map.

Time: O(log n)

Examples

let map = ordmap!{123 => "lol"};
assert_eq!(
  map.get_or(&123, "hi"),
  Arc::new("lol")
);
assert_eq!(
  map.get_or(&321, "hi"),
  Arc::new("hi")
);

pub fn contains_key(&self, k: &K) -> bool

Test for the presence of a key in a map.

Time: O(log n)

Examples

let map = ordmap!{123 => "lol"};
assert!(
  map.contains_key(&123)
);
assert!(
  !map.contains_key(&321)
);

pub fn set<RK, RV>(&self, k: RK, v: RV) -> Self where
    RK: Shared<K>,
    RV: Shared<V>, 

Construct a new map by inserting a key/value mapping into a map.

This is an alias for insert.

pub fn set_mut<RK, RV>(&mut self, k: RK, v: RV) where
    RK: Shared<K>,
    RV: Shared<V>, 

Insert a key/value mapping into a map, mutating it in place when it is safe to do so.

This is an alias for insert_mut.

pub fn insert<RK, RV>(&self, k: RK, v: RV) -> Self where
    RK: Shared<K>,
    RV: Shared<V>, 

Construct a new map by inserting a key/value mapping into a map.

If the map already has a mapping for the given key, the previous value is overwritten.

Time: O(log n)

Examples

let map = ordmap!{};
assert_eq!(
  map.insert(123, "123"),
  ordmap!{123 => "123"}
);

pub fn insert_mut<RK, RV>(&mut self, k: RK, v: RV) where
    RK: Shared<K>,
    RV: Shared<V>, 

Insert a key/value mapping into a map.

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

If the map already has a mapping for the given key, the previous value is overwritten.

Time: O(log n)

Examples

let mut map = ordmap!{};
map.insert_mut(123, "123");
map.insert_mut(456, "456");
assert_eq!(
  map,
  ordmap!{123 => "123", 456 => "456"}
);

pub fn insert_with<RK, RV, F>(self, k: RK, v: RV, f: F) -> Self where
    RK: Shared<K>,
    RV: Shared<V>,
    F: FnOnce(Arc<V>, Arc<V>) -> Arc<V>, 

Construct a new map by inserting a key/value mapping into a map.

If the map already has a mapping for the given key, we call the provided function with the old value and the new value, and insert the result as the new value.

Time: O(log n)

pub fn insert_with_key<RK, RV, F>(self, k: RK, v: RV, f: F) -> Self where
    F: FnOnce(Arc<K>, Arc<V>, Arc<V>) -> Arc<V>,
    RK: Shared<K>,
    RV: Shared<V>, 

Construct a new map by inserting a key/value mapping into a map.

If the map already has a mapping for the given key, we call the provided function with the key, the old value and the new value, and insert the result as the new value.

Time: O(log n)

pub fn insert_lookup_with_key<RK, RV, F>(
    self,
    k: RK,
    v: RV,
    f: F
) -> (Option<Arc<V>>, Self) where
    F: FnOnce(Arc<K>, Arc<V>, Arc<V>) -> Arc<V>,
    RK: Shared<K>,
    RV: Shared<V>, 

Construct a new map by inserting a key/value mapping into a map, returning the old value for the key as well as the new map.

If the map already has a mapping for the given key, we call the provided function with the key, the old value and the new value, and insert the result as the new value.

Time: O(log n)

pub fn update<F>(&self, k: &K, f: F) -> Self where
    F: FnOnce(Arc<V>) -> Option<Arc<V>>, 

Update the value for a given key by calling a function with the current value and overwriting it with the function's return value.

Time: O(log n)

pub fn update_with_key<F>(&self, k: &K, f: F) -> Self where
    F: FnOnce(Arc<K>, Arc<V>) -> Option<Arc<V>>, 

Update the value for a given key by calling a function with the key and the current value and overwriting it with the function's return value.

Time: O(log n)

pub fn update_lookup_with_key<F>(&self, k: &K, f: F) -> (Option<Arc<V>>, Self) where
    F: FnOnce(Arc<K>, Arc<V>) -> Option<Arc<V>>, 

Update the value for a given key by calling a function with the key and the current value and overwriting it with the function's return value.

If the key was not in the map, the function is never called and the map is left unchanged.

Return a tuple of the old value, if there was one, and the new map.

Time: O(log n)

pub fn alter<RK, F>(&self, f: F, k: RK) -> Self where
    F: FnOnce(Option<Arc<V>>) -> Option<Arc<V>>,
    RK: Shared<K>, 

Update the value for a given key by calling a function with the current value and overwriting it with the function's return value.

This is like the update method, except with more control: the function gets an Option<V> and returns the same, so that it can decide to delete a mapping instead of updating the value, and decide what to do if the key isn't in the map.

Time: O(log n)

pub fn remove(&self, k: &K) -> Self

Remove a key/value pair from a map, if it exists.

Time: O(log n)

pub fn remove_mut(&mut self, k: &K)

Remove a key/value mapping from a map if it exists, mutating it in place when it is safe to do so.

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

Time: O(log n)

Examples

let mut map = ordmap!{123 => "123", 456 => "456"};
map.remove_mut(&123);
map.remove_mut(&456);
assert!(map.is_empty());

pub fn pop(&self, k: &K) -> Option<(Arc<V>, Self)>

Remove a key/value pair from a map, if it exists, and return the removed value as well as the updated list.

Time: O(log n)

pub fn pop_mut(&mut self, k: &K) -> Option<Arc<V>>

Remove a key/value pair from a map, if it exists, and return the removed value.

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

Time: O(log n)

pub fn pop_with_key(&self, k: &K) -> Option<(Arc<K>, Arc<V>, Self)>

Remove a key/value pair from a map, if it exists, and return the removed key and value as well as the updated list.

Time: O(log n)

pub fn pop_with_key_mut(&mut self, k: &K) -> Option<(Arc<K>, Arc<V>)>

Remove a key/value pair from a map, if it exists, and return the removed key and value.

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

Time: O(log n)

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

Construct the union of two maps, keeping the values in the current map when keys exist in both maps.

pub fn union_with<F, RM>(&self, other: RM, f: F) -> Self where
    F: Fn(Arc<V>, Arc<V>) -> Arc<V>,
    RM: Borrow<Self>, 

Construct the union of two maps, using a function to decide what to do with the value when a key is in both maps.

pub fn union_with_key<F, RM>(&self, other: RM, f: F) -> Self where
    F: Fn(Arc<K>, Arc<V>, Arc<V>) -> Arc<V>,
    RM: Borrow<Self>, 

Construct the union of two maps, using a function to decide what to do with the value when a key is in both maps. The function receives the key as well as both values.

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

Construct the union of a sequence of maps, selecting the value of the leftmost when a key appears in more than one map.

pub fn unions_with<I, F>(i: I, f: F) -> Self where
    I: IntoIterator<Item = Self>,
    F: Fn(Arc<V>, Arc<V>) -> Arc<V>, 

Construct the union of a sequence of maps, using a function to decide what to do with the value when a key is in more than one map.

pub fn unions_with_key<I, F>(i: I, f: F) -> Self where
    I: IntoIterator<Item = Self>,
    F: Fn(Arc<K>, Arc<V>, Arc<V>) -> Arc<V>, 

Construct the union of a sequence of maps, using a function to decide what to do with the value when a key is in more than one map. The function receives the key as well as both values.

pub fn difference<B, RM>(&self, other: RM) -> Self where
    RM: Borrow<OrdMap<K, B>>, 

Construct the difference between two maps by discarding keys which occur in both maps.

pub fn difference_with<B, RM, F>(&self, other: RM, f: F) -> Self where
    F: Fn(Arc<V>, Arc<B>) -> Option<Arc<V>>,
    RM: Borrow<OrdMap<K, B>>, 

Construct the difference between two maps by using a function to decide what to do if a key occurs in both.

pub fn difference_with_key<B, RM, F>(&self, other: RM, f: F) -> Self where
    F: Fn(Arc<K>, Arc<V>, Arc<B>) -> Option<Arc<V>>,
    RM: Borrow<OrdMap<K, B>>, 

Construct the difference between two maps by using a function to decide what to do if a key occurs in both. The function receives the key as well as both values.

pub fn intersection<B, RM>(&self, other: RM) -> Self where
    RM: Borrow<OrdMap<K, B>>, 

Construct the intersection of two maps, keeping the values from the current map.

pub fn intersection_with<B, C, RM, F>(&self, other: RM, f: F) -> OrdMap<K, C> where
    F: Fn(Arc<V>, Arc<B>) -> Arc<C>,
    RM: Borrow<OrdMap<K, B>>, 

Construct the intersection of two maps, calling a function with both values for each key and using the result as the value for the key.

pub fn intersection_with_key<B, C, RM, F>(
    &self,
    other: RM,
    f: F
) -> OrdMap<K, C> where
    F: Fn(Arc<K>, Arc<V>, Arc<B>) -> Arc<C>,
    RM: Borrow<OrdMap<K, B>>, 

Construct the intersection of two maps, calling a function with the key and both values for each key and using the result as the value for the key.

pub fn merge_with_key<B, C, RM, FC, F1, F2>(
    &self,
    other: RM,
    combine: FC,
    only1: F1,
    only2: F2
) -> OrdMap<K, C> where
    RM: Borrow<OrdMap<K, B>>,
    FC: Fn(Arc<K>, Arc<V>, Arc<B>) -> Option<Arc<C>>,
    F1: FnOnce(Self) -> OrdMap<K, C>,
    F2: FnOnce(OrdMap<K, B>) -> OrdMap<K, C>, 

Merge two maps.

First, we call the combine function for each key/value pair which exists in both maps, updating the value or discarding it according to the function's return value.

The only1 and only2 functions are called with the key/value pairs which are only in the first and the second list respectively. The results of these are then merged with the result of the first operation.

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

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

The split mapping is discarded.

pub fn split_lookup(&self, split: &K) -> (Self, Option<Arc<V>>, Self)

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

Returns both the two maps and the value of split.

pub fn is_submap_by<B, RM, F>(&self, other: RM, cmp: F) -> bool where
    F: Fn(Arc<V>, Arc<B>) -> bool,
    RM: Borrow<OrdMap<K, B>>, 

Test whether a map is a submap of another map, meaning that all keys in our map must also be in the other map, with the same values.

Use the provided function to decide whether values are equal.

pub fn is_proper_submap_by<B, RM, F>(&self, other: RM, cmp: F) -> bool where
    F: Fn(Arc<V>, Arc<B>) -> bool,
    RM: Borrow<OrdMap<K, B>>, 

Test whether a map is a proper submap of another map, meaning that all keys in our map must also be in the other map, with the same values. To be a proper submap, ours must also contain fewer keys than the other map.

Use the provided function to decide whether values are equal.

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

Construct a map with only the n smallest keys from a given map.

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

Construct a map with the n smallest keys removed from a given map.

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

Remove the smallest key from a map, and return its value as well as the updated map.

pub fn pop_min_with_key(&self) -> (Option<(Arc<K>, Arc<V>)>, Self)

Remove the smallest key from a map, and return that key, its value as well as the updated map.

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

Remove the largest key from a map, and return its value as well as the updated map.

pub fn pop_max_with_key(&self) -> (Option<(Arc<K>, Arc<V>)>, Self)

Remove the largest key from a map, and return that key, its value as well as the updated map.

pub fn delete_min(&self) -> Self

Discard the smallest key from a map, returning the updated map.

pub fn delete_max(&self) -> Self

Discard the largest key from a map, returning the updated map.

pub fn is_submap<RM>(&self, other: RM) -> bool where
    V: PartialEq,
    RM: Borrow<Self>, 

Test whether a map is a submap of another map, meaning that all keys in our map must also be in the other map, with the same values.

pub fn is_proper_submap<RM>(&self, other: RM) -> bool where
    V: PartialEq,
    RM: Borrow<Self>, 

Test whether a map is a proper submap of another map, meaning that all keys in our map must also be in the other map, with the same values. To be a proper submap, ours must also contain fewer keys than the other map.

Trait Implementations

impl<K, V> Clone for OrdMap<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Ord + PartialEq, V: PartialEq> PartialEq for OrdMap<K, V>

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<K: Ord + Eq, V: Eq> Eq for OrdMap<K, V>

impl<K: PartialOrd, V: PartialOrd> PartialOrd for OrdMap<K, V> where
    K: Ord, 

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<K: Ord, V: Ord> Ord for OrdMap<K, V>

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<K: Ord + Hash, V: Hash> Hash for OrdMap<K, V>

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<K, V> Default for OrdMap<K, V>

fn default() -> Self

Returns the "default value" for a type.

impl<'a, K: Ord, V> Add for &'a OrdMap<K, V>

type Output = OrdMap<K, V>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<K: Ord, V> Add for OrdMap<K, V>

type Output = OrdMap<K, V>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<K, V> Sum for OrdMap<K, V> where
    K: Ord, 

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<K, V, RK, RV> Extend<(RK, RV)> for OrdMap<K, V> where
    K: Ord,
    RK: Shared<K>,
    RV: Shared<V>, 

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

Extends a collection with the contents of an iterator.

impl<'a, K, V> Index<&'a K> for OrdMap<K, V> where
    K: Ord, 

type Output = V

The returned type after indexing.

fn index(&self, key: &K) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, K, V> IndexMut<&'a K> for OrdMap<K, V> where
    K: Ord,
    V: Clone, 

fn index_mut(&mut self, key: &K) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<K: Debug, V: Debug> Debug for OrdMap<K, V> where
    K: Ord, 

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

Formats the value using the given formatter.

impl<K: Ord, V, RK, RV> FromIterator<(RK, RV)> for OrdMap<K, V> where
    RK: Shared<K>,
    RV: Shared<V>, 

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

Creates a value from an iterator.

impl<'a, K, V> IntoIterator for &'a OrdMap<K, V> where
    K: Ord, 

type Item = (Arc<K>, Arc<V>)

The type of the elements being iterated over.

type IntoIter = Iter<(Arc<K>, Arc<V>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> IntoIterator for OrdMap<K, V> where
    K: Ord, 

type Item = (Arc<K>, Arc<V>)

The type of the elements being iterated over.

type IntoIter = Iter<(Arc<K>, Arc<V>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> AsRef<OrdMap<K, V>> for OrdMap<K, V>

fn as_ref(&self) -> &Self

Performs the conversion.

impl<'a, K: Ord, V: Clone, RK, RV> From<&'a [(RK, RV)]> for OrdMap<K, V> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>, 

fn from(m: &'a [(RK, RV)]) -> OrdMap<K, V>

Performs the conversion.

impl<K: Ord, V, RK, RV> From<Vec<(RK, RV)>> for OrdMap<K, V> where
    RK: Shared<K>,
    RV: Shared<V>, 

fn from(m: Vec<(RK, RV)>) -> OrdMap<K, V>

Performs the conversion.

impl<'a, K: Ord, V, RK, RV> From<&'a Vec<(RK, RV)>> for OrdMap<K, V> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>, 

fn from(m: &'a Vec<(RK, RV)>) -> OrdMap<K, V>

Performs the conversion.

impl<K: Ord, V, RK: Eq + Hash, RV> From<HashMap<RK, RV>> for OrdMap<K, V> where
    RK: Shared<K>,
    RV: Shared<V>, 

fn from(m: HashMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<'a, K: Ord, V, RK: Eq + Hash, RV> From<&'a HashMap<RK, RV>> for OrdMap<K, V> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>, 

fn from(m: &'a HashMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<K: Ord, V, RK, RV> From<BTreeMap<RK, RV>> for OrdMap<K, V> where
    RK: Shared<K>,
    RV: Shared<V>, 

fn from(m: BTreeMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<'a, K: Ord, V, RK, RV> From<&'a BTreeMap<RK, RV>> for OrdMap<K, V> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>, 

fn from(m: &'a BTreeMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<K: Ord + Hash + Eq, V, S: BuildHasher> From<HashMap<K, V, S>> for OrdMap<K, V>

fn from(m: HashMap<K, V, S>) -> Self

Performs the conversion.

impl<'a, K: Ord + Hash + Eq, V, S: BuildHasher> From<&'a HashMap<K, V, S>> for OrdMap<K, V>

fn from(m: &'a HashMap<K, V, S>) -> Self

Performs the conversion.