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

Class ShortDoubleHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractDoubleIterable

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

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

All Implemented Interfaces:

Externalizable, Serializable, DoubleIterable, DoubleValuesMap, MutableDoubleValuesMap, MutableShortDoubleMap, ShortDoubleMap, PrimitiveIterable, MutableShortKeysMap, ShortKeysMap

public class ShortDoubleHashMap
extends AbstractMutableDoubleValuesMap
implements MutableShortDoubleMap, Externalizable, MutableShortKeysMap

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

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ShortDoubleHashMap()
ShortDoubleHashMap(int initialCapacity)
ShortDoubleHashMap(ShortDoubleMap map)

Method Summary

Modifier and Type	Method	Description
double	addToValue(short key, double 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.
MutableShortDoubleMap	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.
MutableShortDoubleMap	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.
MutableDoubleIterator	doubleIterator()	Returns a primitive iterator that can be used to iterate over the DoubleIterable in an imperative style.
boolean	equals(Object obj)	Follows the same general contract as Map.equals(Object).
MutableDoubleShortMap	flipUniqueValues()	Return the DoubleShortMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(ShortProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(ShortDoubleProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
double	get(short key)	Retrieves the value associated with the key.
double	getAndPut(short key, double putValue, double defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
double	getIfAbsent(short key, double ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
double	getIfAbsentPut(short key, double value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
double	getIfAbsentPut(short key, DoubleFunction0 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> double	getIfAbsentPutWith(short key, DoubleFunction<? 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.
double	getIfAbsentPutWithKey(short key, ShortToDoubleFunction 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.
double	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, ObjectDoubleToObjectFunction<? 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<ShortDoublePair>	keyValuesView()	Returns a view of the key/value pairs in this map.
static ShortDoubleHashMap	newWithKeysValues(short key1, double value1)
static ShortDoubleHashMap	newWithKeysValues(short key1, double value1, short key2, double value2)
static ShortDoubleHashMap	newWithKeysValues(short key1, double value1, short key2, double value2, short key3, double value3)
static ShortDoubleHashMap	newWithKeysValues(short key1, double value1, short key2, double value2, short key3, double value3, short key4, double value4)
void	put(short key, double value)	Associates a value with the specified key.
void	putAll(ShortDoubleMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
ShortDoubleHashMap	reject(ShortDoublePredicate 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.
double	removeKeyIfAbsent(short key, double value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
ShortDoubleHashMap	select(ShortDoublePredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableShortDoubleMap	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.
double	updateValue(short key, double initialValueIfAbsent, DoubleToDoubleFunction 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(ShortDoubleToDoubleFunction function)	Updates the values in-place.
MutableDoubleCollection	values()	Returns the values in this map as a separate collection.
ShortDoubleHashMap	withKeysValues(short key1, double value1, short key2, double value2)
ShortDoubleHashMap	withKeysValues(short key1, double value1, short key2, double value2, short key3, double value3)
ShortDoubleHashMap	withKeysValues(short key1, double value1, short key2, double value2, short key3, double value3, short key4, double value4)
ShortDoubleHashMap	withKeyValue(short key1, double value1)	Associates a value with the specified key.
ShortDoubleHashMap	withoutAllKeys(ShortIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
ShortDoubleHashMap	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.AbstractMutableDoubleValuesMap

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.AbstractDoubleIterable

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.DoubleIterable

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.DoubleValuesMap

containsValue, forEachValue, tap

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

collect, reject, select

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

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.ShortDoubleMap

injectIntoKeyValue

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

isEmpty, notEmpty, size

Constructor Details

ShortDoubleHashMap

public ShortDoubleHashMap()

ShortDoubleHashMap

public ShortDoubleHashMap(int initialCapacity)

ShortDoubleHashMap

public ShortDoubleHashMap(ShortDoubleMap map)

Method Details

newWithKeysValues

public static ShortDoubleHashMap newWithKeysValues(short key1,
 double value1)

newWithKeysValues

public static ShortDoubleHashMap newWithKeysValues(short key1,
 double value1,
 short key2,
 double value2)

newWithKeysValues

public static ShortDoubleHashMap newWithKeysValues(short key1,
 double value1,
 short key2,
 double value2,
 short key3,
 double value3)

newWithKeysValues

public static ShortDoubleHashMap newWithKeysValues(short key1,
 double value1,
 short key2,
 double value2,
 short key3,
 double value3,
 short key4,
 double value4)

equals

public boolean equals(Object obj)

Description copied from interface: ShortDoubleMap

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

Specified by:

equals in interface ShortDoubleMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ShortDoubleMap

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

Specified by:

hashCode in interface ShortDoubleMap

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 ShortDoubleMap

Overrides:

toString in class AbstractDoubleIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

doubleIterator

public MutableDoubleIterator doubleIterator()

Description copied from interface: DoubleIterable

Returns a primitive iterator that can be used to iterate over the DoubleIterable in an imperative style.

Specified by:

doubleIterator in interface DoubleIterable

Specified by:

doubleIterator in interface MutableDoubleValuesMap

injectInto

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

Specified by:

injectInto in interface DoubleIterable

clear

public void clear()

Description copied from interface: MutableDoubleValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableDoubleValuesMap

Specified by:

clear in interface MutableShortKeysMap

put

public void put(short key,
 double value)

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(ShortDoubleMap map)

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(ShortDoubleToDoubleFunction function)

Description copied from interface: MutableShortDoubleMap

Updates the values in-place.

Specified by:

updateValues in interface MutableShortDoubleMap

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: MutableShortDoubleMap

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

Specified by:

removeKey in interface MutableShortDoubleMap

Specified by:

removeKey in interface MutableShortKeysMap

Parameters:

key - the key to remove

See Also:

• MutableShortDoubleMap.remove(short)

remove

public void remove(short key)

Description copied from interface: MutableShortDoubleMap

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

Specified by:

remove in interface MutableShortDoubleMap

Parameters:

key - the key to remove

See Also:

• MutableShortDoubleMap.removeKey(short)

removeKeyIfAbsent

public double removeKeyIfAbsent(short key,
 double value)

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

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

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

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

Description copied from interface: MutableShortDoubleMap

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

Specified by:

getAndPut in interface MutableShortDoubleMap

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 double getIfAbsentPut(short key,
 DoubleFunction0 function)

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

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

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

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 double getIfAbsentPutWithKey(short key,
 ShortToDoubleFunction function)

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

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

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

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 double updateValue(short key,
 double initialValueIfAbsent,
 DoubleToDoubleFunction function)

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

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 ShortDoubleHashMap withKeyValue(short key1,
 double value1)

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableShortDoubleMap.put(short, double)

withKeysValues

public ShortDoubleHashMap withKeysValues(short key1,
 double value1,
 short key2,
 double value2)

withKeysValues

public ShortDoubleHashMap withKeysValues(short key1,
 double value1,
 short key2,
 double value2,
 short key3,
 double value3)

withKeysValues

public ShortDoubleHashMap withKeysValues(short key1,
 double value1,
 short key2,
 double value2,
 short key3,
 double value3,
 short key4,
 double value4)

withoutKey

public ShortDoubleHashMap withoutKey(short key)

Description copied from interface: MutableShortDoubleMap

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

Specified by:

withoutKey in interface MutableShortDoubleMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableShortDoubleMap.remove(short)

withoutAllKeys

public ShortDoubleHashMap withoutAllKeys(ShortIterable keys)

Description copied from interface: MutableShortDoubleMap

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

Specified by:

withoutAllKeys in interface MutableShortDoubleMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableShortDoubleMap.remove(short)

asUnmodifiable

public MutableShortDoubleMap asUnmodifiable()

Description copied from interface: MutableShortDoubleMap

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

Specified by:

asUnmodifiable in interface MutableShortDoubleMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableShortDoubleMap asSynchronized()

Description copied from interface: MutableShortDoubleMap

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 MutableShortDoubleMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableShortDoubleMap toImmutable()

Description copied from interface: ShortDoubleMap

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 ShortDoubleMap

Returns:

an immutable map that is equivalent to this one

get

public double get(short key)

Description copied from interface: ShortDoubleMap

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 ShortDoubleMap

Parameters:

key - the key

Returns:

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

getIfAbsent

public double getIfAbsent(short key,
 double ifAbsent)

Description copied from interface: ShortDoubleMap

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

Specified by:

getIfAbsent in interface ShortDoubleMap

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

Description copied from interface: ShortDoubleMap

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

Specified by:

getOrThrow in interface ShortDoubleMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(short key)

Description copied from interface: ShortDoubleMap

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

Specified by:

containsKey in interface ShortDoubleMap

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: ShortDoubleMap

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

Specified by:

forEachKey in interface ShortDoubleMap

Specified by:

forEachKey in interface ShortKeysMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(ShortDoubleProcedure procedure)

Description copied from interface: ShortDoubleMap

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

Specified by:

forEachKeyValue in interface ShortDoubleMap

Parameters:

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

keysView

public LazyShortIterable keysView()

Description copied from interface: ShortDoubleMap

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 ShortDoubleMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<ShortDoublePair> keyValuesView()

Description copied from interface: ShortDoubleMap

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 ShortDoubleMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableDoubleShortMap flipUniqueValues()

Description copied from interface: ShortDoubleMap

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

Specified by:

flipUniqueValues in interface MutableShortDoubleMap

Specified by:

flipUniqueValues in interface ShortDoubleMap

select

public ShortDoubleHashMap select(ShortDoublePredicate predicate)

Description copied from interface: ShortDoubleMap

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

Specified by:

select in interface MutableShortDoubleMap

Specified by:

select in interface ShortDoubleMap

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 ShortDoubleHashMap reject(ShortDoublePredicate predicate)

Description copied from interface: ShortDoubleMap

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

Specified by:

reject in interface MutableShortDoubleMap

Specified by:

reject in interface ShortDoubleMap

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: ShortDoubleMap

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 ShortDoubleMap

Returns:

a mutable set containing the keys in this map

values

public MutableDoubleCollection values()

Description copied from interface: DoubleValuesMap

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 DoubleValuesMap

Returns:

the values as a collection backed by this map