bak.pcj.map
Class CharKeyIntChainedHashMap

java.lang.Object
  bak.pcj.map.AbstractCharKeyIntMap
      bak.pcj.map.CharKeyIntChainedHashMap

All Implemented Interfaces:

CharKeyIntMap, Cloneable, Serializable

public class CharKeyIntChainedHashMap

extends AbstractCharKeyIntMap

implements CharKeyIntMap, Cloneable, Serializable

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

Since:

1.0

See Also:

CharKeyIntOpenHashMap, 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

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

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

CharKeyIntChainedHashMap(CharHashFunction 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.

CharKeyIntChainedHashMap(CharHashFunction 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%.

CharKeyIntChainedHashMap(CharHashFunction 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.

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

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

CharKeyIntChainedHashMap(CharKeyIntMap map)
Creates a new hash map with the same mappings as a specified map.

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

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

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

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

CharKeyIntChainedHashMap(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(char key) Indicates whether this map contains a mapping from a specified key.
boolean	containsValue(int value) Indicates whether this map contains a mapping to a specified value.
CharKeyIntMapIterator	entries() Returns an iterator over the entries of this map.
int	get(char key) Maps a specified key to a value.
boolean	isEmpty() Indicates whether this map is empty.
CharSet	keySet() Returns a set view of the keys of this map.
int	lget() Returns the last value corresponding to a positive result from containsKey(char).
int	put(char key, int value) Adds a mapping from a specified key to a specified value to this map.
int	remove(char key) Removes the mapping from a specified key from this map.
int	size() Returns the size of this map.
int	tget(char key) Maps a specified key to a value.
IntCollection	values() Returns a collection view of the values in this map.

Methods inherited from class bak.pcj.map.AbstractCharKeyIntMap

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.CharKeyIntMap

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

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap()

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

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(CharKeyIntMap 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.

CharKeyIntChainedHashMap

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

CharKeyIntChainedHashMap

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

CharKeyIntChainedHashMap

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

CharKeyIntChainedHashMap

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

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(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;

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(CharHashFunction 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.

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(CharHashFunction 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.

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(CharHashFunction 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.

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(CharHashFunction 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.

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(CharHashFunction 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.

CharKeyIntChainedHashMap

public CharKeyIntChainedHashMap(CharHashFunction 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 CharSet keySet()

Description copied from interface: CharKeyIntMap

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 CharKeyIntMap

Returns:

a set view of the keys of this map.

lget

public int lget()

Description copied from interface: CharKeyIntMap

Returns the last value corresponding to a positive result from containsKey(char). This is useful for checking checking the existence of a mapping while avoiding two lookups on the same key.

Specified by:

lget in interface CharKeyIntMap

Returns:

the value corresponding to the key from the last invokation of containsKey(char).

See Also:

CharKeyIntMap.get(char), CharKeyIntMap.tget(char), CharKeyIntMap.containsKey(char)

put

public int put(char key,
               int value)

Description copied from interface: CharKeyIntMap

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 CharKeyIntMap

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 IntCollection values()

Description copied from interface: CharKeyIntMap

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 CharKeyIntMap

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 CharKeyIntMapIterator entries()

Description copied from interface: CharKeyIntMap

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 CharKeyIntMap

Returns:

an iterator over the entries of this map.

clear

public void clear()

Description copied from interface: CharKeyIntMap

Clears this map.

Specified by:

clear in interface CharKeyIntMap

Overrides:

clear in class AbstractCharKeyIntMap

containsKey

public boolean containsKey(char key)

Description copied from interface: CharKeyIntMap

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 CharKeyIntMap

Overrides:

containsKey in class AbstractCharKeyIntMap

containsValue

public boolean containsValue(int value)

Description copied from interface: CharKeyIntMap

Indicates whether this map contains a mapping to a specified value.

Specified by:

containsValue in interface CharKeyIntMap

Overrides:

containsValue in class AbstractCharKeyIntMap

get

public int get(char key)

Description copied from interface: CharKeyIntMap

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 CharKeyIntMap

Overrides:

get in class AbstractCharKeyIntMap

isEmpty

public boolean isEmpty()

Description copied from interface: CharKeyIntMap

Indicates whether this map is empty.

Specified by:

isEmpty in interface CharKeyIntMap

Overrides:

isEmpty in class AbstractCharKeyIntMap

remove

public int remove(char key)

Description copied from interface: CharKeyIntMap

Removes the mapping from a specified key from this map.

Specified by:

remove in interface CharKeyIntMap

Overrides:

remove in class AbstractCharKeyIntMap

size

public int size()

Description copied from interface: CharKeyIntMap

Returns the size of this map. The size is defined as the number of mappings from keys to values.

Specified by:

size in interface CharKeyIntMap

Overrides:

size in class AbstractCharKeyIntMap

tget

public int tget(char key)

Description copied from interface: CharKeyIntMap

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 CharKeyIntMap

Overrides:

tget in class AbstractCharKeyIntMap