Minilib.Collection.TreeMap
Defined in minilib-collection@0.5.1
TreeMap is a map that manages keys in sorted order.
Values
namespace Minilib.Collection.TreeMap::TreeMap
contains_key
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] k -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Bool
Checks whether a TreeMap contains a key.
erase
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] k -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v
Erases an entry from a TreeMap.
For example, tm.erase(k) removes an entry (k,v) from tm.
NOTE: If tm contains an entry (k1,v1)
where the key k1 is equivalent to k,
ie. !less_than(k,k1) && !less_than(k1,k) is true,
then (k1,v1) is removed.
find
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] k -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Option v
Finds an element from a TreeMap.
find_range
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] k -> k -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Iterator::DynIterator (k, v)
tm.find_range(begin, end) finds all entries (k,v)
where !less_than(k, begin) && less_than(k, end) is true.
In default LessThan ordering, that condition is same as begin <= k && k < end.
find_raw_range
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] ((k, v) -> Std::Bool) -> ((k, v) -> Std::Bool) -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Iterator::DynIterator (k, v)
tm.find_raw_range(lt_begin, lt_end) finds all entries (k,v)
where !lt_begin((k, v)) && lt_end((k, v)) is true.
NOTE: lt_begin and lt_end must meet following condition:
for all (k,v), lt_begin((k,v)) is true then lt_end((k,v)) must be true.
from_iter
Type: [k : Std::LessThan, k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue, it : Std::Iterator, Std::Iterator::Item it = (k, v)] it -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v
Converts an iterator of key-value pairs into a TreeMap using default LessThan ordering.
from_iter_lt
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue, it : Std::Iterator, Std::Iterator::Item it = (k, v)] (k -> k -> Std::Bool) -> it -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v
Converts an iterator of key-value pairs into a TreeMap using specified ordering.
get_size
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::I64
Gets the number of entries.
insert
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] k -> v -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v
Inserts an entry into a TreeMap.
For example, tm.insert(k, v) inserts an entry (k,v) into tm.
NOTE: If tm already contains an entry (k1,v1)
where the key k1 is equivalent to k,
ie. !less_than(k,k1) && !less_than(k1,k) is true,
then (k1,v1) is replaced with (k,v).
is_empty
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Bool
Checks whether a TreeMap is empty.
keys
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Iterator::DynIterator k
Returns an iterator of keys in ascending order.
make
Type: [k : Std::LessThan, k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] () -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v
TreeMap::make() creates an empty TreeMap using default LessThan ordering.
make_lt
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] (k -> k -> Std::Bool) -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v
TreeMap::make_lt(less_than) creates an empty TreeMap using specified ordering.
NOTE: less_than function must meet specific conditions. For details, see documentation of
RBTree.
to_array
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Array (k, v)
Converts a TreeMap into an array of key-value pairs in ascending order of keys.
to_iter
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Std::Iterator::DynIterator (k, v)
Converts a TreeMap into an iterator of key-value pairs in ascending order of keys.
upsert
Type: [k : Minilib.Collection.TreeMap::TreeMap::TreeMapKey, v : Minilib.Collection.TreeMap::TreeMap::TreeMapValue] k -> v -> (v -> v) -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v -> Minilib.Collection.TreeMap::TreeMap::TreeMap k v
Inserts or updates an entry in a TreeMap.
For example, tm.upsert(k, v, updater) inserts an entry (k,v) into tm.
NOTE: If tm already contains an entry (k1,v1)
where the key k1 is equivalent to k,
ie. !less_than(k,k1) && !less_than(k1,k) is true,
then (k1,v1) is replaced with (k, updater(v1)).
Types and aliases
namespace Minilib.Collection.TreeMap::TreeMap
TreeMap
Defined as: type TreeMap k v = unbox struct { ...fields... }
TreeMap is a structure that stores key-value pairs into a red-black tree.
field root
Type: Minilib.Collection.RBTree::RBNode::RBNode (k, v)
field key_less_than
Type: k -> k -> Std::Bool
field entry_less_than
Type: (k, v) -> (k, v) -> Std::Bool