Class FloatFloatHashMap
java.lang.Object
org.eclipse.collections.impl.primitive.AbstractFloatIterable
org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableFloatValuesMap
org.eclipse.collections.impl.map.mutable.primitive.FloatFloatHashMap
- All Implemented Interfaces:
Externalizable
,Serializable
,FloatIterable
,FloatFloatMap
,FloatValuesMap
,MutableFloatFloatMap
,MutableFloatValuesMap
,PrimitiveIterable
,MutableFloatKeysMap
,FloatKeysMap
public class FloatFloatHashMap extends AbstractMutableFloatValuesMap implements MutableFloatFloatMap, Externalizable, MutableFloatKeysMap
This file was automatically generated from template file primitivePrimitiveHashMap.stg.
- Since:
- 3.0.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description FloatFloatHashMap()
FloatFloatHashMap(int initialCapacity)
FloatFloatHashMap(FloatFloatMap map)
-
Method Summary
Modifier and Type Method Description float
addToValue(float key, float toBeAdded)
Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.MutableFloatFloatMap
asSynchronized()
Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.MutableFloatFloatMap
asUnmodifiable()
Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationException
for all mutating operations.void
clear()
Removes all entries from this map.void
compact()
Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.boolean
containsKey(float key)
Returns whether or not the key is present in the map.boolean
equals(Object obj)
Follows the same general contract asMap.equals(Object)
.MutableFloatFloatMap
flipUniqueValues()
Return the FloatFloatMap that is obtained by flipping the direction of this map and making the associations from value to key.MutableFloatIterator
floatIterator()
Returns a primitive iterator that can be used to iterate over the FloatIterable in an imperative style.void
forEachKey(FloatProcedure procedure)
Iterates through each key in the map, invoking the procedure for each.void
forEachKeyValue(FloatFloatProcedure procedure)
Iterates through each key/value pair in the map, invoking the procedure for each.float
get(float key)
Retrieves the value associated with the key.float
getIfAbsent(float key, float ifAbsent)
Retrieves the value associated with the key, returning the specified default value if no such mapping exists.float
getIfAbsentPut(float key, float value)
Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.float
getIfAbsentPut(float key, FloatFunction0 function)
Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.<P> float
getIfAbsentPutWith(float key, FloatFunction<? super P> function, P parameter)
Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.float
getIfAbsentPutWithKey(float key, FloatToFloatFunction function)
Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.float
getOrThrow(float key)
Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.int
hashCode()
Follows the same general contract asMap.hashCode()
.<V> V
injectInto(V injectedValue, ObjectFloatToObjectFunction<? super V,? extends V> function)
MutableFloatSet
keySet()
Returns a set containing all the keys in this map.LazyFloatIterable
keysView()
Returns a view of the keys in this map.RichIterable<FloatFloatPair>
keyValuesView()
Returns a view of the key/value pairs in this map.static FloatFloatHashMap
newWithKeysValues(float key1, float value1)
static FloatFloatHashMap
newWithKeysValues(float key1, float value1, float key2, float value2)
static FloatFloatHashMap
newWithKeysValues(float key1, float value1, float key2, float value2, float key3, float value3)
static FloatFloatHashMap
newWithKeysValues(float key1, float value1, float key2, float value2, float key3, float value3, float key4, float value4)
void
put(float key, float value)
Associates a value with the specified key.void
putAll(FloatFloatMap map)
Puts all of the key/value mappings from the specified map into this map.void
readExternal(ObjectInput in)
FloatFloatHashMap
reject(FloatFloatPredicate predicate)
Return a copy of this map containing only the key/value pairs that do not match the predicate.void
remove(float key)
Removes the mapping associated with the key, if one exists, from the map.void
removeKey(float key)
Removes the mapping associated with the key, if one exists, from the map.float
removeKeyIfAbsent(float key, float value)
Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.FloatFloatHashMap
select(FloatFloatPredicate predicate)
Return a copy of this map containing only the key/value pairs that match the predicate.ImmutableFloatFloatMap
toImmutable()
Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.String
toString()
Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.float
updateValue(float key, float initialValueIfAbsent, FloatToFloatFunction function)
Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.void
updateValues(FloatFloatToFloatFunction function)
Updates the values in-place.MutableFloatCollection
values()
Returns the values in this map as a separate collection.FloatFloatHashMap
withKeysValues(float key1, float value1, float key2, float value2)
FloatFloatHashMap
withKeysValues(float key1, float value1, float key2, float value2, float key3, float value3)
FloatFloatHashMap
withKeysValues(float key1, float value1, float key2, float value2, float key3, float value3, float key4, float value4)
FloatFloatHashMap
withKeyValue(float key1, float value1)
Associates a value with the specified key.FloatFloatHashMap
withoutAllKeys(FloatIterable keys)
Removes the mappings associated with all the keys, if they exist, from this map.FloatFloatHashMap
withoutKey(float key)
Removes the mapping associated with the key, if one exists, from this map.void
writeExternal(ObjectOutput out)
Methods inherited from class org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableFloatValuesMap
allSatisfy, anySatisfy, appendString, chunk, collect, contains, containsAll, containsValue, count, detectIfNone, each, forEach, forEachValue, isEmpty, max, min, noneSatisfy, notEmpty, reject, select, size, sum, toArray, toArray
Methods inherited from class org.eclipse.collections.impl.primitive.AbstractFloatIterable
asLazy, average, containsAll, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList
Methods inherited from interface org.eclipse.collections.api.FloatIterable
allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList
Methods inherited from interface org.eclipse.collections.impl.map.primitive.FloatKeysMap
isEmpty, notEmpty, size
Methods inherited from interface org.eclipse.collections.api.map.primitive.FloatValuesMap
containsValue, forEachValue, tap
Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableFloatFloatMap
putPair, withAllKeyValues
Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableFloatValuesMap
collect, reject, select
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
Constructor Details
-
FloatFloatHashMap
public FloatFloatHashMap() -
FloatFloatHashMap
public FloatFloatHashMap(int initialCapacity) -
FloatFloatHashMap
-
-
Method Details
-
newWithKeysValues
-
newWithKeysValues
public static FloatFloatHashMap newWithKeysValues(float key1, float value1, float key2, float value2) -
newWithKeysValues
public static FloatFloatHashMap newWithKeysValues(float key1, float value1, float key2, float value2, float key3, float value3) -
newWithKeysValues
public static FloatFloatHashMap newWithKeysValues(float key1, float value1, float key2, float value2, float key3, float value3, float key4, float value4) -
equals
Description copied from interface:FloatFloatMap
Follows the same general contract asMap.equals(Object)
.- Specified by:
equals
in interfaceFloatFloatMap
- Overrides:
equals
in classObject
-
hashCode
public int hashCode()Description copied from interface:FloatFloatMap
Follows the same general contract asMap.hashCode()
.- Specified by:
hashCode
in interfaceFloatFloatMap
- Overrides:
hashCode
in classObject
-
toString
Description copied from interface:PrimitiveIterable
Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.Assert.assertEquals("[]", IntLists.mutable.empty().toString()); Assert.assertEquals("[1]", IntLists.mutable.with(1).toString()); Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
- Specified by:
toString
in interfaceFloatFloatMap
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classAbstractFloatIterable
- Returns:
- a string representation of this PrimitiveIterable
- See Also:
AbstractCollection.toString()
-
floatIterator
Description copied from interface:FloatIterable
Returns a primitive iterator that can be used to iterate over the FloatIterable in an imperative style.- Specified by:
floatIterator
in interfaceFloatIterable
- Specified by:
floatIterator
in interfaceMutableFloatValuesMap
-
injectInto
public <V> V injectInto(V injectedValue, ObjectFloatToObjectFunction<? super V,? extends V> function)- Specified by:
injectInto
in interfaceFloatIterable
-
clear
public void clear()Description copied from interface:MutableFloatValuesMap
Removes all entries from this map.- Specified by:
clear
in interfaceMutableFloatKeysMap
- Specified by:
clear
in interfaceMutableFloatValuesMap
-
put
public void put(float key, float value)Description copied from interface:MutableFloatFloatMap
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Specified by:
put
in interfaceMutableFloatFloatMap
- Parameters:
key
- the keyvalue
- the value to associate withvalue
-
putAll
Description copied from interface:MutableFloatFloatMap
Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value inmap
.- Specified by:
putAll
in interfaceMutableFloatFloatMap
- Parameters:
map
- the map to copy into this map
-
updateValues
Description copied from interface:MutableFloatFloatMap
Updates the values in-place.- Specified by:
updateValues
in interfaceMutableFloatFloatMap
- Parameters:
function
- that takes a key and its value and that returns a new value for this key
-
removeKey
public void removeKey(float key)Description copied from interface:MutableFloatFloatMap
Removes the mapping associated with the key, if one exists, from the map.- Specified by:
removeKey
in interfaceMutableFloatFloatMap
- Specified by:
removeKey
in interfaceMutableFloatKeysMap
- Parameters:
key
- the key to remove- See Also:
MutableFloatFloatMap.remove(float)
-
remove
public void remove(float key)Description copied from interface:MutableFloatFloatMap
Removes the mapping associated with the key, if one exists, from the map.- Specified by:
remove
in interfaceMutableFloatFloatMap
- Parameters:
key
- the key to remove- See Also:
MutableFloatFloatMap.removeKey(float)
-
removeKeyIfAbsent
public float removeKeyIfAbsent(float key, float value)Description copied from interface:MutableFloatFloatMap
Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.- Specified by:
removeKeyIfAbsent
in interfaceMutableFloatFloatMap
- Parameters:
key
- the key to removevalue
- the default value to return if no mapping for the key exists- Returns:
- the value previously associated with the key, if one existed,
or
value
if not
-
getIfAbsentPut
public float getIfAbsentPut(float key, float value)Description copied from interface:MutableFloatFloatMap
Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.- Specified by:
getIfAbsentPut
in interfaceMutableFloatFloatMap
- Parameters:
key
- the keyvalue
- the value to associate withkey
if no such mapping exists- Returns:
- the value associated with key, if one exists, or
value
if not
-
getIfAbsentPut
Description copied from interface:MutableFloatFloatMap
Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.- Specified by:
getIfAbsentPut
in interfaceMutableFloatFloatMap
- Parameters:
key
- the keyfunction
- the supplier that provides the value if no mapping exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
if not
-
getIfAbsentPutWith
Description copied from interface:MutableFloatFloatMap
Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.- Specified by:
getIfAbsentPutWith
in interfaceMutableFloatFloatMap
- Type Parameters:
P
- the type of the value function'sparameter
- Parameters:
key
- the keyfunction
- the function that provides the value if no mapping exists. The specifiedparameter
will be passed as the argument to the function.parameter
- the parameter to provide tofunction
if no value exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
withparameter
if not
-
getIfAbsentPutWithKey
Description copied from interface:MutableFloatFloatMap
Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.- Specified by:
getIfAbsentPutWithKey
in interfaceMutableFloatFloatMap
- Parameters:
key
- the keyfunction
- the function that provides the value if no mapping exists. Thekey
will be passed as the argument to the function.- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
withkey
if not
-
addToValue
public float addToValue(float key, float toBeAdded)Description copied from interface:MutableFloatFloatMap
Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.- Specified by:
addToValue
in interfaceMutableFloatFloatMap
- Parameters:
key
- the keytoBeAdded
- the amount to increment the existing value, if one exists, or to use as the initial value if one does not- Returns:
- the value after incrementing
toBeAdded
to the existing value associated withkey
ortoBeAdded
if one does not
-
updateValue
Description copied from interface:MutableFloatFloatMap
Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.- Specified by:
updateValue
in interfaceMutableFloatFloatMap
- Parameters:
key
- the keyinitialValueIfAbsent
- the initial value to supply to the function if no mapping exists for the keyfunction
- the function that returns the updated value based on the current value or the initial value, if no value exists- Returns:
- the new value associated with the key, either as a result of applying
function
to the value already associated with the key or as a result of applying it toinitialValueIfAbsent
and associating the result withkey
-
withKeyValue
Description copied from interface:MutableFloatFloatMap
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Specified by:
withKeyValue
in interfaceMutableFloatFloatMap
- Parameters:
key1
- the keyvalue1
- the value to associate withvalue
- Returns:
- this map
- See Also:
MutableFloatFloatMap.put(float, float)
-
withKeysValues
-
withKeysValues
public FloatFloatHashMap withKeysValues(float key1, float value1, float key2, float value2, float key3, float value3) -
withKeysValues
public FloatFloatHashMap withKeysValues(float key1, float value1, float key2, float value2, float key3, float value3, float key4, float value4) -
withoutKey
Description copied from interface:MutableFloatFloatMap
Removes the mapping associated with the key, if one exists, from this map.- Specified by:
withoutKey
in interfaceMutableFloatFloatMap
- Parameters:
key
- the key to remove- Returns:
- this map
- See Also:
MutableFloatFloatMap.remove(float)
-
withoutAllKeys
Description copied from interface:MutableFloatFloatMap
Removes the mappings associated with all the keys, if they exist, from this map.- Specified by:
withoutAllKeys
in interfaceMutableFloatFloatMap
- Parameters:
keys
- the keys to remove- Returns:
- this map
- See Also:
MutableFloatFloatMap.remove(float)
-
asUnmodifiable
Description copied from interface:MutableFloatFloatMap
Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationException
for all mutating operations. This avoids the overhead of copying the map when callingFloatFloatMap.toImmutable()
while still providing immutability.- Specified by:
asUnmodifiable
in interfaceMutableFloatFloatMap
- Returns:
- an unmodifiable view of this map
-
asSynchronized
Description copied from interface:MutableFloatFloatMap
Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.- Specified by:
asSynchronized
in interfaceMutableFloatFloatMap
- Returns:
- a synchronized view of this map
-
toImmutable
Description copied from interface:FloatFloatMap
Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.- Specified by:
toImmutable
in interfaceFloatFloatMap
- Returns:
- an immutable map that is equivalent to this one
-
get
public float get(float key)Description copied from interface:FloatFloatMap
Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually0
) is returned.- Specified by:
get
in interfaceFloatFloatMap
- Parameters:
key
- the key- Returns:
- the value associated with the key, or the default value if no such mapping exists
-
getIfAbsent
public float getIfAbsent(float key, float ifAbsent)Description copied from interface:FloatFloatMap
Retrieves the value associated with the key, returning the specified default value if no such mapping exists.- Specified by:
getIfAbsent
in interfaceFloatFloatMap
- Parameters:
key
- the keyifAbsent
- the default value to return if no mapping exists forkey
- Returns:
- the value associated with the key, or
ifAbsent
if no such mapping exists.
-
getOrThrow
public float getOrThrow(float key)Description copied from interface:FloatFloatMap
Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.- Specified by:
getOrThrow
in interfaceFloatFloatMap
- Parameters:
key
- the key- Returns:
- the value associated with the key
-
containsKey
public boolean containsKey(float key)Description copied from interface:FloatFloatMap
Returns whether or not the key is present in the map.- Specified by:
containsKey
in interfaceFloatFloatMap
- Specified by:
containsKey
in interfaceFloatKeysMap
- Parameters:
key
- the key- Returns:
- if a mapping exists in this map for the key
-
forEachKey
Description copied from interface:FloatFloatMap
Iterates through each key in the map, invoking the procedure for each.- Specified by:
forEachKey
in interfaceFloatFloatMap
- Specified by:
forEachKey
in interfaceFloatKeysMap
- Parameters:
procedure
- the procedure to invoke for each key
-
forEachKeyValue
Description copied from interface:FloatFloatMap
Iterates through each key/value pair in the map, invoking the procedure for each.- Specified by:
forEachKeyValue
in interfaceFloatFloatMap
- Parameters:
procedure
- the procedure to invoke for each key/value pair
-
keysView
Description copied from interface:FloatFloatMap
Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.- Specified by:
keysView
in interfaceFloatFloatMap
- Returns:
- a view of the keys in this map
-
keyValuesView
Description copied from interface:FloatFloatMap
Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.- Specified by:
keyValuesView
in interfaceFloatFloatMap
- Returns:
- a view of the keys in this map
-
flipUniqueValues
Description copied from interface:FloatFloatMap
Return the FloatFloatMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValues
in interfaceFloatFloatMap
- Specified by:
flipUniqueValues
in interfaceMutableFloatFloatMap
-
select
Description copied from interface:FloatFloatMap
Return a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
select
in interfaceFloatFloatMap
- Specified by:
select
in interfaceMutableFloatFloatMap
- Parameters:
predicate
- the predicate to determine which key/value pairs in this map should be included in the returned map- Returns:
- a copy of this map with the matching key/value pairs
-
reject
Description copied from interface:FloatFloatMap
Return a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
reject
in interfaceFloatFloatMap
- Specified by:
reject
in interfaceMutableFloatFloatMap
- Parameters:
predicate
- the predicate to determine which key/value pairs in this map should be excluded from the returned map- Returns:
- a copy of this map without the matching key/value pairs
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-
compact
public void compact()Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels. -
keySet
Description copied from interface:FloatFloatMap
Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.- Specified by:
keySet
in interfaceFloatFloatMap
- Returns:
- a mutable set containing the keys in this map
-
values
Description copied from interface:FloatValuesMap
Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.- Specified by:
values
in interfaceFloatValuesMap
- Returns:
- the values as a collection backed by this map
-