PCJ API
Version 1.2

bak.pcj.map
Class BooleanKeyChainedHashMap

java.lang.Object
  extended bybak.pcj.map.AbstractBooleanKeyMap
      extended bybak.pcj.map.BooleanKeyChainedHashMap
All Implemented Interfaces:
BooleanKeyMap, Cloneable, Serializable

public class BooleanKeyChainedHashMap
extends AbstractBooleanKeyMap
implements BooleanKeyMap, Cloneable, Serializable

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

Since:
1.0
See Also:
BooleanKeyOpenHashMap, 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
BooleanKeyChainedHashMap()
          Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
BooleanKeyChainedHashMap(BooleanHashFunction keyhash)
          Creates a new hash map with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
BooleanKeyChainedHashMap(BooleanHashFunction 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.
BooleanKeyChainedHashMap(BooleanHashFunction 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%.
BooleanKeyChainedHashMap(BooleanHashFunction 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.
BooleanKeyChainedHashMap(BooleanHashFunction keyhash, int capacity, double loadFactor, double growthFactor)
          Creates a new hash map with a specified capacity, load factor, and relative growth factor.
BooleanKeyChainedHashMap(BooleanHashFunction keyhash, int capacity, double loadFactor, int growthChunk)
          Creates a new hash map with a specified capacity, load factor, and absolute growth factor.
BooleanKeyChainedHashMap(BooleanKeyMap map)
          Creates a new hash map with the same mappings as a specified map.
BooleanKeyChainedHashMap(double loadFactor)
          Creates a new hash map with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.
BooleanKeyChainedHashMap(int capacity)
          Creates a new hash map with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.
BooleanKeyChainedHashMap(int capacity, double loadFactor)
          Creates a new hash map with a specified capacity and load factor, and a relative growth factor of 1.0.
BooleanKeyChainedHashMap(int capacity, double loadFactor, double growthFactor)
          Creates a new hash map with a specified capacity, load factor, and relative growth factor.
BooleanKeyChainedHashMap(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(boolean 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.
 BooleanKeyMapIterator entries()
          Returns an iterator over the entries of this map.
 Object get(boolean key)
          Maps a specified key to a value.
 boolean isEmpty()
          Indicates whether this map is empty.
 BooleanSet keySet()
          Returns a set view of the keys of this map.
 Object put(boolean key, Object value)
          Adds a mapping from a specified key to a specified value to this map.
 Object remove(boolean 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.AbstractBooleanKeyMap
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.BooleanKeyMap
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

BooleanKeyChainedHashMap

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


BooleanKeyChainedHashMap

public BooleanKeyChainedHashMap(BooleanKeyMap 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.

BooleanKeyChainedHashMap

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

BooleanKeyChainedHashMap

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

BooleanKeyChainedHashMap

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

BooleanKeyChainedHashMap

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

BooleanKeyChainedHashMap

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

BooleanKeyChainedHashMap

public BooleanKeyChainedHashMap(BooleanHashFunction 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.

BooleanKeyChainedHashMap

public BooleanKeyChainedHashMap(BooleanHashFunction 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.

BooleanKeyChainedHashMap

public BooleanKeyChainedHashMap(BooleanHashFunction 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.

BooleanKeyChainedHashMap

public BooleanKeyChainedHashMap(BooleanHashFunction 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.

BooleanKeyChainedHashMap

public BooleanKeyChainedHashMap(BooleanHashFunction 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.

BooleanKeyChainedHashMap

public BooleanKeyChainedHashMap(BooleanHashFunction 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 BooleanSet keySet()
Description copied from interface: BooleanKeyMap
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 BooleanKeyMap
Returns:
a set view of the keys of this map.

put

public Object put(boolean key,
                  Object value)
Description copied from interface: BooleanKeyMap
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 BooleanKeyMap
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: BooleanKeyMap
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 BooleanKeyMap
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 BooleanKeyMapIterator entries()
Description copied from interface: BooleanKeyMap
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 BooleanKeyMap
Returns:
an iterator over the entries of this map.

clear

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

Specified by:
clear in interface BooleanKeyMap
Overrides:
clear in class AbstractBooleanKeyMap

containsKey

public boolean containsKey(boolean key)
Description copied from interface: BooleanKeyMap
Indicates whether this map contains a mapping from a specified key.

Specified by:
containsKey in interface BooleanKeyMap
Overrides:
containsKey in class AbstractBooleanKeyMap

containsValue

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

Specified by:
containsValue in interface BooleanKeyMap
Overrides:
containsValue in class AbstractBooleanKeyMap

get

public Object get(boolean key)
Description copied from interface: BooleanKeyMap
Maps a specified key to a value.

Specified by:
get in interface BooleanKeyMap
Overrides:
get in class AbstractBooleanKeyMap

isEmpty

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

Specified by:
isEmpty in interface BooleanKeyMap
Overrides:
isEmpty in class AbstractBooleanKeyMap

remove

public Object remove(boolean key)
Description copied from interface: BooleanKeyMap
Removes the mapping from a specified key from this map.

Specified by:
remove in interface BooleanKeyMap
Overrides:
remove in class AbstractBooleanKeyMap

size

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

Specified by:
size in interface BooleanKeyMap
Overrides:
size in class AbstractBooleanKeyMap

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