PCJ API
Version 1.2

bak.pcj.map
Class FloatKeyShortChainedHashMap

java.lang.Object
  extended bybak.pcj.map.AbstractFloatKeyShortMap
      extended bybak.pcj.map.FloatKeyShortChainedHashMap
All Implemented Interfaces:
Cloneable, FloatKeyShortMap, Serializable

public class FloatKeyShortChainedHashMap
extends AbstractFloatKeyShortMap
implements FloatKeyShortMap, Cloneable, Serializable

This class represents chained hash table based maps from float values to short values.

Since:
1.0
See Also:
FloatKeyShortOpenHashMap, Map, Serialized Form

Field Summary
static int DEFAULT_CAPACITY
          The default capacity of this map.
static int DEFAULT_GROWTH_CHUNK
          The default chunk size with which to increase the capacity of this map.
static double DEFAULT_GROWTH_FACTOR
          The default factor with which to increase the capacity of this map.
static double DEFAULT_LOAD_FACTOR
          The default load factor of this map.
 
Constructor Summary
FloatKeyShortChainedHashMap()
          Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
FloatKeyShortChainedHashMap(double loadFactor)
          Creates a new hash map with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.
FloatKeyShortChainedHashMap(FloatHashFunction keyhash)
          Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
FloatKeyShortChainedHashMap(FloatHashFunction keyhash, double loadFactor)
          Creates a new hash map with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.
FloatKeyShortChainedHashMap(FloatHashFunction keyhash, int capacity)
          Creates a new hash map with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.
FloatKeyShortChainedHashMap(FloatHashFunction keyhash, int capacity, double loadFactor)
          Creates a new hash map with a specified capacity and load factor, and a relative growth factor of 1.0.
FloatKeyShortChainedHashMap(FloatHashFunction keyhash, int capacity, double loadFactor, double growthFactor)
          Creates a new hash map with a specified capacity, load factor, and relative growth factor.
FloatKeyShortChainedHashMap(FloatHashFunction keyhash, int capacity, double loadFactor, int growthChunk)
          Creates a new hash map with a specified capacity, load factor, and absolute growth factor.
FloatKeyShortChainedHashMap(FloatKeyShortMap map)
          Creates a new hash map with the same mappings as a specified map.
FloatKeyShortChainedHashMap(int capacity)
          Creates a new hash map with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.
FloatKeyShortChainedHashMap(int capacity, double loadFactor)
          Creates a new hash map with a specified capacity and load factor, and a relative growth factor of 1.0.
FloatKeyShortChainedHashMap(int capacity, double loadFactor, double growthFactor)
          Creates a new hash map with a specified capacity, load factor, and relative growth factor.
FloatKeyShortChainedHashMap(int capacity, double loadFactor, int growthChunk)
          Creates a new hash map with a specified capacity, load factor, and absolute growth factor.
 
Method Summary
 void clear()
          Clears this map.
 Object clone()
          Returns a clone of this hash map.
 boolean containsKey(float key)
          Indicates whether this map contains a mapping from a specified key.
 boolean containsValue(short value)
          Indicates whether this map contains a mapping to a specified value.
 FloatKeyShortMapIterator entries()
          Returns an iterator over the entries of this map.
 short get(float key)
          Maps a specified key to a value.
 boolean isEmpty()
          Indicates whether this map is empty.
 FloatSet keySet()
          Returns a set view of the keys of this map.
 short lget()
          Returns the last value corresponding to a positive result from containsKey(float).
 short put(float key, short value)
          Adds a mapping from a specified key to a specified value to this map.
 short remove(float key)
          Removes the mapping from a specified key from this map.
 int size()
          Returns the size of this map.
 short tget(float key)
          Maps a specified key to a value.
 ShortCollection values()
          Returns a collection view of the values in this map.
 
Methods inherited from class bak.pcj.map.AbstractFloatKeyShortMap
equals, hashCode, putAll, toString, trimToSize
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface bak.pcj.map.FloatKeyShortMap
equals, hashCode, putAll, trimToSize
 

Field Detail

DEFAULT_GROWTH_FACTOR

public static final double DEFAULT_GROWTH_FACTOR
The default factor with which to increase the capacity of this map.

See Also:
Constant Field Values

DEFAULT_GROWTH_CHUNK

public static final int DEFAULT_GROWTH_CHUNK
The default chunk size with which to increase the capacity of this map.

See Also:
Constant Field Values

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY
The default capacity of this map.

See Also:
Constant Field Values

DEFAULT_LOAD_FACTOR

public static final double DEFAULT_LOAD_FACTOR
The default load factor of this map.

See Also:
Constant Field Values
Constructor Detail

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap()
Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.


FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(FloatKeyShortMap map)
Creates a new hash map with the same mappings as a specified map.

Parameters:
map - the map whose mappings to put into the new map.
Throws:
NullPointerException - if map is null.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(int capacity)
Creates a new hash map with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.

Parameters:
capacity - the initial capacity of the map.
Throws:
IllegalArgumentException - if capacity is negative.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(double loadFactor)
Creates a new hash map with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.

Parameters:
loadFactor - the load factor of the map.
Throws:
IllegalArgumentException - if capacity is negative.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(int capacity,
                                   double loadFactor)
Creates a new hash map with a specified capacity and load factor, and a relative growth factor of 1.0.

Parameters:
capacity - the initial capacity of the map.
loadFactor - the load factor of the map.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(int capacity,
                                   double loadFactor,
                                   double growthFactor)
Creates a new hash map with a specified capacity, load factor, and relative growth factor.

The map capacity increases to capacity()*(1+growthFactor). This strategy is good for avoiding many capacity increases, but the amount of wasted memory is approximately the size of the map.

Parameters:
capacity - the initial capacity of the map.
loadFactor - the load factor of the map.
growthFactor - the relative amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthFactor is not positive.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(int capacity,
                                   double loadFactor,
                                   int growthChunk)
Creates a new hash map with a specified capacity, load factor, and absolute growth factor.

The map capacity increases to capacity()+growthChunk. This strategy is good for avoiding wasting memory. However, an overhead is potentially introduced by frequent capacity increases.

Parameters:
capacity - the initial capacity of the map.
loadFactor - the load factor of the map.
growthChunk - the absolute amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthChunk is not positive;

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(FloatHashFunction keyhash)
Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.

Parameters:
keyhash - the hash function to use when hashing keys.
Throws:
NullPointerException - if keyhash is null.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(FloatHashFunction keyhash,
                                   int capacity)
Creates a new hash map with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the map.
Throws:
IllegalArgumentException - if capacity is negative.
NullPointerException - if keyhash is null.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(FloatHashFunction keyhash,
                                   double loadFactor)
Creates a new hash map with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.

Parameters:
keyhash - the hash function to use when hashing keys.
loadFactor - the load factor of the map.
Throws:
IllegalArgumentException - if capacity is negative.
NullPointerException - if keyhash is null.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(FloatHashFunction keyhash,
                                   int capacity,
                                   double loadFactor)
Creates a new hash map with a specified capacity and load factor, and a relative growth factor of 1.0.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the map.
loadFactor - the load factor of the map.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive.
NullPointerException - if keyhash is null.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(FloatHashFunction keyhash,
                                   int capacity,
                                   double loadFactor,
                                   double growthFactor)
Creates a new hash map with a specified capacity, load factor, and relative growth factor.

The map capacity increases to capacity()*(1+growthFactor). This strategy is good for avoiding many capacity increases, but the amount of wasted memory is approximately the size of the map.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the map.
loadFactor - the load factor of the map.
growthFactor - the relative amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthFactor is not positive.
NullPointerException - if keyhash is null.

FloatKeyShortChainedHashMap

public FloatKeyShortChainedHashMap(FloatHashFunction keyhash,
                                   int capacity,
                                   double loadFactor,
                                   int growthChunk)
Creates a new hash map with a specified capacity, load factor, and absolute growth factor.

The map capacity increases to capacity()+growthChunk. This strategy is good for avoiding wasting memory. However, an overhead is potentially introduced by frequent capacity increases.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the map.
loadFactor - the load factor of the map.
growthChunk - the absolute amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthChunk is not positive;
NullPointerException - if keyhash is null.
Method Detail

keySet

public FloatSet keySet()
Description copied from interface: FloatKeyShortMap
Returns a set view of the keys of this map. Removals from the returned set removes the corresponding entries in this map. Changes to the map are reflected in the set.

Specified by:
keySet in interface FloatKeyShortMap
Returns:
a set view of the keys of this map.

lget

public short lget()
Description copied from interface: FloatKeyShortMap
Returns the last value corresponding to a positive result from containsKey(float). This is useful for checking checking the existence of a mapping while avoiding two lookups on the same key.

Specified by:
lget in interface FloatKeyShortMap
Returns:
the value corresponding to the key from the last invokation of containsKey(float).
See Also:
FloatKeyShortMap.get(float), FloatKeyShortMap.tget(float), FloatKeyShortMap.containsKey(float)

put

public short put(float key,
                 short value)
Description copied from interface: FloatKeyShortMap
Adds a mapping from a specified key to a specified value to this map. If a mapping already exists for the specified key it is overwritten by the new mapping.

Specified by:
put in interface FloatKeyShortMap
Parameters:
key - the key of the mapping to add to this map.
value - the value of the mapping to add to this map.
Returns:
the old value if a mapping from the specified key already existed in this map; otherwise returns a default value as specified by the MapDefaults class.
See Also:
MapDefaults

values

public ShortCollection values()
Description copied from interface: FloatKeyShortMap
Returns a collection view of the values in this map. The collection is not modifiable, but changes to the map are reflected in the collection.

Specified by:
values in interface FloatKeyShortMap
Returns:
a collection view of the values in this map.

clone

public Object clone()
Returns a clone of this hash map.

Returns:
a clone of this hash map.
Since:
1.1

entries

public FloatKeyShortMapIterator entries()
Description copied from interface: FloatKeyShortMap
Returns an iterator over the entries of this map. It is possible to remove entries from this map using the iterator provided that the concrete map supports removal of entries.

Specified by:
entries in interface FloatKeyShortMap
Returns:
an iterator over the entries of this map.

clear

public void clear()
Description copied from interface: FloatKeyShortMap
Clears this map.

Specified by:
clear in interface FloatKeyShortMap
Overrides:
clear in class AbstractFloatKeyShortMap

containsKey

public boolean containsKey(float key)
Description copied from interface: FloatKeyShortMap
Indicates whether this map contains a mapping from a specified key. If the key is contained in this map, a succeeding call to lget() will return the corresponding value.

Specified by:
containsKey in interface FloatKeyShortMap
Overrides:
containsKey in class AbstractFloatKeyShortMap

containsValue

public boolean containsValue(short value)
Description copied from interface: FloatKeyShortMap
Indicates whether this map contains a mapping to a specified value.

Specified by:
containsValue in interface FloatKeyShortMap
Overrides:
containsValue in class AbstractFloatKeyShortMap

get

public short get(float key)
Description copied from interface: FloatKeyShortMap
Maps a specified key to a value. Returns a default value as specified by the MapDefaults class if no mapping exists for the specified key.

Specified by:
get in interface FloatKeyShortMap
Overrides:
get in class AbstractFloatKeyShortMap

isEmpty

public boolean isEmpty()
Description copied from interface: FloatKeyShortMap
Indicates whether this map is empty.

Specified by:
isEmpty in interface FloatKeyShortMap
Overrides:
isEmpty in class AbstractFloatKeyShortMap

remove

public short remove(float key)
Description copied from interface: FloatKeyShortMap
Removes the mapping from a specified key from this map.

Specified by:
remove in interface FloatKeyShortMap
Overrides:
remove in class AbstractFloatKeyShortMap

size

public int size()
Description copied from interface: FloatKeyShortMap
Returns the size of this map. The size is defined as the number of mappings from keys to values.

Specified by:
size in interface FloatKeyShortMap
Overrides:
size in class AbstractFloatKeyShortMap

tget

public short tget(float key)
Description copied from interface: FloatKeyShortMap
Maps a specified key to a value. This method should be used when the key is known to be in the map.

Specified by:
tget in interface FloatKeyShortMap
Overrides:
tget in class AbstractFloatKeyShortMap

PCJ API
Version 1.2

Report a bug or request a feature.
Further information on the development and latest release of PCJ can be found at the project homepage.

Primitive Collections for Java is released under the GNU Lesser General Public License.
Copyright © 2002, 2003 Søren Bak. All Rights Reserved.

Hosted by SourceForge.net
SourceForge.net Logo