PCJ API
Version 1.2

bak.pcj.map
Class IntKeyCharOpenHashMap

java.lang.Object
  extended bybak.pcj.map.AbstractIntKeyCharMap
      extended bybak.pcj.map.IntKeyCharOpenHashMap
All Implemented Interfaces:
Cloneable, IntKeyCharMap, Serializable

public class IntKeyCharOpenHashMap
extends AbstractIntKeyCharMap
implements IntKeyCharMap, Cloneable, Serializable

This class represents open addressing hash table based maps from int values to char values.

Since:
1.0
See Also:
IntKeyCharChainedHashMap, 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
IntKeyCharOpenHashMap()
          Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
IntKeyCharOpenHashMap(double loadFactor)
          Creates a new hash map with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.
IntKeyCharOpenHashMap(int capacity)
          Creates a new hash map with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.
IntKeyCharOpenHashMap(int capacity, double loadFactor)
          Creates a new hash map with a specified capacity and load factor, and a relative growth factor of 1.0.
IntKeyCharOpenHashMap(int capacity, double loadFactor, double growthFactor)
          Creates a new hash map with a specified capacity, load factor, and relative growth factor.
IntKeyCharOpenHashMap(int capacity, double loadFactor, int growthChunk)
          Creates a new hash map with a specified capacity, load factor, and absolute growth factor.
IntKeyCharOpenHashMap(IntHashFunction keyhash)
          Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
IntKeyCharOpenHashMap(IntHashFunction 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.
IntKeyCharOpenHashMap(IntHashFunction 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%.
IntKeyCharOpenHashMap(IntHashFunction 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.
IntKeyCharOpenHashMap(IntHashFunction keyhash, int capacity, double loadFactor, double growthFactor)
          Creates a new hash map with a specified capacity, load factor, and relative growth factor.
IntKeyCharOpenHashMap(IntHashFunction keyhash, int capacity, double loadFactor, int growthChunk)
          Creates a new hash map with a specified capacity, load factor, and absolute growth factor.
IntKeyCharOpenHashMap(IntKeyCharMap map)
          Creates a new hash map with the same mappings as a specified map.
 
Method Summary
 void clear()
          Clears this map.
 Object clone()
          Returns a clone of this hash map.
 boolean containsKey(int key)
          Indicates whether this map contains a mapping from a specified key.
 boolean containsValue(char value)
          Indicates whether this map contains a mapping to a specified value.
 IntKeyCharMapIterator entries()
          Returns an iterator over the entries of this map.
 char get(int key)
          Maps a specified key to a value.
 boolean isEmpty()
          Indicates whether this map is empty.
 IntSet keySet()
          Returns a set view of the keys of this map.
 char lget()
          Returns the last value corresponding to a positive result from containsKey(int).
 char put(int key, char value)
          Adds a mapping from a specified key to a specified value to this map.
 char remove(int key)
          Removes the mapping from a specified key from this map.
 int size()
          Returns the size of this map.
 char tget(int key)
          Maps a specified key to a value.
 CharCollection values()
          Returns a collection view of the values in this map.
 
Methods inherited from class bak.pcj.map.AbstractIntKeyCharMap
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.IntKeyCharMap
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

IntKeyCharOpenHashMap

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


IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(IntKeyCharMap 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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(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; if loadFactor is not positive.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(IntHashFunction 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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(IntHashFunction 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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(IntHashFunction 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; if loadFactor is not positive.
NullPointerException - if keyhash is null.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(IntHashFunction 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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(IntHashFunction 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.

IntKeyCharOpenHashMap

public IntKeyCharOpenHashMap(IntHashFunction 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 IntSet keySet()
Description copied from interface: IntKeyCharMap
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 IntKeyCharMap
Returns:
a set view of the keys of this map.

lget

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

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

put

public char put(int key,
                char value)
Description copied from interface: IntKeyCharMap
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 IntKeyCharMap
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 CharCollection values()
Description copied from interface: IntKeyCharMap
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 IntKeyCharMap
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 IntKeyCharMapIterator entries()
Description copied from interface: IntKeyCharMap
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 IntKeyCharMap
Returns:
an iterator over the entries of this map.

clear

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

Specified by:
clear in interface IntKeyCharMap
Overrides:
clear in class AbstractIntKeyCharMap

containsKey

public boolean containsKey(int key)
Description copied from interface: IntKeyCharMap
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 IntKeyCharMap
Overrides:
containsKey in class AbstractIntKeyCharMap

containsValue

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

Specified by:
containsValue in interface IntKeyCharMap
Overrides:
containsValue in class AbstractIntKeyCharMap

get

public char get(int key)
Description copied from interface: IntKeyCharMap
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 IntKeyCharMap
Overrides:
get in class AbstractIntKeyCharMap

isEmpty

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

Specified by:
isEmpty in interface IntKeyCharMap
Overrides:
isEmpty in class AbstractIntKeyCharMap

remove

public char remove(int key)
Description copied from interface: IntKeyCharMap
Removes the mapping from a specified key from this map.

Specified by:
remove in interface IntKeyCharMap
Overrides:
remove in class AbstractIntKeyCharMap

size

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

Specified by:
size in interface IntKeyCharMap
Overrides:
size in class AbstractIntKeyCharMap

tget

public char tget(int key)
Description copied from interface: IntKeyCharMap
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 IntKeyCharMap
Overrides:
tget in class AbstractIntKeyCharMap

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