Package org.eclipse.collections.impl.map.mutable.primitive

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 an UnsupportedOperationException 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 as Map.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	getAndPut(float key, float putValue, float defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue 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 an IllegalStateException if no such mapping exists.
int	hashCode()	Follows the same general contract as Map.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, forEachValue, isEmpty, max, min, notEmpty, reject, select, size, sum, toArray, toArray

Methods inherited from class org.eclipse.collections.impl.primitive.AbstractFloatIterable

asLazy, average, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.map.primitive.FloatFloatMap

injectIntoKeyValue

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, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy

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

public FloatFloatHashMap(FloatFloatMap map)

Method Details

newWithKeysValues

public static FloatFloatHashMap newWithKeysValues(float key1,
 float value1)

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

public boolean equals(Object obj)

Description copied from interface: FloatFloatMap

Follows the same general contract as Map.equals(Object).

Specified by:

equals in interface FloatFloatMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: FloatFloatMap

Follows the same general contract as Map.hashCode().

Specified by:

hashCode in interface FloatFloatMap

Overrides:

hashCode in class Object

toString

public String 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 interface FloatFloatMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class AbstractFloatIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

floatIterator

public MutableFloatIterator 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 interface FloatIterable

Specified by:

floatIterator in interface MutableFloatValuesMap

injectInto

public <V> V injectInto(V injectedValue,
 ObjectFloatToObjectFunction<? super V,? extends V> function)

Specified by:

injectInto in interface FloatIterable

clear

public void clear()

Description copied from interface: MutableFloatValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableFloatKeysMap

Specified by:

clear in interface MutableFloatValuesMap

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 with value.

Specified by:

put in interface MutableFloatFloatMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(FloatFloatMap map)

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 in map.

Specified by:

putAll in interface MutableFloatFloatMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(FloatFloatToFloatFunction function)

Description copied from interface: MutableFloatFloatMap

Updates the values in-place.

Specified by:

updateValues in interface MutableFloatFloatMap

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 interface MutableFloatFloatMap

Specified by:

removeKey in interface MutableFloatKeysMap

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 interface MutableFloatFloatMap

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 interface MutableFloatFloatMap

Parameters:

key - the key to remove

value - 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 interface MutableFloatFloatMap

Parameters:

key - the key

value - the value to associate with key if no such mapping exists

Returns:

the value associated with key, if one exists, or value if not

getAndPut

public float getAndPut(float key,
 float putValue,
 float defaultValue)

Description copied from interface: MutableFloatFloatMap

Retrieves the value associated with the key if one exists; associates a putValue with the key.

Specified by:

getAndPut in interface MutableFloatFloatMap

Parameters:

key - the key

putValue - the value to associate with key if no such mapping exists

defaultValue - the value to return if no mapping associated with key exists

Returns:

the value associated with key, if one exists, or defaultValue if not

getIfAbsentPut

public float getIfAbsentPut(float key,
 FloatFunction0 function)

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 interface MutableFloatFloatMap

Parameters:

key - the key

function - the supplier that provides the value if no mapping exists for key

Returns:

the value associated with the key, if one exists, or the result of invoking function if not

getIfAbsentPutWith

public <P> float getIfAbsentPutWith(float key,
 FloatFunction<? super P> function,
 P parameter)

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 interface MutableFloatFloatMap

Type Parameters:

P - the type of the value function's parameter

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.

parameter - the parameter to provide to function if no value exists for key

Returns:

the value associated with the key, if one exists, or the result of invoking function with parameter if not

getIfAbsentPutWithKey

public float getIfAbsentPutWithKey(float key,
 FloatToFloatFunction function)

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 interface MutableFloatFloatMap

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The key 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 with key 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 interface MutableFloatFloatMap

Parameters:

key - the key

toBeAdded - 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 with key or toBeAdded if one does not

updateValue

public float updateValue(float key,
 float initialValueIfAbsent,
 FloatToFloatFunction function)

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 interface MutableFloatFloatMap

Parameters:

key - the key

initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key

function - 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 to initialValueIfAbsent and associating the result with key

withKeyValue

public FloatFloatHashMap withKeyValue(float key1,
 float value1)

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 with value.

Specified by:

withKeyValue in interface MutableFloatFloatMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableFloatFloatMap.put(float, float)

withKeysValues

public FloatFloatHashMap withKeysValues(float key1,
 float value1,
 float key2,
 float value2)

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

public FloatFloatHashMap withoutKey(float key)

Description copied from interface: MutableFloatFloatMap

Removes the mapping associated with the key, if one exists, from this map.

Specified by:

withoutKey in interface MutableFloatFloatMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableFloatFloatMap.remove(float)

withoutAllKeys

public FloatFloatHashMap withoutAllKeys(FloatIterable keys)

Description copied from interface: MutableFloatFloatMap

Removes the mappings associated with all the keys, if they exist, from this map.

Specified by:

withoutAllKeys in interface MutableFloatFloatMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableFloatFloatMap.remove(float)

asUnmodifiable

public MutableFloatFloatMap asUnmodifiable()

Description copied from interface: MutableFloatFloatMap

Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling FloatFloatMap.toImmutable() while still providing immutability.

Specified by:

asUnmodifiable in interface MutableFloatFloatMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableFloatFloatMap 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 interface MutableFloatFloatMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableFloatFloatMap 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 interface FloatFloatMap

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 (usually 0) is returned.

Specified by:

get in interface FloatFloatMap

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 interface FloatFloatMap

Parameters:

key - the key

ifAbsent - the default value to return if no mapping exists for key

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 an IllegalStateException if no such mapping exists.

Specified by:

getOrThrow in interface FloatFloatMap

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 interface FloatFloatMap

Specified by:

containsKey in interface FloatKeysMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

forEachKey

public void forEachKey(FloatProcedure procedure)

Description copied from interface: FloatFloatMap

Iterates through each key in the map, invoking the procedure for each.

Specified by:

forEachKey in interface FloatFloatMap

Specified by:

forEachKey in interface FloatKeysMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(FloatFloatProcedure procedure)

Description copied from interface: FloatFloatMap

Iterates through each key/value pair in the map, invoking the procedure for each.

Specified by:

forEachKeyValue in interface FloatFloatMap

Parameters:

procedure - the procedure to invoke for each key/value pair

keysView

public LazyFloatIterable 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 interface FloatFloatMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<FloatFloatPair> 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 interface FloatFloatMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableFloatFloatMap 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 interface FloatFloatMap

Specified by:

flipUniqueValues in interface MutableFloatFloatMap

select

public FloatFloatHashMap select(FloatFloatPredicate predicate)

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 interface FloatFloatMap

Specified by:

select in interface MutableFloatFloatMap

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

public FloatFloatHashMap reject(FloatFloatPredicate predicate)

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 interface FloatFloatMap

Specified by:

reject in interface MutableFloatFloatMap

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

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

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

public MutableFloatSet 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 interface FloatFloatMap

Returns:

a mutable set containing the keys in this map

values

public MutableFloatCollection 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 interface FloatValuesMap

Returns:

the values as a collection backed by this map