STKey, Value Class |
The ST class represents an ordered symbol table of generic key-value pairs. It supports the usual Put, Get, Contains, Indexer, Delete, Count, and IsEmpty methods. It also provides ordered methods for finding the Minimum, Maximum, Floor, and Ceiling. It also provides a Keys method for iterating over all of the keys. A symbol table implements the Associative array abstraction: when associating a value with a key that is already in the symbol table, the convention is to replace the old value with the new value. Unlike DictionaryTKey, TValue, this class uses the convention that values cannot be null. Setting the value associated with a key to null is equivalent to deleting the key from the symbol table.
This implementation uses a balanced binary search tree. It requires that the key type implements the IComparable interface and calls the CompareTo() and method to compare two keys. It does not call either Equals() or GetHashCode(). The Put, Contains, Remove, Minimum, Maximum, Ceiling, and Floor operations each take logarithmic time in the worst case. The Count, and IsEmpty operations take constant time. Construction takes constant time.
Namespace: Algs4Net
public class ST<Key, Value> : IEnumerable<KeyValuePair<Key, Value>>, IEnumerable where Key : Object, IComparable<Key>
The STKey, Value type exposes the following members.
Name | Description | |
---|---|---|
![]() | STKey, Value | Initializes an empty symbol table. |
Name | Description | |
---|---|---|
![]() | Count |
Returns the number of key-value pairs in this symbol table. |
![]() | IsEmpty |
Returns true if this symbol table is empty. |
![]() | Item |
Indexer wrapping Get and Put for convenient syntax
|
![]() | Max |
Returns the largest key in this symbol table. |
![]() | Min |
Returns the smallest key in this symbol table. |
Name | Description | |
---|---|---|
![]() | Ceiling |
Returns the smallest key in this symbol table greater than or equal to key. |
![]() | Contains |
Returns true if this symbol table contain the given key. |
![]() | Delete |
Removes the specified key and its associated value from this symbol table
(if the key is in this symbol table). |
![]() | Floor |
Returns the largest key in this symbol table less than or equal to key. |
![]() | Get |
Returns the value associated with the given key in this symbol table. |
![]() | Keys |
Returns all keys in this symbol table.
To iterate over all of the keys in the symbol table named st,
use the foreach notation: foreach (Key key n st.Keys()). |
![]() ![]() | MainTest |
Demo test the ST data type. |
![]() | Put |
Inserts the specified key-value pair into the symbol table, overwriting the old
value with the new value if the symbol table already contains the specified key.
Deletes the specified key (and its associated value) from this symbol table
if the specified value is null. |
For additional documentation, see Section 3.5 of Algorithms, 4th Edition by Robert Sedgewick and Kevin Wayne.
This class is a C# port from the original Java class ST implementation by the respective authors.