| java.lang.Object
 com.jofti.util.AbstractMap
com.jofti.util.OpenHashMap
| OpenHashMap | | public class OpenHashMap extends AbstractMap implements Map(Code) | | Hash map holding (key,value) associations of type (int-->Object); Automatically grows and shrinks as needed; Implemented using open addressing with double hashing.
First see the package summary and javadoc tree view to get the broad picture.
Overrides many methods for performance reasons only.
author:
steve Woodcock
author:
wolfgang.hoschek@cern.ch
version:
1.0, 09/24/99
See Also: java.util.HashMap |
| Field Summary | |
| final protected static byte | FREE
| | final protected static byte | FULL
| | final protected static byte | REMOVED
| | protected int | freeEntries
The number of table entries in state==FREE. | | protected byte | state
The state of each hash table entry (FREE, FULL, REMOVED). | | protected Object | table
The hash table keys. | | protected Object | values
The hash table values. |
| Constructor Summary | |
| public | OpenHashMap()
Constructs an empty map with default capacity and default load factors. | | public | OpenHashMap(int initialCapacity)
Constructs an empty map with the specified initial capacity and default load factors. | | public | OpenHashMap(int initialCapacity, double minLoadFactor, double maxLoadFactor)
Constructs an empty map with
the specified initial capacity and the specified minimum and maximum load factor. | | public | OpenHashMap(double minLoadFactor, double maxLoadFactor)
|
| Method Summary | |
| public void | clear()
Removes all (key,value) associations from the receiver. | | public Object | clone()
Returns a deep copy of the receiver. | | public boolean | containsKey(Object key)
Returns true if the receiver contains the specified key. | | public boolean | containsValue(Object value)
Returns true if the receiver contains the specified value. | | public void | ensureCapacity(int minCapacity)
Ensures that the receiver can hold at least the specified number of associations without needing to allocate new internal memory. | | public Set | entrySet()
| | public boolean | forEachKey(ObjectProcedure procedure)
Applies a procedure to each key of the receiver, if any.
Note: Iterates over the keys in no particular order.
Subclasses can define a particular order, for example, "sorted by key".
All methods which can be expressed in terms of this method (most methods can) must guarantee to use the same order defined by this method, even if it is no particular order.
This is necessary so that, for example, methods keys and values will yield association pairs, not two uncorrelated lists.
Parameters:
procedure - the procedure to be applied. | | public boolean | forEachPair(ObjectProcedure procedure)
Applies a procedure to each (key,value) pair of the receiver, if any.
Iteration order is guaranteed to be identical to the order used by method
OpenHashMap.forEachKey(IntProcedure) .
Parameters:
procedure - the procedure to be applied. | | public Object | get(Object key)
Returns the value associated with the specified key.
It is often a good idea to first check with
OpenHashMap.containsKey(int) whether the given key has a value associated or not, i.e. | | protected int | indexOfInsertion(Object key)
Parameters:
key - the key to be added to the receiver. | | protected int | indexOfKey(Object key)
Parameters:
key - the key to be searched in the receiver. | | protected int | indexOfValue(Object value)
Parameters:
value - the value to be searched in the receiver. | | public List | keyList()
| | public Object | keyOf(Object value)
Returns the first key the given value is associated with.
It is often a good idea to first check with
OpenHashMap.containsValue(Object) whether there exists an association from a key to this value.
Search order is guaranteed to be identical to the order used by method
OpenHashMap.forEachKey(IntProcedure) .
Parameters:
value - the value to search for. | | public Set | keySet()
| | public void | keys(Object[] array)
Fills all keys contained in the receiver into the specified list. | | public Object | put(Object key, Object value)
Associates the given key with the given value.
Replaces any old (key,someOtherValue) association, if existing.
Parameters:
key - the key the value shall be associated with.
Parameters:
value - the value to be associated. | | public void | putAll(Map t)
| | protected void | rehash(int newCapacity)
Rehashes the contents of the receiver into a new table
with a smaller or larger capacity. | | public Object | remove(Object key)
Removes the given key with its associated element from the receiver, if present.
Parameters:
key - the key to be removed from the receiver. | | public Object | removeNoReHash(Object key)
| | protected void | setUp(int initialCapacity, double minLoadFactor, double maxLoadFactor)
Initializes the receiver. | | public void | trimToSize()
Trims the capacity of the receiver to be the receiver's current
size. | | public void | values(Object[] array)
Fills all values contained in the receiver into the specified list. | | public Collection | values()
|
| FREE | | final protected static byte FREE(Code) | | |
| FULL | | final protected static byte FULL(Code) | | |
| REMOVED | | final protected static byte REMOVED(Code) | | |
| freeEntries | | protected int freeEntries(Code) | | The number of table entries in state==FREE.
|
| state | | protected byte state(Code) | | The state of each hash table entry (FREE, FULL, REMOVED).
|
| OpenHashMap | | public OpenHashMap()(Code) | | Constructs an empty map with default capacity and default load factors.
|
| OpenHashMap | | public OpenHashMap(int initialCapacity)(Code) | | Constructs an empty map with the specified initial capacity and default load factors.
Parameters:
initialCapacity - the initial capacity of the map.
throws:
IllegalArgumentException - if the initial capacity is lessthan zero. |
| OpenHashMap | | public OpenHashMap(int initialCapacity, double minLoadFactor, double maxLoadFactor)(Code) | | Constructs an empty map with
the specified initial capacity and the specified minimum and maximum load factor.
Parameters:
initialCapacity - the initial capacity.
Parameters:
minLoadFactor - the minimum load factor.
Parameters:
maxLoadFactor - the maximum load factor.
throws:
IllegalArgumentException - if initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor). |
| OpenHashMap | | public OpenHashMap(double minLoadFactor, double maxLoadFactor)(Code) | | |
| clear | | public void clear()(Code) | | Removes all (key,value) associations from the receiver.
Implicitly calls trimToSize().
|
| clone | | public Object clone()(Code) | | Returns a deep copy of the receiver.
a deep copy of the receiver. |
| containsKey | | public boolean containsKey(Object key)(Code) | | Returns true if the receiver contains the specified key.
true if the receiver contains the specified key. |
| containsValue | | public boolean containsValue(Object value)(Code) | | Returns true if the receiver contains the specified value.
true if the receiver contains the specified value. |
| ensureCapacity | | public void ensureCapacity(int minCapacity)(Code) | | Ensures that the receiver can hold at least the specified number of associations without needing to allocate new internal memory.
If necessary, allocates new internal memory and increases the capacity of the receiver.
This method never need be called; it is for performance tuning only.
Calling this method before put()ing a large number of associations boosts performance,
because the receiver will grow only once instead of potentially many times and hash collisions get less probable.
Parameters:
minCapacity - the desired minimum capacity. |
| forEachKey | | public boolean forEachKey(ObjectProcedure procedure)(Code) | | Applies a procedure to each key of the receiver, if any.
Note: Iterates over the keys in no particular order.
Subclasses can define a particular order, for example, "sorted by key".
All methods which can be expressed in terms of this method (most methods can) must guarantee to use the same order defined by this method, even if it is no particular order.
This is necessary so that, for example, methods keys and values will yield association pairs, not two uncorrelated lists.
Parameters:
procedure - the procedure to be applied. Stops iteration if the procedure returns false, otherwise continues. false if the procedure stopped before all keys where iterated over, true otherwise. |
| forEachPair | | public boolean forEachPair(ObjectProcedure procedure)(Code) | | Applies a procedure to each (key,value) pair of the receiver, if any.
Iteration order is guaranteed to be identical to the order used by method
OpenHashMap.forEachKey(IntProcedure) .
Parameters:
procedure - the procedure to be applied. Stops iteration if the procedure returns false, otherwise continues. false if the procedure stopped before all keys where iterated over, true otherwise. |
| get | | public Object get(Object key)(Code) | | Returns the value associated with the specified key.
It is often a good idea to first check with
OpenHashMap.containsKey(int) whether the given key has a value associated or not, i.e. whether there exists an association for the given key or not.
Parameters:
key - the key to be searched for. the value associated with the specified key; null if no such key is present. |
| indexOfInsertion | | protected int indexOfInsertion(Object key)(Code) | |
Parameters:
key - the key to be added to the receiver. the index where the key would need to be inserted, if it is not already contained.Returns -index-1 if the key is already contained at slot index.Therefore, if the returned index < 0, then it is already contained at slot -index-1.If the returned index >= 0, then it is NOT already contained and should be inserted at slot index. |
| indexOfKey | | protected int indexOfKey(Object key)(Code) | |
Parameters:
key - the key to be searched in the receiver. the index where the key is contained in the receiver, returns -1 if the key was not found. |
| indexOfValue | | protected int indexOfValue(Object value)(Code) | |
Parameters:
value - the value to be searched in the receiver. the index where the value is contained in the receiver, returns -1 if the value was not found. |
| keyOf | | public Object keyOf(Object value)(Code) | | Returns the first key the given value is associated with.
It is often a good idea to first check with
OpenHashMap.containsValue(Object) whether there exists an association from a key to this value.
Search order is guaranteed to be identical to the order used by method
OpenHashMap.forEachKey(IntProcedure) .
Parameters:
value - the value to search for. the first key for which holds get(key) == value; returns Integer.MIN_VALUE if no such key exists. |
| keys | | public void keys(Object[] array)(Code) | | Fills all keys contained in the receiver into the specified list.
Fills the list, starting at index 0.
After this call returns the specified list has a new size that equals this.size().
Iteration order is guaranteed to be identical to the order used by method
OpenHashMap.forEachKey(IntProcedure) .
This method can be used to iterate over the keys of the receiver.
Parameters:
list - the list to be filled, can have any size. |
| put | | public Object put(Object key, Object value)(Code) | | Associates the given key with the given value.
Replaces any old (key,someOtherValue) association, if existing.
Parameters:
key - the key the value shall be associated with.
Parameters:
value - the value to be associated. true if the receiver did not already contain such a key;false if the receiver did already contain such a key - the new value has now replaced the formerly associated value. |
| rehash | | protected void rehash(int newCapacity)(Code) | | Rehashes the contents of the receiver into a new table
with a smaller or larger capacity.
This method is called automatically when the
number of keys in the receiver exceeds the high water mark or falls below the low water mark.
|
| remove | | public Object remove(Object key)(Code) | | Removes the given key with its associated element from the receiver, if present.
Parameters:
key - the key to be removed from the receiver. true if the receiver contained the specified key, false otherwise. |
| setUp | | protected void setUp(int initialCapacity, double minLoadFactor, double maxLoadFactor)(Code) | | Initializes the receiver.
Parameters:
initialCapacity - the initial capacity of the receiver.
Parameters:
minLoadFactor - the minLoadFactor of the receiver.
Parameters:
maxLoadFactor - the maxLoadFactor of the receiver.
throws:
IllegalArgumentException - if initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor). |
| trimToSize | | public void trimToSize()(Code) | | Trims the capacity of the receiver to be the receiver's current
size. Releases any superfluous internal memory. An application can use this operation to minimize the
storage of the receiver.
|
| values | | public void values(Object[] array)(Code) | | Fills all values contained in the receiver into the specified list.
Fills the list, starting at index 0.
After this call returns the specified list has a new size that equals this.size().
Iteration order is guaranteed to be identical to the order used by method
OpenHashMap.forEachKey(IntProcedure) .
This method can be used to iterate over the values of the receiver.
Parameters:
list - the list to be filled, can have any size. |
| Methods inherited from com.jofti.util.AbstractMap | protected int chooseGrowCapacity(int size, double minLoad, double maxLoad)(Code)(Java Doc)
protected int chooseHighWaterMark(int capacity, double maxLoad)(Code)(Java Doc)
protected int chooseLowWaterMark(int capacity, double minLoad)(Code)(Java Doc)
protected int chooseMeanCapacity(int size, double minLoad, double maxLoad)(Code)(Java Doc)
protected int chooseShrinkCapacity(int size, double minLoad, double maxLoad)(Code)(Java Doc)
abstract public void clear()(Code)(Java Doc)
abstract public void ensureCapacity(int minCapacity)(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
protected int nextPrime(int desiredCapacity)(Code)(Java Doc)
protected void setUp(int initialCapacity, double minLoadFactor, double maxLoadFactor)(Code)(Java Doc)
public int size()(Code)(Java Doc)
abstract public void trimToSize()(Code)(Java Doc)
|
|
|