TDoubleObjectHashMap (GNU Trove for Java API v2.1.0)

java.lang.Object
- gnu.trove.THash
- - gnu.trove.TPrimitiveHash
  - - gnu.trove.TDoubleHash
    - - gnu.trove.TDoubleObjectHashMap<V>

All Implemented Interfaces:

TDoubleHashingStrategy, java.io.Externalizable, java.io.Serializable
```
public class TDoubleObjectHashMap<V>
extends TDoubleHash
implements java.io.Externalizable
```
An open addressed Map implementation for double keys and Object values. Created: Sun Nov 4 08:52:45 2001

Author:

Eric D. Friedman

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected V[] _values
the values of the map
- Fields inherited from class gnu.trove.TDoubleHash
  _hashingStrategy, _set
- Fields inherited from class gnu.trove.THash
  _autoCompactionFactor, _autoCompactRemovesRemaining, _free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR
- Fields inherited from class gnu.trove.TPrimitiveHash
  _states, FREE, FULL, REMOVED

Fields
Modifier and Type	Field	Description
`protected V[]`	`_values`	the values of the map

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`	Empties the map.
`TDoubleObjectHashMap<V>`	`clone()`
`boolean`	`containsKey(double key)`	checks for the present of `key` in the keys of the map.
`boolean`	`containsValue(V val)`	checks for the presence of `val` in the values of the map.
`boolean`	`equals(java.lang.Object other)`	Compares this map with another map for equality of their stored entries.
`boolean`	`forEachEntry(TDoubleObjectProcedure<V> procedure)`	Executes `procedure` for each key/value entry in the map.
`boolean`	`forEachKey(TDoubleProcedure procedure)`	Executes `procedure` for each key in the map.
`boolean`	`forEachValue(TObjectProcedure<V> procedure)`	Executes `procedure` for each value in the map.
`V`	`get(double key)`	retrieves the value for `key`
`java.lang.Object[]`	`getValues()`	Returns the values of the map.
`<T> T[]`	`getValues(T[] a)`	Return the values of the map; the runtime type of the returned array is that of the specified array.
`int`	`hashCode()`
`TDoubleObjectIterator<V>`	`iterator()`
`double[]`	`keys()`	returns the keys of the map.
`double[]`	`keys(double[] a)`	returns the keys of the map.
`V`	`put(double key, V value)`	Inserts a key/value pair into the map.
`void`	`putAll(TDoubleObjectHashMap<V> map)`	Put all the entries from the given map into this map.
`V`	`putIfAbsent(double key, V 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)`
`protected void`	`rehash(int newCapacity)`	rehashes the map to the new capacity.
`V`	`remove(double key)`	Deletes a key/value pair from the map.
`protected void`	`removeAt(int index)`	removes the mapping at `index` from the map.
`boolean`	`retainEntries(TDoubleObjectProcedure<V> 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`.
`java.lang.String`	`toString()`
`void`	`transformValues(TObjectFunction<V,V> function)`	Transform the values in this map using `function`.
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class gnu.trove.TDoubleHash
computeHashCode, contains, forEach, index, insertionIndex

Methods inherited from class gnu.trove.THash
calculateGrownCapacity, compact, ensureCapacity, getAutoCompactionFactor, isEmpty, postInsertHook, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class gnu.trove.TPrimitiveHash
capacity

- Field Detail
  - _values
```
protected transient V[] _values
```
    the values of the map
- Constructor Detail
  - TDoubleObjectHashMap
```
public TDoubleObjectHashMap()
```
    Creates a new TDoubleObjectHashMap instance with the default capacity and load factor.
  - TDoubleObjectHashMap
```
public TDoubleObjectHashMap(int initialCapacity)
```
    Creates a new TDoubleObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
    
    Parameters:
    
    initialCapacity - an int value
  - TDoubleObjectHashMap
```
public TDoubleObjectHashMap(int initialCapacity,
                            float loadFactor)
```
    Creates a new TDoubleObjectHashMap 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
  - TDoubleObjectHashMap
```
public TDoubleObjectHashMap(TDoubleHashingStrategy strategy)
```
    Creates a new TDoubleObjectHashMap instance with the default capacity and load factor.
    
    Parameters:
    
    strategy - used to compute hash codes and to compare keys.
  - TDoubleObjectHashMap
```
public TDoubleObjectHashMap(int initialCapacity,
                            TDoubleHashingStrategy strategy)
```
    Creates a new TDoubleObjectHashMap 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.
  - TDoubleObjectHashMap
```
public TDoubleObjectHashMap(int initialCapacity,
                            float loadFactor,
                            TDoubleHashingStrategy strategy)
```
    Creates a new TDoubleObjectHashMap 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
  - clone
```
public TDoubleObjectHashMap<V> clone()
```
    Overrides:
    
    clone in class TDoubleHash
    
    Returns:
    
    a deep clone of this collection
  - iterator
```
public TDoubleObjectIterator<V> iterator()
```
    Returns:
    
    a TDoubleObjectIterator with access to this map's keys and values
  - setUp
```
protected int setUp(int initialCapacity)
```
    initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
    
    Overrides:
    
    setUp in class TDoubleHash
    
    Parameters:
    
    initialCapacity - an int value
    
    Returns:
    
    the actual capacity chosen
  - put
```
public V put(double key,
             V value)
```
    Inserts a key/value pair into the map.
    
    Parameters:
    
    key - an double value
    
    value - an Object value
    
    Returns:
    
    the previous value associated with key, or null if none was found.
  - putIfAbsent
```
public V putIfAbsent(double key,
                     V value)
```
    Inserts a key/value pair into the map if the specified key is not already associated with a value.
    
    Parameters:
    
    key - an double value
    
    value - an Object value
    
    Returns:
    
    the previous value associated with key, or null if none was found.
  - putAll
```
public void putAll(TDoubleObjectHashMap<V> map)
```
    Put all the entries from the given map into this map.
    
    Parameters:
    
    map - The map from which entries will be obtained to put into this map.
  - rehash
```
protected void rehash(int newCapacity)
```
    rehashes the map to the new capacity.
    
    Specified by:
    
    rehash in class THash
    
    Parameters:
    
    newCapacity - an int value
  - get
```
public V get(double key)
```
    retrieves the value for key
    
    Parameters:
    
    key - an double value
    
    Returns:
    
    the value of key or (double)0 if no such mapping exists.
  - clear
```
public void clear()
```
    Empties the map.
    
    Overrides:
    
    clear in class THash
  - remove
```
public V remove(double key)
```
    Deletes a key/value pair from the map.
    
    Parameters:
    
    key - an double value
    
    Returns:
    
    an Object value or (double)0 if no such mapping exists.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Compares this map with another map for equality of their stored entries.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - an Object value
    
    Returns:
    
    a boolean value
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - removeAt
```
protected void removeAt(int index)
```
    removes the mapping at index from the map.
    
    Overrides:
    
    removeAt in class TDoubleHash
    
    Parameters:
    
    index - an int value
  - getValues
```
public java.lang.Object[] getValues()
```
    Returns the values of the map.
    
    Returns:
    
    a Collection value
    
    See Also:
    
    getValues(Object[])
  - getValues
```
public <T> T[] getValues(T[] a)
```
    Return the values of the map; the runtime type of the returned array is that of the specified array.
    
    Parameters:
    
    a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
    
    Returns:
    
    an array containing the elements of this collection
    
    Throws:
    
    java.lang.ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.
    
    java.lang.NullPointerException - if the specified array is null.
    
    See Also:
    
    getValues()
  - keys
```
public double[] keys()
```
    returns the keys of the map.
    
    Returns:
    
    a Set value
  - keys
```
public double[] keys(double[] 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 type is allocated for this purpose.
    
    Returns:
    
    a Set value
  - containsValue
```
public boolean containsValue(V val)
```
    checks for the presence of val in the values of the map.
    
    Parameters:
    
    val - an Object value
    
    Returns:
    
    a boolean value
  - containsKey
```
public boolean containsKey(double key)
```
    checks for the present of key in the keys of the map.
    
    Parameters:
    
    key - an double value
    
    Returns:
    
    a boolean value
  - forEachKey
```
public boolean forEachKey(TDoubleProcedure procedure)
```
    Executes procedure for each key in the map.
    
    Parameters:
    
    procedure - a TDoubleProcedure value
    
    Returns:
    
    false if the loop over the keys terminated because the procedure returned false for some key.
  - forEachValue
```
public boolean forEachValue(TObjectProcedure<V> procedure)
```
    Executes procedure for each value in the map.
    
    Parameters:
    
    procedure - a TObjectProcedure value
    
    Returns:
    
    false if the loop over the values terminated because the procedure returned false for some value.
  - forEachEntry
```
public boolean forEachEntry(TDoubleObjectProcedure<V> procedure)
```
    Executes procedure for each key/value entry in the map.
    
    Parameters:
    
    procedure - a TODoubleObjectProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - retainEntries
```
public boolean retainEntries(TDoubleObjectProcedure<V> 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.
  - transformValues
```
public void transformValues(TObjectFunction<V,V> function)
```
    Transform the values in this map using function.
    
    Parameters:
    
    function - a TObjectFunction value
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Overrides:
    
    writeExternal in class THash
    
    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 THash
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TDoubleObjectHashMap<V>

Field Summary

Fields inherited from class gnu.trove.TDoubleHash

Fields inherited from class gnu.trove.THash

Fields inherited from class gnu.trove.TPrimitiveHash

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class gnu.trove.TDoubleHash

Methods inherited from class gnu.trove.THash

Methods inherited from class gnu.trove.TPrimitiveHash

Field Detail

_values

Constructor Detail

TDoubleObjectHashMap

TDoubleObjectHashMap

TDoubleObjectHashMap

TDoubleObjectHashMap

TDoubleObjectHashMap

TDoubleObjectHashMap

Method Detail

clone

iterator

setUp

put

putIfAbsent

putAll

rehash

get

clear

remove

equals

hashCode

removeAt

getValues

getValues

keys

keys

containsValue

containsKey

forEachKey

forEachValue

forEachEntry

retainEntries

transformValues

writeExternal

readExternal

toString