bak.pcj.map
Class IntKeyChainedHashMap

java.lang.Object
  bak.pcj.map.AbstractIntKeyMap
      bak.pcj.map.IntKeyChainedHashMap

All Implemented Interfaces:

Cloneable, IntKeyMap, Serializable

public class IntKeyChainedHashMap

extends AbstractIntKeyMap

implements IntKeyMap, Cloneable, Serializable

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

Since:

1.0

See Also:

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

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

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

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

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

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

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

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

IntKeyChainedHashMap(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.

IntKeyChainedHashMap(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%.

IntKeyChainedHashMap(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.

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

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

IntKeyChainedHashMap(IntKeyMap 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(Object value) Indicates whether this map contains a mapping to a specified value.
IntKeyMapIterator	entries() Returns an iterator over the entries of this map.
Object	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.
Object	put(int key, Object value) Adds a mapping from a specified key to a specified value to this map.
Object	remove(int key) Removes the mapping from a specified key from this map.
int	size() Returns the size of this map.
Collection	values() Returns a collection view of the values in this map.

Methods inherited from class bak.pcj.map.AbstractIntKeyMap

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

equals, hashCode, putAll

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

IntKeyChainedHashMap

public IntKeyChainedHashMap()

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

IntKeyChainedHashMap

public IntKeyChainedHashMap(IntKeyMap 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.

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

NullPointerException - if keyhash is null.

IntKeyChainedHashMap

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

IntKeyChainedHashMap

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

IntKeyChainedHashMap

public IntKeyChainedHashMap(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: IntKeyMap

Returns a set view of the keys of this map. The set is not directly modifiable, but changes to the map are reflected in the set.

Specified by:

keySet in interface IntKeyMap

Returns:

a set view of the keys of this map.

put

public Object put(int key,
                  Object value)

Description copied from interface: IntKeyMap

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 IntKeyMap

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 (which can be null) if a mapping from the specified key already existed in this map; returns null otherwise.

values

public Collection values()

Description copied from interface: IntKeyMap

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 IntKeyMap

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

Description copied from interface: IntKeyMap

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 IntKeyMap

Returns:

an iterator over the entries of this map.

clear

public void clear()

Description copied from interface: IntKeyMap

Clears this map.

Specified by:

clear in interface IntKeyMap

Overrides:

clear in class AbstractIntKeyMap

containsKey

public boolean containsKey(int key)

Description copied from interface: IntKeyMap

Indicates whether this map contains a mapping from a specified key.

Specified by:

containsKey in interface IntKeyMap

Overrides:

containsKey in class AbstractIntKeyMap

containsValue

public boolean containsValue(Object value)

Description copied from interface: IntKeyMap

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

Specified by:

containsValue in interface IntKeyMap

Overrides:

containsValue in class AbstractIntKeyMap

get

public Object get(int key)

Description copied from interface: IntKeyMap

Maps a specified key to a value.

Specified by:

get in interface IntKeyMap

Overrides:

get in class AbstractIntKeyMap

isEmpty

public boolean isEmpty()

Description copied from interface: IntKeyMap

Indicates whether this map is empty.

Specified by:

isEmpty in interface IntKeyMap

Overrides:

isEmpty in class AbstractIntKeyMap

remove

public Object remove(int key)

Description copied from interface: IntKeyMap

Removes the mapping from a specified key from this map.

Specified by:

remove in interface IntKeyMap

Overrides:

remove in class AbstractIntKeyMap

size

public int size()

Description copied from interface: IntKeyMap

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

Specified by:

size in interface IntKeyMap

Overrides:

size in class AbstractIntKeyMap