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

Class ShortFloatHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractFloatIterable

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

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

All Implemented Interfaces:

Externalizable, Serializable, FloatIterable, FloatValuesMap, MutableFloatValuesMap, MutableShortFloatMap, ShortFloatMap, PrimitiveIterable, MutableShortKeysMap, ShortKeysMap

public class ShortFloatHashMap
extends AbstractMutableFloatValuesMap
implements MutableShortFloatMap, Externalizable, MutableShortKeysMap

This file was automatically generated from template file primitivePrimitiveHashMap.stg.

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ShortFloatHashMap()
ShortFloatHashMap(int initialCapacity)
ShortFloatHashMap(ShortFloatMap map)

Method Summary

Modifier and Type	Method	Description
float	addToValue(short 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.
MutableShortFloatMap	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.
MutableShortFloatMap	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(short 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).
MutableFloatShortMap	flipUniqueValues()	Return the FloatShortMap 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(ShortProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(ShortFloatProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
float	get(short key)	Retrieves the value associated with the key.
float	getAndPut(short key, float putValue, float defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
float	getIfAbsent(short key, float ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
float	getIfAbsentPut(short 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(short 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(short 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(short key, ShortToFloatFunction 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(short 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)
MutableShortSet	keySet()	Returns a set containing all the keys in this map.
LazyShortIterable	keysView()	Returns a view of the keys in this map.
RichIterable<ShortFloatPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
static ShortFloatHashMap	newWithKeysValues(short key1, float value1)
static ShortFloatHashMap	newWithKeysValues(short key1, float value1, short key2, float value2)
static ShortFloatHashMap	newWithKeysValues(short key1, float value1, short key2, float value2, short key3, float value3)
static ShortFloatHashMap	newWithKeysValues(short key1, float value1, short key2, float value2, short key3, float value3, short key4, float value4)
void	put(short key, float value)	Associates a value with the specified key.
void	putAll(ShortFloatMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
ShortFloatHashMap	reject(ShortFloatPredicate predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
void	remove(short key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(short key)	Removes the mapping associated with the key, if one exists, from the map.
float	removeKeyIfAbsent(short key, float value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
ShortFloatHashMap	select(ShortFloatPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableShortFloatMap	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(short 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(ShortFloatToFloatFunction function)	Updates the values in-place.
MutableFloatCollection	values()	Returns the values in this map as a separate collection.
ShortFloatHashMap	withKeysValues(short key1, float value1, short key2, float value2)
ShortFloatHashMap	withKeysValues(short key1, float value1, short key2, float value2, short key3, float value3)
ShortFloatHashMap	withKeysValues(short key1, float value1, short key2, float value2, short key3, float value3, short key4, float value4)
ShortFloatHashMap	withKeyValue(short key1, float value1)	Associates a value with the specified key.
ShortFloatHashMap	withoutAllKeys(ShortIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
ShortFloatHashMap	withoutKey(short 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.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.api.map.primitive.FloatValuesMap

containsValue, forEachValue, tap

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

collect, reject, select

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

putPair, withAllKeyValues

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

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

injectIntoKeyValue

Methods inherited from interface org.eclipse.collections.impl.map.primitive.ShortKeysMap

isEmpty, notEmpty, size

Constructor Details

ShortFloatHashMap

public ShortFloatHashMap()

ShortFloatHashMap

public ShortFloatHashMap(int initialCapacity)

ShortFloatHashMap

public ShortFloatHashMap(ShortFloatMap map)

Method Details

newWithKeysValues

public static ShortFloatHashMap newWithKeysValues(short key1,
 float value1)

newWithKeysValues

public static ShortFloatHashMap newWithKeysValues(short key1,
 float value1,
 short key2,
 float value2)

newWithKeysValues

public static ShortFloatHashMap newWithKeysValues(short key1,
 float value1,
 short key2,
 float value2,
 short key3,
 float value3)

newWithKeysValues

public static ShortFloatHashMap newWithKeysValues(short key1,
 float value1,
 short key2,
 float value2,
 short key3,
 float value3,
 short key4,
 float value4)

equals

public boolean equals(Object obj)

Description copied from interface: ShortFloatMap

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

Specified by:

equals in interface ShortFloatMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ShortFloatMap

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

Specified by:

hashCode in interface ShortFloatMap

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 PrimitiveIterable

Specified by:

toString in interface ShortFloatMap

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 MutableFloatValuesMap

Specified by:

clear in interface MutableShortKeysMap

put

public void put(short key,
 float value)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(ShortFloatMap map)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(ShortFloatToFloatFunction function)

Description copied from interface: MutableShortFloatMap

Updates the values in-place.

Specified by:

updateValues in interface MutableShortFloatMap

Parameters:

function - that takes a key and its value and that returns a new value for this key

removeKey

public void removeKey(short key)

Description copied from interface: MutableShortFloatMap

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

Specified by:

removeKey in interface MutableShortFloatMap

Specified by:

removeKey in interface MutableShortKeysMap

Parameters:

key - the key to remove

See Also:

• MutableShortFloatMap.remove(short)

remove

public void remove(short key)

Description copied from interface: MutableShortFloatMap

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

Specified by:

remove in interface MutableShortFloatMap

Parameters:

key - the key to remove

See Also:

• MutableShortFloatMap.removeKey(short)

removeKeyIfAbsent

public float removeKeyIfAbsent(short key,
 float value)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

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(short key,
 float value)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

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(short key,
 float putValue,
 float defaultValue)

Description copied from interface: MutableShortFloatMap

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

Specified by:

getAndPut in interface MutableShortFloatMap

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(short key,
 FloatFunction0 function)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

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(short key,
 FloatFunction<? super P> function,
 P parameter)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

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(short key,
 ShortToFloatFunction function)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

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(short key,
 float toBeAdded)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

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(short key,
 float initialValueIfAbsent,
 FloatToFloatFunction function)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

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 ShortFloatHashMap withKeyValue(short key1,
 float value1)

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableShortFloatMap.put(short, float)

withKeysValues

public ShortFloatHashMap withKeysValues(short key1,
 float value1,
 short key2,
 float value2)

withKeysValues

public ShortFloatHashMap withKeysValues(short key1,
 float value1,
 short key2,
 float value2,
 short key3,
 float value3)

withKeysValues

public ShortFloatHashMap withKeysValues(short key1,
 float value1,
 short key2,
 float value2,
 short key3,
 float value3,
 short key4,
 float value4)

withoutKey

public ShortFloatHashMap withoutKey(short key)

Description copied from interface: MutableShortFloatMap

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

Specified by:

withoutKey in interface MutableShortFloatMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableShortFloatMap.remove(short)

withoutAllKeys

public ShortFloatHashMap withoutAllKeys(ShortIterable keys)

Description copied from interface: MutableShortFloatMap

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

Specified by:

withoutAllKeys in interface MutableShortFloatMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableShortFloatMap.remove(short)

asUnmodifiable

public MutableShortFloatMap asUnmodifiable()

Description copied from interface: MutableShortFloatMap

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 ShortFloatMap.toImmutable() while still providing immutability.

Specified by:

asUnmodifiable in interface MutableShortFloatMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableShortFloatMap asSynchronized()

Description copied from interface: MutableShortFloatMap

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 MutableShortFloatMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableShortFloatMap toImmutable()

Description copied from interface: ShortFloatMap

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 ShortFloatMap

Returns:

an immutable map that is equivalent to this one

get

public float get(short key)

Description copied from interface: ShortFloatMap

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 ShortFloatMap

Parameters:

key - the key

Returns:

the value associated with the key, or the default value if no such mapping exists

getIfAbsent

public float getIfAbsent(short key,
 float ifAbsent)

Description copied from interface: ShortFloatMap

Retrieves the value associated with the key, returning the specified default value if no such mapping exists.

Specified by:

getIfAbsent in interface ShortFloatMap

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(short key)

Description copied from interface: ShortFloatMap

Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.

Specified by:

getOrThrow in interface ShortFloatMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(short key)

Description copied from interface: ShortFloatMap

Returns whether or not the key is present in the map.

Specified by:

containsKey in interface ShortFloatMap

Specified by:

containsKey in interface ShortKeysMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

forEachKey

public void forEachKey(ShortProcedure procedure)

Description copied from interface: ShortFloatMap

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

Specified by:

forEachKey in interface ShortFloatMap

Specified by:

forEachKey in interface ShortKeysMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(ShortFloatProcedure procedure)

Description copied from interface: ShortFloatMap

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

Specified by:

forEachKeyValue in interface ShortFloatMap

Parameters:

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

keysView

public LazyShortIterable keysView()

Description copied from interface: ShortFloatMap

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 ShortFloatMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<ShortFloatPair> keyValuesView()

Description copied from interface: ShortFloatMap

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 ShortFloatMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableFloatShortMap flipUniqueValues()

Description copied from interface: ShortFloatMap

Return the FloatShortMap that is obtained by flipping the direction of this map and making the associations from value to key.

Specified by:

flipUniqueValues in interface MutableShortFloatMap

Specified by:

flipUniqueValues in interface ShortFloatMap

select

public ShortFloatHashMap select(ShortFloatPredicate predicate)

Description copied from interface: ShortFloatMap

Return a copy of this map containing only the key/value pairs that match the predicate.

Specified by:

select in interface MutableShortFloatMap

Specified by:

select in interface ShortFloatMap

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 ShortFloatHashMap reject(ShortFloatPredicate predicate)

Description copied from interface: ShortFloatMap

Return a copy of this map containing only the key/value pairs that do not match the predicate.

Specified by:

reject in interface MutableShortFloatMap

Specified by:

reject in interface ShortFloatMap

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 MutableShortSet keySet()

Description copied from interface: ShortFloatMap

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 ShortFloatMap

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