bak.pcj.map
Class ObjectKeyDoubleOpenHashMap

java.lang.Object
  bak.pcj.map.AbstractObjectKeyDoubleMap
      bak.pcj.map.ObjectKeyDoubleOpenHashMap

All Implemented Interfaces:

Cloneable, ObjectKeyDoubleMap, Serializable

public class ObjectKeyDoubleOpenHashMap

extends AbstractObjectKeyDoubleMap

implements ObjectKeyDoubleMap, Cloneable, Serializable

This class represents open addressing hash table based maps from object values to double values.

Since:

1.1

See Also:

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

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

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

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

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

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

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

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

Methods inherited from class bak.pcj.map.AbstractObjectKeyDoubleMap

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

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

ObjectKeyDoubleOpenHashMap

public ObjectKeyDoubleOpenHashMap()

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

ObjectKeyDoubleOpenHashMap

public ObjectKeyDoubleOpenHashMap(ObjectKeyDoubleMap 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.

ObjectKeyDoubleOpenHashMap

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

ObjectKeyDoubleOpenHashMap

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

ObjectKeyDoubleOpenHashMap

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

ObjectKeyDoubleOpenHashMap

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

ObjectKeyDoubleOpenHashMap

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

Method Detail

keySet

public Set keySet()

Description copied from interface: ObjectKeyDoubleMap

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 ObjectKeyDoubleMap

Returns:

a set view of the keys of this map.

lget

public double lget()

Description copied from interface: ObjectKeyDoubleMap

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

Specified by:

lget in interface ObjectKeyDoubleMap

Returns:

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

See Also:

ObjectKeyDoubleMap.get(Object), ObjectKeyDoubleMap.tget(Object), ObjectKeyDoubleMap.containsKey(Object)

put

public double put(Object key,
                  double value)

Description copied from interface: ObjectKeyDoubleMap

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 ObjectKeyDoubleMap

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

Description copied from interface: ObjectKeyDoubleMap

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 ObjectKeyDoubleMap

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

Description copied from interface: ObjectKeyDoubleMap

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 ObjectKeyDoubleMap

Returns:

an iterator over the entries of this map.

clear

public void clear()

Description copied from interface: ObjectKeyDoubleMap

Clears this map.

Specified by:

clear in interface ObjectKeyDoubleMap

Overrides:

clear in class AbstractObjectKeyDoubleMap

containsKey

public boolean containsKey(Object key)

Description copied from interface: ObjectKeyDoubleMap

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 ObjectKeyDoubleMap

Overrides:

containsKey in class AbstractObjectKeyDoubleMap

containsValue

public boolean containsValue(double value)

Description copied from interface: ObjectKeyDoubleMap

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

Specified by:

containsValue in interface ObjectKeyDoubleMap

Overrides:

containsValue in class AbstractObjectKeyDoubleMap

get

public double get(Object key)

Description copied from interface: ObjectKeyDoubleMap

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 ObjectKeyDoubleMap

Overrides:

get in class AbstractObjectKeyDoubleMap

isEmpty

public boolean isEmpty()

Description copied from interface: ObjectKeyDoubleMap

Indicates whether this map is empty.

Specified by:

isEmpty in interface ObjectKeyDoubleMap

Overrides:

isEmpty in class AbstractObjectKeyDoubleMap

remove

public double remove(Object key)

Description copied from interface: ObjectKeyDoubleMap

Removes the mapping from a specified key from this map.

Specified by:

remove in interface ObjectKeyDoubleMap

Overrides:

remove in class AbstractObjectKeyDoubleMap

size

public int size()

Description copied from interface: ObjectKeyDoubleMap

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

Specified by:

size in interface ObjectKeyDoubleMap

Overrides:

size in class AbstractObjectKeyDoubleMap

tget

public double tget(Object key)

Description copied from interface: ObjectKeyDoubleMap

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 ObjectKeyDoubleMap

Overrides:

tget in class AbstractObjectKeyDoubleMap