gnu.trove

Class TIntDoubleHashMap

public class TIntDoubleHashMap extends TIntHash implements Serializable

An open addressed Map implementation for int keys and double values. Created: Sun Nov 4 08:52:45 2001

Version: $Id: TIntDoubleHashMap.java,v 1.14 2003/03/19 04:17:04 ericdf Exp $

Author: Eric D. Friedman

Nested Class Summary
static classTIntDoubleHashMap.EqProcedure
classTIntDoubleHashMap.HashProcedure
Field Summary
protected double[]_values
the values of the map
Constructor Summary
TIntDoubleHashMap()
Creates a new TIntDoubleHashMap instance with the default capacity and load factor.
TIntDoubleHashMap(int initialCapacity)
Creates a new TIntDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TIntDoubleHashMap(int initialCapacity, float loadFactor)
Creates a new TIntDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TIntDoubleHashMap(TIntHashingStrategy strategy)
Creates a new TIntDoubleHashMap instance with the default capacity and load factor.
TIntDoubleHashMap(int initialCapacity, TIntHashingStrategy strategy)
Creates a new TIntDoubleHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TIntDoubleHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy)
Creates a new TIntDoubleHashMap instance with a prime value at or near the specified capacity and load factor.
Method Summary
booleanadjustValue(int key, double amount)
Adjusts the primitive value mapped to key.
voidclear()
Empties the map.
Objectclone()
booleancontainsKey(int key)
checks for the present of key in the keys of the map.
booleancontainsValue(double val)
checks for the presence of val in the values of the map.
booleanequals(Object other)
Compares this map with another map for equality of their stored entries.
booleanforEachEntry(TIntDoubleProcedure procedure)
Executes procedure for each key/value entry in the map.
booleanforEachKey(TIntProcedure procedure)
Executes procedure for each key in the map.
booleanforEachValue(TDoubleProcedure procedure)
Executes procedure for each value in the map.
doubleget(int key)
retrieves the value for key
double[]getValues()
Returns the values of the map.
inthashCode()
booleanincrement(int key)
Increments the primitive value mapped to key by 1
TIntDoubleIteratoriterator()
int[]keys()
returns the keys of the map.
doubleput(int key, double value)
Inserts a key/value pair into the map.
voidreadObject(ObjectInputStream stream)
protected voidrehash(int newCapacity)
rehashes the map to the new capacity.
doubleremove(int key)
Deletes a key/value pair from the map.
protected voidremoveAt(int index)
removes the mapping at index from the map.
booleanretainEntries(TIntDoubleProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.
protected intsetUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
voidtransformValues(TDoubleFunction function)
Transform the values in this map using function.
voidwriteObject(ObjectOutputStream stream)

Field Detail

_values

protected transient double[] _values
the values of the map

Constructor Detail

TIntDoubleHashMap

public TIntDoubleHashMap()
Creates a new TIntDoubleHashMap instance with the default capacity and load factor.

TIntDoubleHashMap

public TIntDoubleHashMap(int initialCapacity)
Creates a new TIntDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

Parameters: initialCapacity an int value

TIntDoubleHashMap

public TIntDoubleHashMap(int initialCapacity, float loadFactor)
Creates a new TIntDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

Parameters: initialCapacity an int value loadFactor a float value

TIntDoubleHashMap

public TIntDoubleHashMap(TIntHashingStrategy strategy)
Creates a new TIntDoubleHashMap instance with the default capacity and load factor.

Parameters: strategy used to compute hash codes and to compare keys.

TIntDoubleHashMap

public TIntDoubleHashMap(int initialCapacity, TIntHashingStrategy strategy)
Creates a new TIntDoubleHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.

Parameters: initialCapacity an int value strategy used to compute hash codes and to compare keys.

TIntDoubleHashMap

public TIntDoubleHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy)
Creates a new TIntDoubleHashMap instance with a prime value at or near the specified capacity and load factor.

Parameters: initialCapacity used to find a prime capacity for the table. loadFactor used to calculate the threshold over which rehashing takes place. strategy used to compute hash codes and to compare keys.

Method Detail

adjustValue

public boolean adjustValue(int key, double amount)
Adjusts the primitive value mapped to key.

Parameters: key the key of the value to increment amount the amount to adjust the value by.

Returns: true if a mapping was found and modified.

clear

public void clear()
Empties the map.

clone

public Object clone()

Returns: a deep clone of this collection

containsKey

public boolean containsKey(int key)
checks for the present of key in the keys of the map.

Parameters: key an int value

Returns: a boolean value

containsValue

public boolean containsValue(double val)
checks for the presence of val in the values of the map.

Parameters: val an double value

Returns: a boolean value

equals

public boolean equals(Object other)
Compares this map with another map for equality of their stored entries.

Parameters: other an Object value

Returns: a boolean value

forEachEntry

public boolean forEachEntry(TIntDoubleProcedure procedure)
Executes procedure for each key/value entry in the map.

Parameters: procedure a TOIntDoubleProcedure value

Returns: false if the loop over the entries terminated because the procedure returned false for some entry.

forEachKey

public boolean forEachKey(TIntProcedure procedure)
Executes procedure for each key in the map.

Parameters: procedure a TIntProcedure value

Returns: false if the loop over the keys terminated because the procedure returned false for some key.

forEachValue

public boolean forEachValue(TDoubleProcedure procedure)
Executes procedure for each value in the map.

Parameters: procedure a TDoubleProcedure value

Returns: false if the loop over the values terminated because the procedure returned false for some value.

get

public double get(int key)
retrieves the value for key

Parameters: key an int value

Returns: the value of key or null if no such mapping exists.

getValues

public double[] getValues()
Returns the values of the map.

Returns: a Collection value

hashCode

public int hashCode()

increment

public boolean increment(int key)
Increments the primitive value mapped to key by 1

Parameters: key the key of the value to increment

Returns: true if a mapping was found and modified.

iterator

public TIntDoubleIterator iterator()

Returns: a TIntDoubleIterator with access to this map's keys and values

keys

public int[] keys()
returns the keys of the map.

Returns: a Set value

put

public double put(int key, double value)
Inserts a key/value pair into the map.

Parameters: key an int value value an double value

Returns: the previous value associated with key, or null if none was found.

readObject

private void readObject(ObjectInputStream stream)

rehash

protected void rehash(int newCapacity)
rehashes the map to the new capacity.

Parameters: newCapacity an int value

remove

public double remove(int key)
Deletes a key/value pair from the map.

Parameters: key an int value

Returns: an double value

removeAt

protected void removeAt(int index)
removes the mapping at index from the map.

Parameters: index an int value

retainEntries

public boolean retainEntries(TIntDoubleProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.

Parameters: procedure determines which entries to keep

Returns: true if the map was modified.

setUp

protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.

Parameters: initialCapacity an int value

Returns: the actual capacity chosen

transformValues

public void transformValues(TDoubleFunction function)
Transform the values in this map using function.

Parameters: function a TDoubleFunction value

writeObject

private void writeObject(ObjectOutputStream stream)