org.biojava.nbio.structure.math

Class SymbolTable<Key extends java.lang.Comparable<Key>,Value>

java.lang.Object

org.biojava.nbio.structure.math.SymbolTable<Key,Value>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Key>

public class SymbolTable<Key extends java.lang.Comparable<Key>,Value>
extends java.lang.Object
implements java.lang.Iterable<Key>, java.io.Serializable

Sorted symbol table implementation using a java.util.TreeMap. Does not allow duplicate keys. This class represents an ordered symbol table. It assumes that the elements are Comparable. It supports the usual put, get, contains, and delete methods. It also provides ordered methods for finding the minimum, maximum, floor, and ceiling.

The class uses the convention that values cannot be null. Setting the value associated with a key to null is equivalent to removing the key.

This implementation uses a balanced binary search tree. The add, contains, delete, minimum, maximum, ceiling, and floor methods take logarithmic time. Derived from http://introcs.cs.princeton.edu/java/44st/ST.java.html

For additional documentation, see Section 4.4 of Introduction to Programming in Java: An Interdisciplinary Approach by Robert Sedgewick and Kevin Wayne.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SymbolTable() Create an empty symbol table.

Method Summary

Modifier and Type	Method and Description
Key	ceil(Key k) Return the smallest key in the table >= k.
boolean	contains(Key key) Is the key in the table?
Value	delete(Key key) Delete the key (and paired value) from table.
Key	floor(Key k) Return the largest key in the table <= k.
Value	get(Key key) Return the value paired with given key; null if key is not in table.
java.util.Iterator<Key>	iterator() Return an Iterator for the keys in the table.
java.lang.Iterable<Key>	keys() Return an Iterable for the keys in the table.
Key	max() Return the largest key in the table.
Key	min() Return the smallest key in the table.
void	put(Key key, Value val) Put key-value pair into the symbol table.
int	size() How many keys are in the table?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SymbolTable

public SymbolTable()

Create an empty symbol table.

Method Detail

put

public void put(Key key,
                Value val)

Put key-value pair into the symbol table. Remove key from table if value is null.

get

public Value get(Key key)

Return the value paired with given key; null if key is not in table.

delete

public Value delete(Key key)

Delete the key (and paired value) from table. Return the value paired with given key; null if key is not in table.

contains

public boolean contains(Key key)

Is the key in the table?

size

public int size()

How many keys are in the table?

iterator

public java.util.Iterator<Key> iterator()

Return an Iterator for the keys in the table. To iterate over all of the keys in the symbol table st, use the foreach notation: for (Key key : st).

Specified by:

iterator in interface java.lang.Iterable<Key extends java.lang.Comparable<Key>>

keys

public java.lang.Iterable<Key> keys()

Return an Iterable for the keys in the table. To iterate over all of the keys in the symbol table st, use the foreach notation: for (Key key : st.keys()).

min

public Key min()

Return the smallest key in the table.

max

public Key max()

Return the largest key in the table.

ceil

public Key ceil(Key k)

Return the smallest key in the table >= k.

floor

public Key floor(Key k)

Return the largest key in the table <= k.