bak.pcj.map
Class LongKeyOpenHashMap

java.lang.Object
  bak.pcj.map.AbstractLongKeyMap
      bak.pcj.map.LongKeyOpenHashMap

All Implemented Interfaces:

Cloneable, LongKeyMap, Serializable

public class LongKeyOpenHashMap

extends AbstractLongKeyMap

implements LongKeyMap, Cloneable, Serializable

This class represents open addressing hash table based maps from long values to objects.

Since:

1.0

See Also:

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

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

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

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

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

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

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

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

LongKeyOpenHashMap(LongHashFunction 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.

LongKeyOpenHashMap(LongHashFunction 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%.

LongKeyOpenHashMap(LongHashFunction 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.

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

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

LongKeyOpenHashMap(LongKeyMap 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(long 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.
LongKeyMapIterator	entries() Returns an iterator over the entries of this map.
Object	get(long key) Maps a specified key to a value.
boolean	isEmpty() Indicates whether this map is empty.
LongSet	keySet() Returns a set view of the keys of this map.
Object	put(long key, Object value) Adds a mapping from a specified key to a specified value to this map.
Object	remove(long 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.AbstractLongKeyMap

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

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

LongKeyOpenHashMap

public LongKeyOpenHashMap()

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

LongKeyOpenHashMap

public LongKeyOpenHashMap(LongKeyMap 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.

LongKeyOpenHashMap

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

LongKeyOpenHashMap

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

LongKeyOpenHashMap

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

LongKeyOpenHashMap

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

LongKeyOpenHashMap

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

LongKeyOpenHashMap

public LongKeyOpenHashMap(LongHashFunction 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.

LongKeyOpenHashMap

public LongKeyOpenHashMap(LongHashFunction 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.

LongKeyOpenHashMap

public LongKeyOpenHashMap(LongHashFunction 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.

LongKeyOpenHashMap

public LongKeyOpenHashMap(LongHashFunction 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.

LongKeyOpenHashMap

public LongKeyOpenHashMap(LongHashFunction 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.

LongKeyOpenHashMap

public LongKeyOpenHashMap(LongHashFunction 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 LongSet keySet()

Description copied from interface: LongKeyMap

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 LongKeyMap

Returns:

a set view of the keys of this map.

put

public Object put(long key,
                  Object value)

Description copied from interface: LongKeyMap

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 LongKeyMap

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: LongKeyMap

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 LongKeyMap

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

Description copied from interface: LongKeyMap

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 LongKeyMap

Returns:

an iterator over the entries of this map.

clear

public void clear()

Description copied from interface: LongKeyMap

Clears this map.

Specified by:

clear in interface LongKeyMap

Overrides:

clear in class AbstractLongKeyMap

containsKey

public boolean containsKey(long key)

Description copied from interface: LongKeyMap

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

Specified by:

containsKey in interface LongKeyMap

Overrides:

containsKey in class AbstractLongKeyMap

containsValue

public boolean containsValue(Object value)

Description copied from interface: LongKeyMap

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

Specified by:

containsValue in interface LongKeyMap

Overrides:

containsValue in class AbstractLongKeyMap

get

public Object get(long key)

Description copied from interface: LongKeyMap

Maps a specified key to a value.

Specified by:

get in interface LongKeyMap

Overrides:

get in class AbstractLongKeyMap

isEmpty

public boolean isEmpty()

Description copied from interface: LongKeyMap

Indicates whether this map is empty.

Specified by:

isEmpty in interface LongKeyMap

Overrides:

isEmpty in class AbstractLongKeyMap

remove

public Object remove(long key)

Description copied from interface: LongKeyMap

Removes the mapping from a specified key from this map.

Specified by:

remove in interface LongKeyMap

Overrides:

remove in class AbstractLongKeyMap

size

public int size()

Description copied from interface: LongKeyMap

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

Specified by:

size in interface LongKeyMap

Overrides:

size in class AbstractLongKeyMap