java.lang.Object
- gnu.trove.THash
- - gnu.trove.TObjectHash<K>
  - - gnu.trove.TObjectDoubleHashMap<K>

All Implemented Interfaces:

TObjectHashingStrategy<K>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable
```
public class TObjectDoubleHashMap<K>
extends TObjectHash<K>
implements java.io.Externalizable
```
An open addressed Map implementation for Object keys and double 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 double[] _values
the values of the map
- Fields inherited from class gnu.trove.TObjectHash
  _hashingStrategy, _set, FREE, REMOVED
- Fields inherited from class gnu.trove.THash
  _autoCompactionFactor, _autoCompactRemovesRemaining, _free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

Constructors
Constructor	Description
`TObjectDoubleHashMap()`	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, 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<K> strategy)`	Creates a new `TObjectDoubleHashMap` instance with a prime value at or near the specified capacity and load factor.
`TObjectDoubleHashMap(int initialCapacity, TObjectHashingStrategy<K> strategy)`	Creates a new `TObjectDoubleHashMap` instance whose capacity is the next highest prime above `initialCapacity + 1` unless that value is already prime.
`TObjectDoubleHashMap(TObjectHashingStrategy<K> strategy)`	Creates a new `TObjectDoubleHashMap` instance with the default capacity and load factor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`TObjectDoubleHashMap<K>`	`clone()`
`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(java.lang.Object other)`	Compares this map with another map for equality of their stored entries.
`boolean`	`forEachEntry(TObjectDoubleProcedure<K> procedure)`	Executes `procedure` for each key/value entry in the map.
`boolean`	`forEachKey(TObjectProcedure<K> 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<K>`	`iterator()`
`java.lang.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`	`putAll(TObjectDoubleHashMap<K> map)`	Put all the entries from the given map into this map.
`double`	`putIfAbsent(K 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)`
`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<K> 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(TDoubleFunction function)`	Transform the values in this map using `function`.
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class gnu.trove.TObjectHash
capacity, computeHashCode, contains, equals, forEach, index, insertionIndex, throwObjectContractViolation

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

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

- Field Detail
  - _values
```
protected transient double[] _values
```
    the values of the map
- Constructor Detail
  - TObjectDoubleHashMap
```
public TObjectDoubleHashMap()
```
    Creates a new TObjectDoubleHashMap instance with the default capacity and load factor.
  - 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,
                            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(TObjectHashingStrategy<K> 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,
                            TObjectHashingStrategy<K> 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,
                            TObjectHashingStrategy<K> 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 Detail
  - iterator
```
public TObjectDoubleIterator<K> iterator()
```
    Returns:
    
    an iterator over the entries in this map
  - setUp
```
protected int setUp(int initialCapacity)
```
    initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
    
    Overrides:
    
    setUp in class TObjectHash<K>
    
    Parameters:
    
    initialCapacity - an int value
    
    Returns:
    
    the actual capacity chosen
  - 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.
  - putIfAbsent
```
public double putIfAbsent(K key,
                          double value)
```
    Inserts a key/value pair into the map if the specified key is not already associated with a value.
    
    Parameters:
    
    key - an Object value
    
    value - an double value
    
    Returns:
    
    the previous value associated with key, or (double)0 if none was found.
  - putAll
```
public void putAll(TObjectDoubleHashMap<K> 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 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.
  - clear
```
public void clear()
```
    Empties the map.
    
    Overrides:
    
    clear in class THash
  - 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.
  - 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
  - clone
```
public TObjectDoubleHashMap<K> clone()
```
    Overrides:
    
    clone in class TObjectHash<K>
    
    Returns:
    
    a shallow clone of this collection
  - removeAt
```
protected void removeAt(int index)
```
    removes the mapping at index from the map.
    
    Overrides:
    
    removeAt in class TObjectHash<K>
    
    Parameters:
    
    index - an int value
  - getValues
```
public double[] getValues()
```
    Returns the values of the map.
    
    Returns:
    
    a Collection value
  - keys
```
public java.lang.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
  - 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
  - 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
  - forEachKey
```
public boolean forEachKey(TObjectProcedure<K> 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.
  - forEachEntry
```
public boolean forEachEntry(TObjectDoubleProcedure<K> 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.
  - retainEntries
```
public boolean retainEntries(TObjectDoubleProcedure<K> 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(TDoubleFunction function)
```
    Transform the values in this map using function.
    
    Parameters:
    
    function - a TDoubleFunction 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.
  - 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.
  - 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
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Overrides:
    
    writeExternal in class TObjectHash<K>
    
    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 TObjectHash<K>
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TObjectDoubleHashMap<K>

Field Summary

Fields inherited from class gnu.trove.TObjectHash

Fields inherited from class gnu.trove.THash

Constructor Summary

Method Summary

Methods inherited from class gnu.trove.TObjectHash

Methods inherited from class gnu.trove.THash

Methods inherited from class java.lang.Object

Field Detail

_values

Constructor Detail

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

Method Detail

iterator

setUp

put

putIfAbsent

putAll

rehash

get

clear

remove

equals

clone

removeAt

getValues

keys

keys

containsValue

containsKey

forEachKey

forEachValue

forEachEntry

retainEntries

transformValues

increment

adjustValue

adjustOrPutValue

writeExternal

readExternal

toString