edu.emory.mathcs.util.collections.shorts
Class ShortRadkeHashMap

java.lang.Object
  extended byedu.emory.mathcs.util.collections.shorts.ShortRadkeHashMap
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, ShortMap

public class ShortRadkeHashMap
extends java.lang.Object
implements ShortMap, java.lang.Cloneable, java.io.Serializable

Hash map with short keys. It uses open addressing with quadratic residue search to avoid clustering. No additional memory per entry is needed, there is therefore no memory allocation on put() unless rehashing is required.

Version:
1.0
Author:
Dawid Kurzyniec
See Also:
Serialized Form

Constructor Summary
ShortRadkeHashMap()
           
ShortRadkeHashMap(int minInitialCapacity)
           
ShortRadkeHashMap(int minInitialCapacity, float loadFactor, float resizeTreshold)
           
ShortRadkeHashMap(int minInitialCapacity, short minKey, short maxKey)
           
ShortRadkeHashMap(int minInitialCapacity, short minKey, short maxKey, float loadFactor, float resizeTreshold)
           
ShortRadkeHashMap(ShortMap m)
           
 
Method Summary
 void clear()
          Removes all the mappings.
 java.lang.Object clone()
           
 boolean containsKey(short key)
          Returns true if this map contains mapping for the specified number; false otherwise.
 boolean containsValue(java.lang.Object val)
          Returns true if this map contains mapping with the specified value; false otherwise.
 java.util.Set entrySet()
          Returns the view of entries in this map, as a Set of ShortMap.Entry elements.
 boolean equals(java.lang.Object other)
           
 java.lang.Object get(short key)
          Retrieves the mapping for the specified number, or null if none.
 int hashCode()
           
 boolean isEmpty()
          Returns true if this map is empty; false otherwise.
 ShortSet keySet()
          Returns the view of keys in this map, as a ShortSet.
 java.lang.Object put(short key, java.lang.Object value)
          Maps specified value to the given short key, and returns the value previously mapped for that key, or null if there were no mapping for that key before.
 void putAll(ShortMap map)
          Puts all mappings from the specified map into this map.
 java.lang.Object remove(short key)
          Removes the mapping for the given key and returns the removed value, or null if there was no mapping for that key.
 int size()
          Returns the number of entries in this map.
 java.lang.String toString()
           
 java.util.Collection values()
          Returns the read-only view of values in this map, as a Collection.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ShortRadkeHashMap

public ShortRadkeHashMap()

ShortRadkeHashMap

public ShortRadkeHashMap(int minInitialCapacity)

ShortRadkeHashMap

public ShortRadkeHashMap(int minInitialCapacity,
                         short minKey,
                         short maxKey)

ShortRadkeHashMap

public ShortRadkeHashMap(int minInitialCapacity,
                         float loadFactor,
                         float resizeTreshold)

ShortRadkeHashMap

public ShortRadkeHashMap(int minInitialCapacity,
                         short minKey,
                         short maxKey,
                         float loadFactor,
                         float resizeTreshold)

ShortRadkeHashMap

public ShortRadkeHashMap(ShortMap m)
Method Detail

put

public java.lang.Object put(short key,
                            java.lang.Object value)
Description copied from interface: ShortMap
Maps specified value to the given short key, and returns the value previously mapped for that key, or null if there were no mapping for that key before.

Specified by:
put in interface ShortMap
Parameters:
key - the key
value - the value
Returns:
the value previously mapped to key, or null if none

get

public java.lang.Object get(short key)
Description copied from interface: ShortMap
Retrieves the mapping for the specified number, or null if none.

Specified by:
get in interface ShortMap
Parameters:
key - the search key
Returns:
the mapping for the specified number, or null if none.

containsKey

public boolean containsKey(short key)
Description copied from interface: ShortMap
Returns true if this map contains mapping for the specified number; false otherwise.

Specified by:
containsKey in interface ShortMap
Returns:
true if this map contains mapping for the specified number; false otherwise.

remove

public java.lang.Object remove(short key)
Description copied from interface: ShortMap
Removes the mapping for the given key and returns the removed value, or null if there was no mapping for that key.

Specified by:
remove in interface ShortMap
Parameters:
key - the key to remove the mapping for
Returns:
the value mapped to the key

containsValue

public boolean containsValue(java.lang.Object val)
Description copied from interface: ShortMap
Returns true if this map contains mapping with the specified value; false otherwise. Usually, this method has a linear complexity.

Specified by:
containsValue in interface ShortMap
Returns:
true if this map contains mapping with the specified value; false otherwise.

clear

public void clear()
Description copied from interface: ShortMap
Removes all the mappings.

Specified by:
clear in interface ShortMap

isEmpty

public boolean isEmpty()
Description copied from interface: ShortMap
Returns true if this map is empty; false otherwise.

Specified by:
isEmpty in interface ShortMap
Returns:
true if this map is empty; false otherwise.

size

public int size()
Description copied from interface: ShortMap
Returns the number of entries in this map.

Specified by:
size in interface ShortMap
Returns:
the number of entries in this map.

putAll

public void putAll(ShortMap map)
Description copied from interface: ShortMap
Puts all mappings from the specified map into this map.

Specified by:
putAll in interface ShortMap
Parameters:
map - the map to copy the mappings from.

keySet

public ShortSet keySet()
Description copied from interface: ShortMap
Returns the view of keys in this map, as a ShortSet. The view is backed by this map. Supports removals.

Specified by:
keySet in interface ShortMap
Returns:
the key set view of this map

entrySet

public java.util.Set entrySet()
Description copied from interface: ShortMap
Returns the view of entries in this map, as a Set of ShortMap.Entry elements. The view is backed by this map. Supports removals, and value changes via entry.setValue().

Specified by:
entrySet in interface ShortMap
Returns:
the entry set view of this map

values

public java.util.Collection values()
Description copied from interface: ShortMap
Returns the read-only view of values in this map, as a Collection. The view is backed by this map.

Specified by:
values in interface ShortMap
Returns:
the value view of this map

equals

public boolean equals(java.lang.Object other)
Specified by:
equals in interface ShortMap

hashCode

public int hashCode()
Specified by:
hashCode in interface ShortMap

clone

public java.lang.Object clone()

toString

public java.lang.String toString()