C5 doc: TreeDictionary<K,V>

Class `TreeDictionary<K,V>`

A sorted generic dictionary based on a red-black tree set.

Implements

System.Collections.Generic.IEnumerable<KeyValuePair<K,V>>, System.Collections.IEnumerable, System.IFormattable, System.ICloneable, ICollectionValue<KeyValuePair<K,V>>, IDictionary<K,V>, IShowable, ISortedDictionary<K,V>

Bases

object, EnumerableBase<KeyValuePair<K,V>>, CollectionValueBase<KeyValuePair<K,V>>, DictionaryBase<K,V>, SortedDictionaryBase<K,V>

Field overview

pairs, Inherited from DictionaryBase<K,V> ,
sortedpairs, Inherited from SortedDictionaryBase<K,V>

Event overview

CollectionChanged, Inherited from DictionaryBase<K,V> ,
CollectionCleared, Inherited from DictionaryBase<K,V> ,
ItemInserted, Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
ItemRemovedAt, Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
ItemsAdded, Inherited from DictionaryBase<K,V> ,
ItemsRemoved, Inherited from DictionaryBase<K,V>

Property overview

ActiveEvents, Inherited from DictionaryBase<K,V> ,
Comparer, Inherited from SortedDictionaryBase<K,V> ,
ContainsSpeed, Inherited from DictionaryBase<K,V> ,
Count, Inherited from DictionaryBase<K,V> ,
CountSpeed, Inherited from DictionaryBase<K,V> ,
EqualityComparer, Inherited from DictionaryBase<K,V> ,
Fun, Inherited from DictionaryBase<K,V> ,
IsEmpty, Inherited from DictionaryBase<K,V> ,
IsReadOnly, Inherited from DictionaryBase<K,V> ,
this[K key], Inherited from DictionaryBase<K,V> ,
Keys, Inherited from SortedDictionaryBase<K,V> ,
Keys, Inherited from DictionaryBase<K,V> ,
ListenableEvents, Inherited from DictionaryBase<K,V> ,
Values, Inherited from DictionaryBase<K,V>

Constructor overview

TreeDictionary<K,V>() ,
TreeDictionary<K,V>(System.Collections.Generic.IComparer<K> comparer)

Method overview

Add(K key, V value), Inherited from DictionaryBase<K,V> ,
AddAll<L,W>(System.Collections.Generic.IEnumerable<KeyValuePair<L,W>> entries), Inherited from DictionaryBase<K,V> ,
AddSorted(System.Collections.Generic.IEnumerable<KeyValuePair<K,V>> items), Inherited from SortedDictionaryBase<K,V> ,
All(Fun<KeyValuePair<K,V>,bool> predicate), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
Apply(Act<KeyValuePair<K,V>> action), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
Check(), Inherited from DictionaryBase<K,V> ,
Choose(), Inherited from DictionaryBase<K,V> ,
Clear(), Inherited from DictionaryBase<K,V> ,
Clone() ,
Contains(K key), Inherited from DictionaryBase<K,V> ,
ContainsAll<H>(System.Collections.Generic.IEnumerable<H> keys), Inherited from DictionaryBase<K,V> ,
CopyTo(KeyValuePair<K,V>[] array, int index), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,

Cut(System.IComparable<K> cutter, out KeyValuePair<K,V> lowEntry, out bool lowIsValid, out KeyValuePair<K,V> highEntry, out bool highIsValid)

, Inherited from SortedDictionaryBase<K,V> ,
DeleteMax(), Inherited from SortedDictionaryBase<K,V> ,
DeleteMin(), Inherited from SortedDictionaryBase<K,V> ,
Equals(object obj), Inherited from object ,
Exists(Fun<KeyValuePair<K,V>,bool> predicate), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
Filter(Fun<KeyValuePair<K,V>,bool> predicate), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
Finalize(), Inherited from object ,
Find(K key, out V value), Inherited from DictionaryBase<K,V> ,
Find(ref K key, out V value), Inherited from DictionaryBase<K,V> ,
Find(Fun<KeyValuePair<K,V>,bool> predicate, out KeyValuePair<K,V> item), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
FindMax(), Inherited from SortedDictionaryBase<K,V> ,
FindMin(), Inherited from SortedDictionaryBase<K,V> ,
FindOrAdd(K key, ref V value), Inherited from DictionaryBase<K,V> ,
GetEnumerator(), Inherited from DictionaryBase<K,V> ,
GetHashCode(), Inherited from object ,
GetType(), Inherited from object ,
MemberwiseClone(), Inherited from object ,
Predecessor(K key), Inherited from SortedDictionaryBase<K,V> ,
raiseCollectionChanged(), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseCollectionCleared(bool full, int count), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseCollectionCleared(bool full, int count, System.Nullable<int> offset), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForAdd(KeyValuePair<K,V> item), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForInsert(int i, KeyValuePair<K,V> item), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForRemove(KeyValuePair<K,V> item), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForRemove(KeyValuePair<K,V> item, int count), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForRemoveAll(ICollectionValue<KeyValuePair<K,V>> wasRemoved), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForRemoveAt(int index, KeyValuePair<K,V> item), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForSetThis(int index, KeyValuePair<K,V> value, KeyValuePair<K,V> item), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForUpdate(KeyValuePair<K,V> newitem, KeyValuePair<K,V> olditem), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseForUpdate(KeyValuePair<K,V> newitem, KeyValuePair<K,V> olditem, int count), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseItemInserted(KeyValuePair<K,V> item, int index), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseItemRemovedAt(KeyValuePair<K,V> item, int index), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseItemsAdded(KeyValuePair<K,V> item, int count), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
raiseItemsRemoved(KeyValuePair<K,V> item, int count), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
RangeAll(), Inherited from SortedDictionaryBase<K,V> ,
RangeFrom(K bot), Inherited from SortedDictionaryBase<K,V> ,
RangeFromTo(K bot, K top), Inherited from SortedDictionaryBase<K,V> ,
RangeTo(K top), Inherited from SortedDictionaryBase<K,V> ,
Remove(K key), Inherited from DictionaryBase<K,V> ,
Remove(K key, out V value), Inherited from DictionaryBase<K,V> ,
RemoveRangeFrom(K lowKey), Inherited from SortedDictionaryBase<K,V> ,
RemoveRangeFromTo(K lowKey, K highKey), Inherited from SortedDictionaryBase<K,V> ,
RemoveRangeTo(K highKey), Inherited from SortedDictionaryBase<K,V> ,
Show(System.Text.StringBuilder stringbuilder, ref int rest, System.IFormatProvider formatProvider), Inherited from SortedDictionaryBase<K,V> ,
Snapshot() ,
Successor(K key), Inherited from SortedDictionaryBase<K,V> ,
ToArray(), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
ToString(string format, System.IFormatProvider formatProvider), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
ToString(), Inherited from CollectionValueBase<KeyValuePair<K,V>> ,
Update(K key, V value), Inherited from DictionaryBase<K,V> ,
Update(K key, V value, out V oldvalue), Inherited from DictionaryBase<K,V> ,
UpdateOrAdd(K key, V value), Inherited from DictionaryBase<K,V> ,
UpdateOrAdd(K key, V value, out V oldvalue), Inherited from DictionaryBase<K,V> ,
WeakPredecessor(K key), Inherited from SortedDictionaryBase<K,V> ,
WeakSuccessor(K key), Inherited from SortedDictionaryBase<K,V>

Constructor details

TreeDictionary<K,V>() Create a red-black tree dictionary using the natural comparer for keys. /ThrowsSystem.ArgumentException if the key type K is not comparable.

TreeDictionary<K,V>(System.Collections.Generic.IComparer<K> comparer)

Create a red-black tree dictionary using an external comparer for keys.

Parameters:
comparer:	The external comparer

Method details

object Clone()

Returns:

N System.Collections.Generic.IEnumerable<KeyValuePair<K,V>> Snapshot()

Make a snapshot of the current state of this dictionary