gnu.trove.map.hash

Class TFloatDoubleHashMap

java.lang.Object

gnu.trove.impl.hash.THash

gnu.trove.impl.hash.TPrimitiveHash

gnu.trove.impl.hash.TFloatDoubleHash

gnu.trove.map.hash.TFloatDoubleHashMap

All Implemented Interfaces:

TFloatDoubleMap, java.io.Externalizable, java.io.Serializable

public class TFloatDoubleHashMap
extends TFloatDoubleHash
implements TFloatDoubleMap, java.io.Externalizable

An open addressed Map implementation for float keys and double values.

See Also:

Serialized Form

Field Summary

Fields inherited from class gnu.trove.impl.hash.TFloatDoubleHash

_set

Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash

_states, FREE, FULL, REMOVED

Constructor Summary

Constructors

Constructor and Description
TFloatDoubleHashMap() Creates a new TFloatDoubleHashMap instance with the default capacity and load factor.
TFloatDoubleHashMap(float[] keys, double[] values) Creates a new TFloatDoubleHashMap instance containing all of the entries in the map passed in.
TFloatDoubleHashMap(int initialCapacity) Creates a new TFloatDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TFloatDoubleHashMap(int initialCapacity, float loadFactor) Creates a new TFloatDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TFloatDoubleHashMap(int initialCapacity, float loadFactor, float noEntryKey, double noEntryValue) Creates a new TFloatDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TFloatDoubleHashMap(TFloatDoubleMap map) Creates a new TFloatDoubleHashMap instance containing all of the entries in the map passed in.

Method Summary

Modifier and Type	Method and Description
double	adjustOrPutValue(float 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(float key, double amount) Adjusts the primitive value mapped to key.
void	clear() Empties the collection.
boolean	containsKey(float 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(java.lang.Object other)
boolean	forEachEntry(TFloatDoubleProcedure procedure) Executes procedure for each key/value entry in the map.
boolean	forEachKey(TFloatProcedure procedure) Executes procedure for each key in the map.
boolean	forEachValue(TDoubleProcedure procedure) Executes procedure for each value in the map.
double	get(float key) Retrieves the value for key
int	hashCode()
boolean	increment(float key) Increments the primitive value mapped to key by 1
boolean	isEmpty() Tells whether this set is currently holding any elements.
TFloatDoubleIterator	iterator()
float[]	keys() Returns the keys of the map as an array of float values.
float[]	keys(float[] array) Returns the keys of the map.
TFloatSet	keySet() Returns the keys of the map as a TFloatSet
double	put(float key, double value) Inserts a key/value pair into the map.
void	putAll(java.util.Map<? extends java.lang.Float,? extends java.lang.Double> map) Put all the entries from the given Map into this map.
void	putAll(TFloatDoubleMap map) Put all the entries from the given map into this map.
double	putIfAbsent(float key, double value) Inserts a key/value pair into the map if the specified key is not already associated with a value.
void	readExternal(java.io.ObjectInput in)
double	remove(float key) Deletes a key/value pair from the map.
boolean	retainEntries(TFloatDoubleProcedure procedure) Retains only those entries in the map for which the procedure returns a true value.
java.lang.String	toString()
void	transformValues(TDoubleFunction function) Transform the values in this map using function.
TDoubleCollection	valueCollection() Returns the values of the map as a TDoubleCollection
double[]	values() Returns the values of the map as an array of #e# values.
double[]	values(double[] array) Returns the values of the map using an existing array.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class gnu.trove.impl.hash.TFloatDoubleHash

contains, forEach, getNoEntryKey, getNoEntryValue

Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash

capacity

Methods inherited from class gnu.trove.impl.hash.THash

compact, ensureCapacity, getAutoCompactionFactor, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gnu.trove.map.TFloatDoubleMap

getNoEntryKey, getNoEntryValue, size

Constructor Detail

TFloatDoubleHashMap

public TFloatDoubleHashMap()

Creates a new TFloatDoubleHashMap instance with the default capacity and load factor.

TFloatDoubleHashMap

public TFloatDoubleHashMap(int initialCapacity)

Creates a new TFloatDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

Parameters:

initialCapacity - an int value

TFloatDoubleHashMap

public TFloatDoubleHashMap(int initialCapacity,
                           float loadFactor)

Creates a new TFloatDoubleHashMap 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

TFloatDoubleHashMap

public TFloatDoubleHashMap(int initialCapacity,
                           float loadFactor,
                           float noEntryKey,
                           double noEntryValue)

Creates a new TFloatDoubleHashMap 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

noEntryKey - a float value that represents null for the Key set.

noEntryValue - a double value that represents null for the Value set.

TFloatDoubleHashMap

public TFloatDoubleHashMap(float[] keys,
                           double[] values)

Creates a new TFloatDoubleHashMap instance containing all of the entries in the map passed in.

Parameters:

keys - a float array containing the keys for the matching values.

values - a double array containing the values.

TFloatDoubleHashMap

public TFloatDoubleHashMap(TFloatDoubleMap map)

Creates a new TFloatDoubleHashMap instance containing all of the entries in the map passed in.

Parameters:

map - a TFloatDoubleMap that will be duplicated.

Method Detail

put

public double put(float key,
                  double value)

Inserts a key/value pair into the map.

Specified by:

put in interface TFloatDoubleMap

Parameters:

key - an float value

value - an double value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TFloatDoubleMap.getNoEntryValue()).

putIfAbsent

public double putIfAbsent(float key,
                          double value)

Inserts a key/value pair into the map if the specified key is not already associated with a value.

Specified by:

putIfAbsent in interface TFloatDoubleMap

Parameters:

key - an float value

value - an double value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TFloatDoubleMap.getNoEntryValue()).

putAll

public void putAll(java.util.Map<? extends java.lang.Float,? extends java.lang.Double> map)

Put all the entries from the given Map into this map.

Specified by:

putAll in interface TFloatDoubleMap

Parameters:

map - The Map from which entries will be obtained to put into this map.

putAll

public void putAll(TFloatDoubleMap map)

Put all the entries from the given map into this map.

Specified by:

putAll in interface TFloatDoubleMap

Parameters:

map - The map from which entries will be obtained to put into this map.

get

public double get(float key)

Retrieves the value for key

Specified by:

get in interface TFloatDoubleMap

Parameters:

key - an float value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TFloatDoubleMap.getNoEntryValue()).

clear

public void clear()

Empties the collection.

Specified by:

clear in interface TFloatDoubleMap

Overrides:

clear in class THash

isEmpty

public boolean isEmpty()

Tells whether this set is currently holding any elements.

Specified by:

isEmpty in interface TFloatDoubleMap

Overrides:

isEmpty in class THash

Returns:

a boolean value

remove

public double remove(float key)

Deletes a key/value pair from the map.

Specified by:

remove in interface TFloatDoubleMap

Parameters:

key - an float value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TFloatDoubleMap.getNoEntryValue()).

keySet

public TFloatSet keySet()

Returns the keys of the map as a TFloatSet

Specified by:

keySet in interface TFloatDoubleMap

Returns:

the keys of the map as a TFloatSet

keys

public float[] keys()

Returns the keys of the map as an array of float values.

Specified by:

keys in interface TFloatDoubleMap

Returns:

the keys of the map as an array of float values.

keys

public float[] keys(float[] array)

Returns the keys of the map.

Specified by:

keys in interface TFloatDoubleMap

Parameters:

array - 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 type is allocated for this purpose.

Returns:

the keys of the map as an array.

valueCollection

public TDoubleCollection valueCollection()

Returns the values of the map as a TDoubleCollection

Specified by:

valueCollection in interface TFloatDoubleMap

Returns:

the values of the map as a TDoubleCollection

values

public double[] values()

Returns the values of the map as an array of #e# values.

Specified by:

values in interface TFloatDoubleMap

Returns:

the values of the map as an array of #e# values.

values

public double[] values(double[] array)

Returns the values of the map using an existing array.

Specified by:

values in interface TFloatDoubleMap

Parameters:

array - 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 type is allocated for this purpose.

Returns:

the values of the map as an array of #e# values.

containsValue

public boolean containsValue(double val)

Checks for the presence of val in the values of the map.

Specified by:

containsValue in interface TFloatDoubleMap

Parameters:

val - an double value

Returns:

a boolean value

containsKey

public boolean containsKey(float key)

Checks for the present of key in the keys of the map.

Specified by:

containsKey in interface TFloatDoubleMap

Parameters:

key - an float value

Returns:

a boolean value

iterator

public TFloatDoubleIterator iterator()

Specified by:

iterator in interface TFloatDoubleMap

Returns:

a TFloatDoubleIterator with access to this map's keys and values

forEachKey

public boolean forEachKey(TFloatProcedure procedure)

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TFloatDoubleMap

Parameters:

procedure - a TFloatProcedure 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.

Specified by:

forEachValue in interface TFloatDoubleMap

Parameters:

procedure - a T#F#Procedure value

Returns:

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

forEachEntry

public boolean forEachEntry(TFloatDoubleProcedure procedure)

Executes procedure for each key/value entry in the map.

Specified by:

forEachEntry in interface TFloatDoubleMap

Parameters:

procedure - a TOFloatDoubleProcedure value

Returns:

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

transformValues

public void transformValues(TDoubleFunction function)

Transform the values in this map using function.

Specified by:

transformValues in interface TFloatDoubleMap

Parameters:

function - a TDoubleFunction value

retainEntries

public boolean retainEntries(TFloatDoubleProcedure procedure)

Retains only those entries in the map for which the procedure returns a true value.

Specified by:

retainEntries in interface TFloatDoubleMap

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

increment

public boolean increment(float key)

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TFloatDoubleMap

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

adjustValue

public boolean adjustValue(float key,
                           double amount)

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TFloatDoubleMap

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.

adjustOrPutValue

public double adjustOrPutValue(float 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.

Specified by:

adjustOrPutValue in interface TFloatDoubleMap

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

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class TFloatDoubleHash

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class TFloatDoubleHash

Throws:

java.io.IOException

java.lang.ClassNotFoundException