Gee.TreeMap – gee-0.8 Reference Manual

TreeMap

Object Hierarchy:

Description:

public class TreeMap<K,V> : AbstractBidirSortedMap<K,V>

Left-leaning red-black tree implementation of the Map interface.

This implementation is especially well designed for large quantity of data. The (balanced) tree implementation insure that the set and get methods are in logarithmic complexity.

Content:

Properties:

public override SortedSet<Entry<K,V>> ascending_entries { owned get; }
Returns the entries in ascending order.
public override SortedSet<K> ascending_keys { owned get; }
Returns the keys in ascending order.
public override Set<Entry<K,V>> entries { owned get; }
The read-only view of the entries of this map.
public CompareDataFunc<K> key_compare_func { get; }
The keys' comparator function.
public override Set<K> keys { owned get; }
The read-only view of the keys of this map.
public override bool read_only { get; }
public override int size { get; }
The number of items in this map.
public EqualDataFunc<V> value_equal_func { get; }
The values' equality testing function.
public override Collection<V> values { owned get; }
The read-only view of the values of this map.

Creation methods:

public TreeMap (owned CompareDataFunc<K>? key_compare_func = null, owned EqualDataFunc<V>? value_equal_func = null)
Constructs a new, empty tree map sorted according to the specified comparator function.

Methods:

public override V @get (K key)
Returns the value of the specified key in this map.
public override void @set (K key, V value)
Inserts a new key and value into this map.
public override BidirMapIterator<K,V> bidir_map_iterator ()
Returns a bi-directional iterator for this map.
public override void clear ()
Removes all items from this collection. Must not be called on read- only collections.
public override bool has (K key, V value)
Determines whether this map has the specified key/value entry.
public override bool has_key (K key)
Determines whether this map has the specified key.
public override SortedMap<K,V> head_map (K before)
Returns map containing pairs with key strictly lower the the argument.
public override MapIterator<K,V> map_iterator ()
Returns an iterator for this map.
public override SortedMap<K,V> sub_map (K after, K before)
Returns right-open map (i.e. containing all pair which key is strictly lower then the second argument and equal or bigger then the first one).
public override SortedMap<K,V> tail_map (K after)
Returns map containing pairs with key equal or larger then the argument.
public override bool unset (K key, out V value = null)
Removes the specified key from this map.