Package gnu.trove.map.hash

# Class TFloatFloatHashMap

java.lang.Object
gnu.trove.impl.hash.THash
gnu.trove.impl.hash.TPrimitiveHash
gnu.trove.impl.hash.TFloatFloatHash
gnu.trove.map.hash.TFloatFloatHashMap

All Implemented Interfaces:
  `TFloatFloatMap`, `Externalizable`, `Serializable`

public class TFloatFloatHashMap extends gnu.trove.impl.hash.TFloatFloatHash implements TFloatFloatMap, Externalizable
An open addressed Map implementation for float keys and float values.

See Also:
  - Serialized Form

## Nested Class Summary

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

## Field Summary

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

### Fields inherited from class gnu.trove.impl.hash.TFloatFloatHash

`_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`

## Constructor Summary

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

## Method Summary

Modifier and Type
Method
Description
`float`
`adjustOrPutValue(float key, float adjust_amount, float put_amount)`
Adjusts the primitive value mapped to the key if the key is present in the map.
`boolean`
`adjustValue(float key, float 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(float val)`
Checks for the presence of `val` in the values of the map.
`boolean`
`equals(Object other)`
`boolean`
`forEachEntry(TFloatFloatProcedure 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(TFloatProcedure procedure)`
Executes `procedure` for each value in the map.
`float`
`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.
`TFloatFloatIterator`
`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`
`float`
`put(float key, float value)`
Inserts a key/value pair into the map.
`void`
`putAll(TFloatFloatMap map)`
Put all the entries from the given map into this map.
`void`
`putAll(Map<? extends Float,? extends Float> map)`
Put all the entries from the given Map into this map.
`float`
`putIfAbsent(float key, float value)`
Inserts a key/value pair into the map if the specified key is not already associated with a value.
`void`
`readExternal(ObjectInput in)`
`protected void`
`rehash(int newCapacity)`
Rehashes the set.
`float`
`remove(float key)`
Deletes a key/value pair from the map.
`protected void`
`removeAt(int index)`
Releases the element currently stored at `index`.
`boolean`
`retainEntries(TFloatFloatProcedure 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`.
`String`
`toString()`
`void`
`transformValues(TFloatFunction function)`
Transform the values in this map using `function`.
`TFloatCollection`
`valueCollection()`
Returns the values of the map as a `TFloatCollection`
`float[]`
`values()`
Returns the values of the map as an array of `#e#` values.
`float[]`
`values(float[] array)`
Returns the values of the map using an existing array.
`void`
`writeExternal(ObjectOutput out)`

### Methods inherited from class gnu.trove.impl.hash.TFloatFloatHash

`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, getAutoCompactionFactor, postInsertHook, reenableAutoCompaction, 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.TFloatFloatMap

`getNoEntryKey, getNoEntryValue, size`

## Field Details

### _values

protected transient float[] _values
the values of the map

## Constructor Details

### TFloatFloatHashMap

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

### TFloatFloatHashMap

public TFloatFloatHashMap(int initialCapacity)
Creates a new `TFloatFloatHashMap` instance with a prime capacity equal to or greater than `initialCapacity` and with the default load factor.

Parameters:
  `initialCapacity` - an `int` value

### TFloatFloatHashMap

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

### TFloatFloatHashMap

public TFloatFloatHashMap(int initialCapacity, float loadFactor, float noEntryKey, float noEntryValue)
Creates a new `TFloatFloatHashMap` 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 `float` value that represents `null` for the Value set.

### TFloatFloatHashMap

public TFloatFloatHashMap(float[] keys, float[] values)
Creates a new `TFloatFloatHashMap` 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 `float` array containing the values.

### TFloatFloatHashMap

public TFloatFloatHashMap(TFloatFloatMap map)
Creates a new `TFloatFloatHashMap` instance containing all of the entries in the map passed in.

Parameters:
  `map` - a `TFloatFloatMap` that will be duplicated.

## Method Details

### setUp

protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least `initialCapacity + 1`.

Overrides:
  `setUp` in class `gnu.trove.impl.hash.TFloatFloatHash`
Parameters:
  `initialCapacity` - an `int` value
Returns:
  the actual capacity chosen

### rehash

protected void rehash(int newCapacity)
Rehashes the set.

Specified by:
  `rehash` in class `gnu.trove.impl.hash.THash`
Parameters:
  `newCapacity` - an `int` value

### put

public float put(float key, float value)
Inserts a key/value pair into the map.

Specified by:
  `put` in interface `TFloatFloatMap`
Parameters:
  `key` - an `float` value
  `value` - an `float` value
Returns:
  the previous value associated with `key`, or the "no entry" value if none was found (see `TFloatFloatMap.getNoEntryValue()`).

### putIfAbsent

public float putIfAbsent(float key, float 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 `TFloatFloatMap`
Parameters:
  `key` - an `float` value
  `value` - an `float` value
Returns:
  the previous value associated with `key`, or the "no entry" value if none was found (see `TFloatFloatMap.getNoEntryValue()`).

### putAll

public void putAll(Map<? extends Float,? extends Float> map)
Put all the entries from the given Map into this map.

Specified by:
  `putAll` in interface `TFloatFloatMap`
Parameters:
  `map` - The Map from which entries will be obtained to put into this map.

### putAll

public void putAll(TFloatFloatMap map)
Put all the entries from the given map into this map.

Specified by:
  `putAll` in interface `TFloatFloatMap`
Parameters:
  `map` - The map from which entries will be obtained to put into this map.

### get

public float get(float key)
Retrieves the value for `key`

Specified by:
  `get` in interface `TFloatFloatMap`
Parameters:
  `key` - an `float` value
Returns:
  the previous value associated with `key`, or the "no entry" value if none was found (see `TFloatFloatMap.getNoEntryValue()`).

### clear

public void clear()
Empties the collection.

Specified by:
  `clear` in interface `TFloatFloatMap`
Overrides:
  `clear` in class `gnu.trove.impl.hash.THash`

### isEmpty

public boolean isEmpty()
Tells whether this set is currently holding any elements.

Specified by:
  `isEmpty` in interface `TFloatFloatMap`
Overrides:
  `isEmpty` in class `gnu.trove.impl.hash.THash`
Returns:
  a `boolean` value

### remove

public float remove(float key)
Deletes a key/value pair from the map.

Specified by:
  `remove` in interface `TFloatFloatMap`
Parameters:
  `key` - an `float` value
Returns:
  the previous value associated with `key`, or the "no entry" value if none was found (see `TFloatFloatMap.getNoEntryValue()`).

### removeAt

protected void removeAt(int index)
Releases the element currently stored at `index`.

Overrides:
  `removeAt` in class `gnu.trove.impl.hash.TFloatFloatHash`
Parameters:
  `index` - an `int` value

### keySet

public TFloatSet keySet()
Returns the keys of the map as a `TFloatSet`

Specified by:
  `keySet` in interface `TFloatFloatMap`
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 `TFloatFloatMap`
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 `TFloatFloatMap`
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 TFloatCollection valueCollection()
Returns the values of the map as a `TFloatCollection`

Specified by:
  `valueCollection` in interface `TFloatFloatMap`
Returns:
  the values of the map as a `TFloatCollection`

### values

public float[] values()
Returns the values of the map as an array of `#e#` values.

Specified by:
  `values` in interface `TFloatFloatMap`
Returns:
  the values of the map as an array of `#e#` values.

### values

public float[] values(float[] array)
Returns the values of the map using an existing array.

Specified by:
  `values` in interface `TFloatFloatMap`
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(float val)
Checks for the presence of `val` in the values of the map.

Specified by:
  `containsValue` in interface `TFloatFloatMap`
Parameters:
  `val` - an `float` 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 `TFloatFloatMap`
Parameters:
  `key` - an `float` value
Returns:
  a `boolean` value

### iterator

public TFloatFloatIterator iterator()

Specified by:
  `iterator` in interface `TFloatFloatMap`
Returns:
  a TFloatFloatIterator 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 `TFloatFloatMap`
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(TFloatProcedure procedure)
Executes `procedure` for each value in the map.

Specified by:
  `forEachValue` in interface `TFloatFloatMap`
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(TFloatFloatProcedure procedure)
Executes `procedure` for each key/value entry in the map.

Specified by:
  `forEachEntry` in interface `TFloatFloatMap`
Parameters:
  `procedure` - a `TOFloatFloatProcedure` value
Returns:
  false if the loop over the entries terminated because the procedure returned false for some entry.

### transformValues

public void transformValues(TFloatFunction function)
Transform the values in this map using `function`.

Specified by:
  `transformValues` in interface `TFloatFloatMap`
Parameters:
  `function` - a `TFloatFunction` value

### retainEntries

public boolean retainEntries(TFloatFloatProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.

Specified by:
  `retainEntries` in interface `TFloatFloatMap`
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 `TFloatFloatMap`
Parameters:
  `key` - the key of the value to increment
Returns:
  true if a mapping was found and modified.

### adjustValue

public boolean adjustValue(float key, float amount)
Adjusts the primitive value mapped to key.

Specified by:
  `adjustValue` in interface `TFloatFloatMap`
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 float adjustOrPutValue(float key, float adjust_amount, float 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 `TFloatFloatMap`
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(Object other)

Overrides:
  `equals` in class `Object`

### hashCode

public int hashCode()

Overrides:
  `hashCode` in class `Object`

### toString

public String toString()

Overrides:
  `toString` in class `Object`

### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Specified by:
  `writeExternal` in interface `Externalizable`
Overrides:
  `writeExternal` in class `gnu.trove.impl.hash.TFloatFloatHash`
Throws:
  `IOException`

### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Specified by:
  `readExternal` in interface `Externalizable`
Overrides:
  `readExternal` in class `gnu.trove.impl.hash.TFloatFloatHash`
Throws:
  `IOException`
  `ClassNotFoundException`