TDoubleByteHashMap (core 3.1.0 API)

java.lang.Object
- gnu.trove.impl.hash.THash
- - gnu.trove.impl.hash.TPrimitiveHash
  - - gnu.trove.impl.hash.TDoubleByteHash
    - - gnu.trove.map.hash.TDoubleByteHashMap

All Implemented Interfaces:

TDoubleByteMap, java.io.Externalizable, java.io.Serializable
```
public class TDoubleByteHashMap
extends TDoubleByteHash
implements TDoubleByteMap, java.io.Externalizable
```
An open addressed Map implementation for double keys and byte values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`TDoubleByteHashMap.TKeyView` a view onto the keys of the map.
`protected class`	`TDoubleByteHashMap.TValueView` a view onto the values of the map.

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] _values
the values of the map
- Fields inherited from class gnu.trove.impl.hash.TDoubleByteHash
  _set, consumeFreeSlot, no_entry_key, no_entry_value
- Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash
  _states, FREE, FULL, REMOVED
- Fields inherited from class gnu.trove.impl.hash.THash
  _autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`adjustOrPutValue(double key, byte adjust_amount, byte put_amount)` Adjusts the primitive value mapped to the key if the key is present in the map.
`boolean`	`adjustValue(double key, byte amount)` Adjusts the primitive value mapped to key.
`void`	`clear()` Empties the collection.
`boolean`	`containsKey(double key)` Checks for the present of `key` in the keys of the map.
`boolean`	`containsValue(byte val)` Checks for the presence of `val` in the values of the map.
`boolean`	`equals(java.lang.Object other)`
`boolean`	`forEachEntry(TDoubleByteProcedure 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(TByteProcedure procedure)` Executes `procedure` for each value in the map.
`byte`	`get(double key)` Retrieves the value for `key`.
`int`	`hashCode()`
`boolean`	`increment(double key)` Increments the primitive value mapped to key by 1
`boolean`	`isEmpty()` Tells whether this set is currently holding any elements.
`TDoubleByteIterator`	`iterator()`
`double[]`	`keys()` Returns the keys of the map as an array of `double` values.
`double[]`	`keys(double[] array)` Returns the keys of the map.
`TDoubleSet`	`keySet()` Returns the keys of the map as a `TDoubleSet`
`byte`	`put(double key, byte value)` Inserts a key/value pair into the map.
`void`	`putAll(java.util.Map<? extends java.lang.Double,? extends java.lang.Byte> map)` Put all the entries from the given Map into this map.
`void`	`putAll(TDoubleByteMap map)` Put all the entries from the given map into this map.
`byte`	`putIfAbsent(double key, byte 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 set.
`byte`	`remove(double key)` Deletes a key/value pair from the map.
`protected void`	`removeAt(int index)` Releases the element currently stored at `index`.
`boolean`	`retainEntries(TDoubleByteProcedure 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(TByteFunction function)` Transform the values in this map using `function`.
`TByteCollection`	`valueCollection()` Returns the values of the map as a `TByteCollection`
`byte[]`	`values()` Returns the values of the map as an array of `#e#` values.
`byte[]`	`values(byte[] 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.TDoubleByteHash
contains, forEach, getNoEntryKey, getNoEntryValue, index, insertKey, XinsertKey

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

Methods inherited from class gnu.trove.impl.hash.THash
calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, fastCeil, getAutoCompactionFactor, postInsertHook, reenableAutoCompaction, saturatedCast, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

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

Methods inherited from interface gnu.trove.map.TDoubleByteMap
getNoEntryKey, getNoEntryValue, size

- Field Detail
  - _values
```
protected transient byte[] _values
```
    the values of the map
- Constructor Detail
  - TDoubleByteHashMap
```
public TDoubleByteHashMap()
```
    Creates a new TDoubleByteHashMap instance with the default capacity and load factor.
  - TDoubleByteHashMap
```
public TDoubleByteHashMap(int initialCapacity)
```
    Creates a new TDoubleByteHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
    
    Parameters:
    
    initialCapacity - an int value
  - TDoubleByteHashMap
```
public TDoubleByteHashMap(int initialCapacity,
                          float loadFactor)
```
    Creates a new TDoubleByteHashMap 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
  - TDoubleByteHashMap
```
public TDoubleByteHashMap(int initialCapacity,
                          float loadFactor,
                          double noEntryKey,
                          byte noEntryValue)
```
    Creates a new TDoubleByteHashMap 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 double value that represents null for the Key set.
    
    noEntryValue - a byte value that represents null for the Value set.
  - TDoubleByteHashMap
```
public TDoubleByteHashMap(double[] keys,
                          byte[] values)
```
    Creates a new TDoubleByteHashMap instance containing all of the entries in the map passed in.
    
    Parameters:
    
    keys - a double array containing the keys for the matching values.
    
    values - a byte array containing the values.
  - TDoubleByteHashMap
```
public TDoubleByteHashMap(TDoubleByteMap map)
```
    Creates a new TDoubleByteHashMap instance containing all of the entries in the map passed in.
    
    Parameters:
    
    map - a TDoubleByteMap that will be duplicated.
- Method Detail
  - setUp
```
protected int setUp(int initialCapacity)
```
    initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
    
    Overrides:
    
    setUp in class TDoubleByteHash
    
    Parameters:
    
    initialCapacity - an int value
    
    Returns:
    
    the actual capacity chosen
  - rehash
```
protected void rehash(int newCapacity)
```
    Rehashes the set.
    
    Specified by:
    
    rehash in class THash
    
    Parameters:
    
    newCapacity - an int value
  - put
```
public byte put(double key,
                byte value)
```
    Inserts a key/value pair into the map.
    
    Specified by:
    
    put in interface TDoubleByteMap
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TDoubleByteMap.getNoEntryValue()).
  - putIfAbsent
```
public byte putIfAbsent(double key,
                        byte 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 TDoubleByteMap
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TDoubleByteMap.getNoEntryValue()).
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.Double,? extends java.lang.Byte> map)
```
    Put all the entries from the given Map into this map.
    
    Specified by:
    
    putAll in interface TDoubleByteMap
    
    Parameters:
    
    map - The Map from which entries will be obtained to put into this map.
  - putAll
```
public void putAll(TDoubleByteMap map)
```
    Put all the entries from the given map into this map.
    
    Specified by:
    
    putAll in interface TDoubleByteMap
    
    Parameters:
    
    map - The map from which entries will be obtained to put into this map.
  - get
```
public byte get(double key)
```
    Retrieves the value for key.
    
    Specified by:
    
    get in interface TDoubleByteMap
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TDoubleByteMap.getNoEntryValue()).
  - clear
```
public void clear()
```
    Empties the collection.
    
    Specified by:
    
    clear in interface TDoubleByteMap
    
    Overrides:
    
    clear in class THash
  - isEmpty
```
public boolean isEmpty()
```
    Tells whether this set is currently holding any elements.
    
    Specified by:
    
    isEmpty in interface TDoubleByteMap
    
    Overrides:
    
    isEmpty in class THash
    
    Returns:
    
    a boolean value
  - remove
```
public byte remove(double key)
```
    Deletes a key/value pair from the map.
    
    Specified by:
    
    remove in interface TDoubleByteMap
    
    Parameters:
    
    key - an double value
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TDoubleByteMap.getNoEntryValue()).
  - removeAt
```
protected void removeAt(int index)
```
    Releases the element currently stored at index.
    
    Overrides:
    
    removeAt in class TDoubleByteHash
    
    Parameters:
    
    index - an int value
  - keySet
```
public TDoubleSet keySet()
```
    Returns the keys of the map as a TDoubleSet
    
    Specified by:
    
    keySet in interface TDoubleByteMap
    
    Returns:
    
    the keys of the map as a TDoubleSet
  - keys
```
public double[] keys()
```
    Returns the keys of the map as an array of double values.
    
    Specified by:
    
    keys in interface TDoubleByteMap
    
    Returns:
    
    the keys of the map as an array of double values.
  - keys
```
public double[] keys(double[] array)
```
    Returns the keys of the map.
    
    Specified by:
    
    keys in interface TDoubleByteMap
    
    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 TByteCollection valueCollection()
```
    Returns the values of the map as a TByteCollection
    
    Specified by:
    
    valueCollection in interface TDoubleByteMap
    
    Returns:
    
    the values of the map as a TByteCollection
  - values
```
public byte[] values()
```
    Returns the values of the map as an array of #e# values.
    
    Specified by:
    
    values in interface TDoubleByteMap
    
    Returns:
    
    the values of the map as an array of #e# values.
  - values
```
public byte[] values(byte[] array)
```
    Returns the values of the map using an existing array.
    
    Specified by:
    
    values in interface TDoubleByteMap
    
    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(byte val)
```
    Checks for the presence of val in the values of the map.
    
    Specified by:
    
    containsValue in interface TDoubleByteMap
  - containsKey
```
public boolean containsKey(double key)
```
    Checks for the present of key in the keys of the map.
    
    Specified by:
    
    containsKey in interface TDoubleByteMap
  - iterator
```
public TDoubleByteIterator iterator()
```
    Specified by:
    
    iterator in interface TDoubleByteMap
    
    Returns:
    
    a TDoubleByteIterator with access to this map's keys and values
  - forEachKey
```
public boolean forEachKey(TDoubleProcedure procedure)
```
    Executes procedure for each key in the map.
    
    Specified by:
    
    forEachKey in interface TDoubleByteMap
    
    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(TByteProcedure procedure)
```
    Executes procedure for each value in the map.
    
    Specified by:
    
    forEachValue in interface TDoubleByteMap
    
    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(TDoubleByteProcedure procedure)
```
    Executes procedure for each key/value entry in the map.
    
    Specified by:
    
    forEachEntry in interface TDoubleByteMap
    
    Parameters:
    
    procedure - a TODoubleByteProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - transformValues
```
public void transformValues(TByteFunction function)
```
    Transform the values in this map using function.
    
    Specified by:
    
    transformValues in interface TDoubleByteMap
    
    Parameters:
    
    function - a TByteFunction value
  - retainEntries
```
public boolean retainEntries(TDoubleByteProcedure procedure)
```
    Retains only those entries in the map for which the procedure returns a true value.
    
    Specified by:
    
    retainEntries in interface TDoubleByteMap
    
    Parameters:
    
    procedure - determines which entries to keep
    
    Returns:
    
    true if the map was modified.
  - increment
```
public boolean increment(double key)
```
    Increments the primitive value mapped to key by 1
    
    Specified by:
    
    increment in interface TDoubleByteMap
    
    Parameters:
    
    key - the key of the value to increment
    
    Returns:
    
    true if a mapping was found and modified.
  - adjustValue
```
public boolean adjustValue(double key,
                           byte amount)
```
    Adjusts the primitive value mapped to key.
    
    Specified by:
    
    adjustValue in interface TDoubleByteMap
    
    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 byte adjustOrPutValue(double key,
                             byte adjust_amount,
                             byte put_amount)
```
    Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the put_amount is put in the map.
    
    Specified by:
    
    adjustOrPutValue in interface TDoubleByteMap
    
    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 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 TDoubleByteHash
    
    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 TDoubleByteHash
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException

Class TDoubleByteHashMap

Nested Class Summary

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface gnu.trove.map.TDoubleByteMap

Field Detail

_values

Constructor Detail

TDoubleByteHashMap

TDoubleByteHashMap

TDoubleByteHashMap

TDoubleByteHashMap

TDoubleByteHashMap

TDoubleByteHashMap

Method Detail

setUp

rehash

put

putIfAbsent

putAll

putAll

get

clear

isEmpty

remove

removeAt

keySet

keys

keys

valueCollection

values

values

containsValue

containsKey

iterator

forEachKey

forEachValue

forEachEntry

transformValues

retainEntries

increment

adjustValue

adjustOrPutValue

equals

hashCode

toString

writeExternal

readExternal