gnu.trove

Class TObjectDoubleHashMap<K>

Implemented Interfaces:
Externalizable

public class TObjectDoubleHashMap<K>
extends TObjectHash
implements Externalizable

An open addressed Map implementation for Object keys and double values. Created: Sun Nov 4 08:52:45 2001
Author:
Eric D. Friedman

Field Summary

protected double[]
_values
the values of the map

Constructor Summary

TObjectDoubleHashMap()
Creates a new TObjectDoubleHashMap instance with the default capacity and load factor.
TObjectDoubleHashMap(TObjectHashingStrategy strategy)
Creates a new TObjectDoubleHashMap instance with the default capacity and load factor.
TObjectDoubleHashMap(int initialCapacity)
Creates a new TObjectDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TObjectDoubleHashMap(int initialCapacity, TObjectHashingStrategy strategy)
Creates a new TObjectDoubleHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TObjectDoubleHashMap(int initialCapacity, float loadFactor)
Creates a new TObjectDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TObjectDoubleHashMap(int initialCapacity, float loadFactor, TObjectHashingStrategy strategy)
Creates a new TObjectDoubleHashMap instance with a prime value at or near the specified capacity and load factor.

Method Summary

@Override
TObjectDoubleHashMap clone()
double
adjustOrPutValue(K key, double adjust_amount, double put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map.
boolean
adjustValue(K key, double amount)
Adjusts the primitive value mapped to key.
void
clear()
Empties the map.
boolean
containsKey(K key)
checks for the present of key in the keys of the map.
boolean
containsValue(double val)
checks for the presence of val in the values of the map.
boolean
equals(Object other)
Compares this map with another map for equality of their stored entries.
boolean
forEachEntry(TObjectDoubleProcedure procedure)
Executes procedure for each key/value entry in the map.
boolean
forEachKey(TObjectProcedure procedure)
Executes procedure for each key in the map.
boolean
forEachValue(TDoubleProcedure procedure)
Executes procedure for each value in the map.
double
get(K key)
retrieves the value for key
double[]
getValues()
Returns the values of the map.
boolean
increment(K key)
Increments the primitive value mapped to key by 1
TObjectDoubleIterator
iterator()
Object[]
keys()
returns the keys of the map.
K[]
keys(K[] a)
returns the keys of the map.
double
put(K key, double value)
Inserts a key/value pair into the map.
void
readExternal(ObjectInput in)
protected void
rehash(int newCapacity)
rehashes the map to the new capacity.
double
remove(K key)
Deletes a key/value pair from the map.
protected void
removeAt(int index)
removes the mapping at index from the map.
boolean
retainEntries(TObjectDoubleProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.
protected int
setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
void
transformValues(TDoubleFunction function)
Transform the values in this map using function.
void
writeExternal(ObjectOutput out)

Field Details

_values

protected double[] _values
the values of the map

Constructor Details

TObjectDoubleHashMap

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

TObjectDoubleHashMap

public TObjectDoubleHashMap(TObjectHashingStrategy strategy)
Creates a new TObjectDoubleHashMap instance with the default capacity and load factor.
Parameters:
strategy - used to compute hash codes and to compare keys.

TObjectDoubleHashMap

public TObjectDoubleHashMap(int initialCapacity)
Creates a new TObjectDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
Parameters:
initialCapacity - an int value

TObjectDoubleHashMap

public TObjectDoubleHashMap(int initialCapacity,
                            TObjectHashingStrategy strategy)
Creates a new TObjectDoubleHashMap 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.

TObjectDoubleHashMap

public TObjectDoubleHashMap(int initialCapacity,
                            float loadFactor)
Creates a new TObjectDoubleHashMap 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

TObjectDoubleHashMap

public TObjectDoubleHashMap(int initialCapacity,
                            float loadFactor,
                            TObjectHashingStrategy strategy)
Creates a new TObjectDoubleHashMap 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 Details

TObjectDoubleHashMap clone

public @Override TObjectDoubleHashMap clone()

adjustOrPutValue

public double adjustOrPutValue(K key,
                               double adjust_amount,
                               double put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.
Parameters:
key - the key of the value to increment
adjust_amount - the amount to adjust the value by
put_amount - the value put into the map if the key is not initial present
Returns:
the value present in the map after the adjustment or put operation
Since:
2.0b1

adjustValue

public boolean adjustValue(K 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.

containsKey

public boolean containsKey(K key)
checks for the present of key in the keys of the map.
Parameters:
key - an Object 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(TObjectDoubleProcedure procedure)
Executes procedure for each key/value entry in the map.
Parameters:
procedure - a TOObjectDoubleProcedure value
Returns:
false if the loop over the entries terminated because the procedure returned false for some entry.

forEachKey

public boolean forEachKey(TObjectProcedure procedure)
Executes procedure for each key in the map.
Parameters:
procedure - a TObjectProcedure 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(K key)
retrieves the value for key
Parameters:
key - an Object value
Returns:
the value of key or (double)0 if no such mapping exists.

getValues

public double[] getValues()
Returns the values of the map.
Returns:
a Collection value

increment

public boolean increment(K 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 TObjectDoubleIterator iterator()
Returns:
an iterator over the entries in this map

keys

public Object[] keys()
returns the keys of the map.
Returns:
a Set value

keys

public K[] keys(K[] a)
returns the keys of the map.
Parameters:
a - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
Returns:
a Set value

put

public double put(K key,
                  double value)
Inserts a key/value pair into the map.
Parameters:
key - an Object value
value - an double value
Returns:
the previous value associated with key, or (double)0 if none was found.

readExternal

public void readExternal(ObjectInput in)
            throws IOException,
                   ClassNotFoundException

rehash

protected void rehash(int newCapacity)
rehashes the map to the new capacity.
Parameters:
newCapacity - an int value

remove

public double remove(K key)
Deletes a key/value pair from the map.
Parameters:
key - an Object value
Returns:
an double value or (double)0 if no such mapping exists.

removeAt

protected void removeAt(int index)
removes the mapping at index from the map.
Parameters:
index - an int value

retainEntries

public boolean retainEntries(TObjectDoubleProcedure 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

writeExternal

public void writeExternal(ObjectOutput out)
            throws IOException

GNU Trove is copyright B) 2001-2008 Eric D. Friedman. All Rights Reserved.