Struct im::OrdMap[][src]

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

An 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> where
    K: Ord + Clone,
    V: Clone
[src]

Construct an empty map.

Construct a map with a single mapping.

Examples

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

Test whether a map is empty.

Time: O(1)

Examples

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

Get the size of a map.

Time: O(1)

Examples

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

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(&(3, 33)), ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.get_max());

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(&(1, 11)), ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.get_min());

Important traits for Iter<'a, A>

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

Important traits for Iter<'a, A>

Important traits for Keys<'a, K, V>

Get an iterator over a map's keys.

Important traits for Values<'a, K, V>

Get an iterator over a map's values.

Important traits for DiffIter<'a, A>

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

This function will avoid visiting nodes which are shared between the two maps, meaning that even very large maps 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 maps, minus the number of elements belonging to nodes shared between them)

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(&"lol")
);

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

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(123, "123");
map.insert(456, "456");
assert_eq!(
  map,
  ordmap!{123 => "123", 456 => "456"}
);

Remove a key/value mapping from a map if it exists.

Time: O(log n)

Examples

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

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

Time: O(log n)

Discard all elements from the map.

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

Time: O(n)

Examples

let mut map = ordmap![1=>1, 2=>2, 3=>3];
map.clear();
assert!(map.is_empty());

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.update(123, "123"),
  ordmap!{123 => "123"}
);

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)

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)

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)

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

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)

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

Time: O(log n)

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)

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)

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

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 3};
let map2 = ordmap!{2 => 2, 3 => 4};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert_eq!(expected, map1.union(map2));

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 is called when a value exists in both maps, and receives the value from the current map as its first argument, and the value from the other map as the second. It should return the value to be inserted in the resulting map.

Time: O(n log n)

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 is called when a value exists in both maps, and receives a reference to the key as its first argument, the value from the current map as the second argument, and the value from the other map as the third argument. It should return the value to be inserted in the resulting map.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 9};
assert_eq!(expected, map1.union_with_key(
    map2,
    |key, left, right| left + right
));

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

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 3};
let map2 = ordmap!{2 => 2};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert_eq!(expected, OrdMap::unions(vec![map1, map2]));

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 is called when a value exists in multiple maps, and receives the value from the current map as its first argument, and the value from the next map as the second. It should return the value to be inserted in the resulting map.

Time: O(n log n)

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 is called when a value exists in multiple maps, and receives a reference to the key as its first argument, the value from the current map as the second argument, and the value from the next map as the third argument. It should return the value to be inserted in the resulting map.

Time: O(n log n)

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

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2};
assert_eq!(expected, map1.difference(map2));

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

Time: O(n log n)

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.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 9};
assert_eq!(expected, map1.difference_with_key(
    map2,
    |key, left, right| Some(left + right)
));

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

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{2 => 3, 3 => 4};
let expected = ordmap!{2 => 2};
assert_eq!(expected, map1.intersection(map2));

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.

Time: O(n log n)

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.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{2 => 3, 3 => 4};
let expected = ordmap!{2 => 5};
assert_eq!(expected, map1.intersection_with_key(
    map2,
    |key, left, right| left + right
));

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.

Time: O(n log n)

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.

Time: O(n log n)

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.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert!(map1.is_submap(map2));

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.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert!(map1.is_proper_submap(map2));

let map3 = ordmap!{1 => 1, 2 => 2};
let map4 = ordmap!{1 => 1, 2 => 2};
assert!(!map3.is_proper_submap(map4));

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.

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.

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

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

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

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

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

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

Trait Implementations

impl<K, V> Clone for OrdMap<K, V>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<K, V> PartialEq for OrdMap<K, V> where
    K: Ord + PartialEq + Clone,
    V: PartialEq + Clone
[src]

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

This method tests for !=.

impl<K: Ord + Clone + Eq, V: Clone + Eq> Eq for OrdMap<K, V>
[src]

impl<K, V> PartialOrd for OrdMap<K, V> where
    K: Ord + Clone,
    V: PartialOrd + Clone
[src]

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

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

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

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

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

impl<K, V> Ord for OrdMap<K, V> where
    K: Ord + Clone,
    V: Ord + Clone
[src]

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl<K, V> Hash for OrdMap<K, V> where
    K: Ord + Clone + Hash,
    V: Clone + Hash
[src]

Feeds this value into the given [Hasher]. Read more

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

impl<K, V> Default for OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone
[src]

Returns the "default value" for a type. Read more

impl<'a, K, V> Add for &'a OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone
[src]

The resulting type after applying the + operator.

Performs the + operation.

impl<K, V> Add for OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone
[src]

The resulting type after applying the + operator.

Performs the + operation.

impl<K, V> Sum for OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone
[src]

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

impl<K, V, RK, RV> Extend<(RK, RV)> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 
[src]

Extends a collection with the contents of an iterator. Read more

impl<'a, BK: ?Sized, K, V> Index<&'a BK> for OrdMap<K, V> where
    BK: Ord,
    K: Ord + Clone + Borrow<BK>,
    V: Clone
[src]

The returned type after indexing.

Performs the indexing (container[index]) operation.

impl<'a, BK: ?Sized, K, V> IndexMut<&'a BK> for OrdMap<K, V> where
    BK: Ord,
    K: Ord + Clone + Borrow<BK>,
    V: Clone
[src]

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

impl<K, V> Debug for OrdMap<K, V> where
    K: Ord + Clone + Debug,
    V: Clone + Debug
[src]

Formats the value using the given formatter. Read more

impl<K, V, RK, RV> FromIterator<(RK, RV)> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 
[src]

Creates a value from an iterator. Read more

impl<'a, K, V> IntoIterator for &'a OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

impl<K, V> IntoIterator for OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

impl<K, V> AsRef<OrdMap<K, V>> for OrdMap<K, V>
[src]

Performs the conversion.

impl<'m, 'k, 'v, K: ?Sized, V: ?Sized, OK, OV> From<&'m OrdMap<&'k K, &'v V>> for OrdMap<OK, OV> where
    K: Ord + ToOwned<Owned = OK>,
    V: ToOwned<Owned = OV>,
    OK: Ord + Clone + Borrow<K>,
    OV: Clone + Borrow<V>, 
[src]

Performs the conversion.

impl<'a, K, V, RK, RV, OK, OV> From<&'a [(RK, RV)]> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 
[src]

Performs the conversion.

impl<K, V, RK, RV> From<Vec<(RK, RV)>> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 
[src]

Performs the conversion.

impl<'a, K: Ord, V, RK, RV, OK, OV> From<&'a Vec<(RK, RV)>> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 
[src]

Performs the conversion.

impl<K: Ord, V, RK: Eq + Hash, RV> From<HashMap<RK, RV>> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 
[src]

Performs the conversion.

impl<'a, K, V, OK, OV, RK, RV> From<&'a HashMap<RK, RV>> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: Hash + Eq + ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 
[src]

Performs the conversion.

impl<K: Ord, V, RK, RV> From<BTreeMap<RK, RV>> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 
[src]

Performs the conversion.

impl<'a, K: Ord, V, RK, RV, OK, OV> From<&'a BTreeMap<RK, RV>> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: Ord + ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 
[src]

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

Auto Trait Implementations

impl<K, V> Send for OrdMap<K, V> where
    K: Send + Sync,
    V: Send + Sync

impl<K, V> Sync for OrdMap<K, V> where
    K: Send + Sync,
    V: Send + Sync