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

Class ObjectDoubleHashMap<K>

java.lang.Object

org.eclipse.collections.impl.map.mutable.primitive.ObjectDoubleHashMap<K>

All Implemented Interfaces:

Externalizable, Serializable, DoubleIterable, MutableObjectDoubleMap<K>, ObjectDoubleMap<K>, PrimitiveIterable

public class ObjectDoubleHashMap<K>
extends Object
implements MutableObjectDoubleMap<K>, Externalizable

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

Since:

3.0.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final double	EMPTY_VALUE

Constructor Summary

Constructors

Constructor	Description
ObjectDoubleHashMap()
ObjectDoubleHashMap(int initialCapacity)
ObjectDoubleHashMap(ObjectDoubleMap<? extends K> map)

Method Summary

Modifier and Type	Method	Description
double	addToValue(K key, double toBeAdded)
boolean	allSatisfy(DoublePredicate predicate)	Returns true if all of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(DoublePredicate predicate)	Returns true if any of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.
void	appendString(Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyDoubleIterable	asLazy()	Returns a LazyDoubleIterable adapter wrapping the source DoubleIterable.
MutableObjectDoubleMap<K>	asSynchronized()
MutableObjectDoubleMap<K>	asUnmodifiable()
double	average()
RichIterable<DoubleIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()	Removes all entries from this map.
<V> MutableCollection<V>	collect(DoubleToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
void	compact()	Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
boolean	contains(double value)	Returns true if the value is contained in the DoubleIterable, and false if it is not.
boolean	containsAll(double... source)	Returns true if all of the values specified in the source array are contained in the DoubleIterable, and false if they are not.
boolean	containsAll(DoubleIterable source)	Returns true if all of the values specified in the source DoubleIterable are contained in the DoubleIterable, and false if they are not.
boolean	containsKey(Object key)	Returns whether or not the key is present in the map.
boolean	containsValue(double value)	Returns whether or not this map contains the value.
int	count(DoublePredicate predicate)	Returns a count of the number of elements in the DoubleIterable that return true for the specified predicate.
double	detectIfNone(DoublePredicate predicate, double ifNone)
MutableDoubleIterator	doubleIterator()	Returns a primitive iterator that can be used to iterate over the DoubleIterable in an imperative style.
void	each(DoubleProcedure procedure)	A synonym for forEach.
boolean	equals(Object obj)
MutableDoubleObjectMap<K>	flipUniqueValues()	Return the DoubleObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEach(DoubleProcedure procedure)	Applies the DoubleProcedure to each element in the DoubleIterable.
void	forEachKey(Procedure<? super K> procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(ObjectDoubleProcedure<? super K> procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
void	forEachValue(DoubleProcedure procedure)	Iterates through each value in this map.
double	get(Object key)	Retrieves the value associated with the key.
double	getIfAbsent(Object key, double ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
double	getIfAbsentPut(K 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(K 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(K 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(K key, DoubleFunction<? super K> 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(Object key)	Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
int	hashCode()
<V> V	injectInto(V injectedValue, ObjectDoubleToObjectFunction<? super V,? extends V> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
Set<K>	keySet()	Returns a set containing all the keys in this map.
LazyIterable<K>	keysView()	Returns a view of the keys in this map.
RichIterable<ObjectDoublePair<K>>	keyValuesView()	Returns a view of the key/value pairs in this map.
String	makeString()	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator)	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
double	max()
double	maxIfEmpty(double defaultValue)
double	median()
double	min()
double	minIfEmpty(double defaultValue)
static <K> ObjectDoubleHashMap<K>	newMap()
static <K> ObjectDoubleHashMap<K>	newWithKeysValues(K key1, double value1)
static <K> ObjectDoubleHashMap<K>	newWithKeysValues(K key1, double value1, K key2, double value2)
static <K> ObjectDoubleHashMap<K>	newWithKeysValues(K key1, double value1, K key2, double value2, K key3, double value3)
static <K> ObjectDoubleHashMap<K>	newWithKeysValues(K key1, double value1, K key2, double value2, K key3, double value3, K key4, double value4)
boolean	noneSatisfy(DoublePredicate predicate)	Returns true if none of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
void	put(K key, double value)	Associates a value with the specified key.
void	putAll(ObjectDoubleMap<? extends K> map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
MutableDoubleCollection	reject(DoublePredicate predicate)	Returns a new DoubleIterable with all of the elements in the DoubleIterable that return false for the specified predicate.
ObjectDoubleHashMap<K>	reject(ObjectDoublePredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
void	remove(Object key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(K key)	Removes the mapping associated with the key, if one exists, from the map.
double	removeKeyIfAbsent(K key, double value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
MutableDoubleCollection	select(DoublePredicate predicate)	Returns a new DoubleIterable with all of the elements in the DoubleIterable that return true for the specified predicate.
ObjectDoubleHashMap<K>	select(ObjectDoublePredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
int	size()	Returns the number of items in this iterable.
double	sum()
double[]	toArray()	Converts the DoubleIterable to a primitive double array.
double[]	toArray(double[] target)	Converts the DoubleIterable to a primitive double array.
MutableDoubleBag	toBag()	Converts the DoubleIterable to a new MutableDoubleBag.
ImmutableObjectDoubleMap<K>	toImmutable()	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
MutableDoubleList	toList()	Converts the DoubleIterable to a new MutableDoubleList.
MutableDoubleSet	toSet()	Converts the DoubleIterable to a new MutableDoubleSet.
double[]	toSortedArray()
MutableDoubleList	toSortedList()
String	toString()	Follows the same general contract as AbstractMap.toString()
double	updateValue(K 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(ObjectDoubleToDoubleFunction<? super K> function)	Updates the values in-place.
MutableDoubleCollection	values()	Returns the values in this map as a separate collection.
ObjectDoubleHashMap<K>	withKeysValues(K key1, double value1, K key2, double value2)
ObjectDoubleHashMap<K>	withKeysValues(K key1, double value1, K key2, double value2, K key3, double value3)
ObjectDoubleHashMap<K>	withKeysValues(K key1, double value1, K key2, double value2, K key3, double value3, K key4, double value4)
ObjectDoubleHashMap<K>	withKeyValue(K key1, double value1)	Associates a value with the specified key.
ObjectDoubleHashMap<K>	withoutAllKeys(Iterable<? extends K> keys)	Removes the mappings associated with all the keys, if they exist, from this map.
ObjectDoubleHashMap<K>	withoutKey(K key)	Removes the mapping associated with the key, if one exists, from this map.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, containsNone, flatCollect, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

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

putPair, tap, withAllKeyValues

Field Details

EMPTY_VALUE

public static final double EMPTY_VALUE

See Also:

• Constant Field Values

Constructor Details

ObjectDoubleHashMap

public ObjectDoubleHashMap()

ObjectDoubleHashMap

public ObjectDoubleHashMap(int initialCapacity)

ObjectDoubleHashMap

public ObjectDoubleHashMap(ObjectDoubleMap<? extends K> map)

Method Details

newMap

public static <K> ObjectDoubleHashMap<K> newMap()

newWithKeysValues

public static <K> ObjectDoubleHashMap<K> newWithKeysValues(K key1,
 double value1)

newWithKeysValues

public static <K> ObjectDoubleHashMap<K> newWithKeysValues(K key1,
 double value1,
 K key2,
 double value2)

newWithKeysValues

public static <K> ObjectDoubleHashMap<K> newWithKeysValues(K key1,
 double value1,
 K key2,
 double value2,
 K key3,
 double value3)

newWithKeysValues

public static <K> ObjectDoubleHashMap<K> newWithKeysValues(K key1,
 double value1,
 K key2,
 double value2,
 K key3,
 double value3,
 K key4,
 double value4)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: ObjectDoubleMap

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface ObjectDoubleMap<K>

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this ObjectDoubleMap

See Also:

• AbstractCollection.toString()

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

makeString

public String makeString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

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 MutableObjectDoubleMap<K>

toArray

public double[] toArray()

Description copied from interface: DoubleIterable

Converts the DoubleIterable to a primitive double array.

Specified by:

toArray in interface DoubleIterable

toArray

public double[] toArray(double[] target)

Description copied from interface: DoubleIterable

Converts the DoubleIterable to a primitive double array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Specified by:

toArray in interface DoubleIterable

contains

public boolean contains(double value)

Description copied from interface: DoubleIterable

Returns true if the value is contained in the DoubleIterable, and false if it is not.

Specified by:

contains in interface DoubleIterable

containsAll

public boolean containsAll(double... source)

Description copied from interface: DoubleIterable

Returns true if all of the values specified in the source array are contained in the DoubleIterable, and false if they are not.

Specified by:

containsAll in interface DoubleIterable

containsAll

public boolean containsAll(DoubleIterable source)

Description copied from interface: DoubleIterable

Returns true if all of the values specified in the source DoubleIterable are contained in the DoubleIterable, and false if they are not.

Specified by:

containsAll in interface DoubleIterable

clear

public void clear()

Description copied from interface: MutableObjectDoubleMap

Removes all entries from this map.

Specified by:

clear in interface MutableObjectDoubleMap<K>

put

public void put(K key,
 double value)

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(ObjectDoubleMap<? extends K> map)

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(ObjectDoubleToDoubleFunction<? super K> function)

Description copied from interface: MutableObjectDoubleMap

Updates the values in-place.

Specified by:

updateValues in interface MutableObjectDoubleMap<K>

Parameters:

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

removeKey

public void removeKey(K key)

Description copied from interface: MutableObjectDoubleMap

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

Specified by:

removeKey in interface MutableObjectDoubleMap<K>

Parameters:

key - the key to remove

See Also:

• MutableObjectDoubleMap.remove(Object)

remove

public void remove(Object key)

Description copied from interface: MutableObjectDoubleMap

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

Specified by:

remove in interface MutableObjectDoubleMap<K>

Parameters:

key - the key to remove

See Also:

• MutableObjectDoubleMap.removeKey(K)

removeKeyIfAbsent

public double removeKeyIfAbsent(K key,
 double value)

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

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

Description copied from interface: MutableObjectDoubleMap

Retrieves the value associated with the key if one exists; if it does not, associates a value with the key. a new value with they key

Specified by:

getIfAbsentPut in interface MutableObjectDoubleMap<K>

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

getIfAbsentPut

public double getIfAbsentPut(K key,
 DoubleFunction0 function)

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

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

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

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(K key,
 DoubleFunction<? super K> function)

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

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

updateValue

public double updateValue(K key,
 double initialValueIfAbsent,
 DoubleToDoubleFunction function)

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

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

addToValue

public double addToValue(K key,
 double toBeAdded)

Specified by:

addToValue in interface MutableObjectDoubleMap<K>

withKeyValue

public ObjectDoubleHashMap<K> withKeyValue(K key1,
 double value1)

Description copied from interface: MutableObjectDoubleMap

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 MutableObjectDoubleMap<K>

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableObjectDoubleMap.put(K, double)

withKeysValues

public ObjectDoubleHashMap<K> withKeysValues(K key1,
 double value1,
 K key2,
 double value2)

withKeysValues

public ObjectDoubleHashMap<K> withKeysValues(K key1,
 double value1,
 K key2,
 double value2,
 K key3,
 double value3)

withKeysValues

public ObjectDoubleHashMap<K> withKeysValues(K key1,
 double value1,
 K key2,
 double value2,
 K key3,
 double value3,
 K key4,
 double value4)

withoutKey

public ObjectDoubleHashMap<K> withoutKey(K key)

Description copied from interface: MutableObjectDoubleMap

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

Specified by:

withoutKey in interface MutableObjectDoubleMap<K>

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableObjectDoubleMap.remove(Object)

withoutAllKeys

public ObjectDoubleHashMap<K> withoutAllKeys(Iterable<? extends K> keys)

Description copied from interface: MutableObjectDoubleMap

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

Specified by:

withoutAllKeys in interface MutableObjectDoubleMap<K>

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableObjectDoubleMap.remove(Object)

asUnmodifiable

public MutableObjectDoubleMap<K> asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableObjectDoubleMap<K>

asSynchronized

public MutableObjectDoubleMap<K> asSynchronized()

Specified by:

asSynchronized in interface MutableObjectDoubleMap<K>

toImmutable

public ImmutableObjectDoubleMap<K> toImmutable()

Description copied from interface: ObjectDoubleMap

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 ObjectDoubleMap<K>

Returns:

an immutable map that is equivalent to this one

get

public double get(Object key)

Description copied from interface: ObjectDoubleMap

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 ObjectDoubleMap<K>

Parameters:

key - the key

Returns:

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

getOrThrow

public double getOrThrow(Object key)

Description copied from interface: ObjectDoubleMap

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

Specified by:

getOrThrow in interface ObjectDoubleMap<K>

Parameters:

key - the key

Returns:

the value associated with the key

getIfAbsent

public double getIfAbsent(Object key,
 double ifAbsent)

Description copied from interface: ObjectDoubleMap

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

Specified by:

getIfAbsent in interface ObjectDoubleMap<K>

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.

containsKey

public boolean containsKey(Object key)

Description copied from interface: ObjectDoubleMap

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

Specified by:

containsKey in interface ObjectDoubleMap<K>

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

containsValue

public boolean containsValue(double value)

Description copied from interface: ObjectDoubleMap

Returns whether or not this map contains the value.

Specified by:

containsValue in interface ObjectDoubleMap<K>

Parameters:

value - the value to test

Returns:

if this collection contains the value

forEach

public void forEach(DoubleProcedure procedure)

Description copied from interface: DoubleIterable

Applies the DoubleProcedure to each element in the DoubleIterable.

Specified by:

forEach in interface DoubleIterable

each

public void each(DoubleProcedure procedure)

Description copied from interface: DoubleIterable

A synonym for forEach.

Specified by:

each in interface DoubleIterable

Since:

7.0.

forEachValue

public void forEachValue(DoubleProcedure procedure)

Description copied from interface: ObjectDoubleMap

Iterates through each value in this map.

Specified by:

forEachValue in interface ObjectDoubleMap<K>

Parameters:

procedure - the procedure to invoke for each value in this map.

forEachKey

public void forEachKey(Procedure<? super K> procedure)

Description copied from interface: ObjectDoubleMap

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

Specified by:

forEachKey in interface ObjectDoubleMap<K>

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(ObjectDoubleProcedure<? super K> procedure)

Description copied from interface: ObjectDoubleMap

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

Specified by:

forEachKeyValue in interface ObjectDoubleMap<K>

Parameters:

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

select

public ObjectDoubleHashMap<K> select(ObjectDoublePredicate<? super K> predicate)

Description copied from interface: ObjectDoubleMap

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

Specified by:

select in interface MutableObjectDoubleMap<K>

Specified by:

select in interface ObjectDoubleMap<K>

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 ObjectDoubleHashMap<K> reject(ObjectDoublePredicate<? super K> predicate)

Description copied from interface: ObjectDoubleMap

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

Specified by:

reject in interface MutableObjectDoubleMap<K>

Specified by:

reject in interface ObjectDoubleMap<K>

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

select

public MutableDoubleCollection select(DoublePredicate predicate)

Description copied from interface: DoubleIterable

Returns a new DoubleIterable with all of the elements in the DoubleIterable that return true for the specified predicate.

Specified by:

select in interface DoubleIterable

Specified by:

select in interface MutableObjectDoubleMap<K>

reject

public MutableDoubleCollection reject(DoublePredicate predicate)

Description copied from interface: DoubleIterable

Returns a new DoubleIterable with all of the elements in the DoubleIterable that return false for the specified predicate.

Specified by:

reject in interface DoubleIterable

Specified by:

reject in interface MutableObjectDoubleMap<K>

detectIfNone

public double detectIfNone(DoublePredicate predicate,
 double ifNone)

Specified by:

detectIfNone in interface DoubleIterable

collect

public <V> MutableCollection<V> collect(DoubleToObjectFunction<? extends V> function)

Description copied from interface: DoubleIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface DoubleIterable

Specified by:

collect in interface MutableObjectDoubleMap<K>

count

public int count(DoublePredicate predicate)

Description copied from interface: DoubleIterable

Returns a count of the number of elements in the DoubleIterable that return true for the specified predicate.

Specified by:

count in interface DoubleIterable

anySatisfy

public boolean anySatisfy(DoublePredicate predicate)

Description copied from interface: DoubleIterable

Returns true if any of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface DoubleIterable

allSatisfy

public boolean allSatisfy(DoublePredicate predicate)

Description copied from interface: DoubleIterable

Returns true if all of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface DoubleIterable

noneSatisfy

public boolean noneSatisfy(DoublePredicate predicate)

Description copied from interface: DoubleIterable

Returns true if none of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.

Specified by:

noneSatisfy in interface DoubleIterable

injectInto

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

Specified by:

injectInto in interface DoubleIterable

chunk

public RichIterable<DoubleIterable> chunk(int size)

Description copied from interface: DoubleIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface DoubleIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing DoubleIterables of size size, except the last will be truncated if the elements don't divide evenly.

sum

public double sum()

Specified by:

sum in interface DoubleIterable

max

public double max()

Specified by:

max in interface DoubleIterable

min

public double min()

Specified by:

min in interface DoubleIterable

maxIfEmpty

public double maxIfEmpty(double defaultValue)

Specified by:

maxIfEmpty in interface DoubleIterable

minIfEmpty

public double minIfEmpty(double defaultValue)

Specified by:

minIfEmpty in interface DoubleIterable

average

public double average()

Specified by:

average in interface DoubleIterable

median

public double median()

Specified by:

median in interface DoubleIterable

toList

public MutableDoubleList toList()

Description copied from interface: DoubleIterable

Converts the DoubleIterable to a new MutableDoubleList.

Specified by:

toList in interface DoubleIterable

toSet

public MutableDoubleSet toSet()

Description copied from interface: DoubleIterable

Converts the DoubleIterable to a new MutableDoubleSet.

Specified by:

toSet in interface DoubleIterable

toBag

public MutableDoubleBag toBag()

Description copied from interface: DoubleIterable

Converts the DoubleIterable to a new MutableDoubleBag.

Specified by:

toBag in interface DoubleIterable

asLazy

public LazyDoubleIterable asLazy()

Description copied from interface: DoubleIterable

Returns a LazyDoubleIterable adapter wrapping the source DoubleIterable.

Specified by:

asLazy in interface DoubleIterable

toSortedArray

public double[] toSortedArray()

Specified by:

toSortedArray in interface DoubleIterable

toSortedList

public MutableDoubleList toSortedList()

Specified by:

toSortedList in interface DoubleIterable

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

keysView

public LazyIterable<K> keysView()

Description copied from interface: ObjectDoubleMap

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 ObjectDoubleMap<K>

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<ObjectDoublePair<K>> keyValuesView()

Description copied from interface: ObjectDoubleMap

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 ObjectDoubleMap<K>

Returns:

a view of the keys in this map

flipUniqueValues

public MutableDoubleObjectMap<K> flipUniqueValues()

Description copied from interface: ObjectDoubleMap

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

Specified by:

flipUniqueValues in interface MutableObjectDoubleMap<K>

Specified by:

flipUniqueValues in interface ObjectDoubleMap<K>

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 Set<K> keySet()

Description copied from interface: ObjectDoubleMap

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 ObjectDoubleMap<K>

Returns:

a mutable set containing the keys in this map

values

public MutableDoubleCollection values()

Description copied from interface: ObjectDoubleMap

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 ObjectDoubleMap<K>

Returns:

the values as a collection backed by this map