Package gnu.trove.impl.unmodifiable
Class TUnmodifiableDoubleDoubleMap
java.lang.Object
gnu.trove.impl.unmodifiable.TUnmodifiableDoubleDoubleMap
- All Implemented Interfaces:
TDoubleDoubleMap
,Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondouble
adjustOrPutValue
(double key, double adjust_amount, double put_amount) Adjusts the primitive value mapped to the key if the key is present in the map.boolean
adjustValue
(double key, double amount) Adjusts the primitive value mapped to key.void
clear()
Empties the map.boolean
containsKey
(double key) Checks for the present of key in the keys of the map.boolean
containsValue
(double val) Checks for the presence of val in the values of the map.boolean
boolean
forEachEntry
(TDoubleDoubleProcedure procedure) Executes procedure for each key/value entry in the map.boolean
forEachKey
(TDoubleProcedure procedure) Executes procedure for each key in the map.boolean
forEachValue
(TDoubleProcedure procedure) Executes procedure for each value in the map.double
get
(double key) Retrieves the value for key.double
Returns the value that will be returned fromTDoubleDoubleMap.get(double)
orTDoubleDoubleMap.put(double, double)
if no entry exists for a given key.double
Returns the value that will be returned fromTDoubleDoubleMap.get(double)
orTDoubleDoubleMap.put(double, double)
if no entry exists for a given key.int
hashCode()
boolean
increment
(double key) Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.iterator()
double[]
keys()
Returns the keys of the map as an array of double values.double[]
keys
(double[] array) Returns the keys of the map.keySet()
Returns the keys of the map as a TDoubleSetdouble
put
(double key, double value) Inserts a key/value pair into the map.void
Put all the entries from the given map into this map.void
Put all the entries from the given Map into this map.double
putIfAbsent
(double key, double value) Inserts a key/value pair into the map if the specified key is not already associated with a value.double
remove
(double key) Deletes a key/value pair from the map.boolean
retainEntries
(TDoubleDoubleProcedure procedure) Retains only those entries in the map for which the procedure returns a true value.int
size()
Returns an int value that is the number of elements in the map.toString()
void
transformValues
(TDoubleFunction function) Transform the values in this map using function.Returns the values of the map as a TDoubleCollectiondouble[]
values()
Returns the values of the map as an array of #e# values.double[]
values
(double[] array) Returns the values of the map using an existing array.
-
Constructor Details
-
TUnmodifiableDoubleDoubleMap
-
-
Method Details
-
size
public int size()Description copied from interface:TDoubleDoubleMap
Returns an int value that is the number of elements in the map.- Specified by:
size
in interfaceTDoubleDoubleMap
- Returns:
- an int value that is the number of elements in the map.
-
isEmpty
public boolean isEmpty()Description copied from interface:TDoubleDoubleMap
Returns true if this map contains no key-value mappings.- Specified by:
isEmpty
in interfaceTDoubleDoubleMap
- Returns:
- true if this map contains no key-value mappings
-
containsKey
public boolean containsKey(double key) Description copied from interface:TDoubleDoubleMap
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTDoubleDoubleMap
-
containsValue
public boolean containsValue(double val) Description copied from interface:TDoubleDoubleMap
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTDoubleDoubleMap
-
get
public double get(double key) Description copied from interface:TDoubleDoubleMap
Retrieves the value for key.- Specified by:
get
in interfaceTDoubleDoubleMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TDoubleDoubleMap.getNoEntryValue()
).
-
put
public double put(double key, double value) Description copied from interface:TDoubleDoubleMap
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTDoubleDoubleMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TDoubleDoubleMap.getNoEntryValue()
).
-
remove
public double remove(double key) Description copied from interface:TDoubleDoubleMap
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTDoubleDoubleMap
- Parameters:
key
- andouble
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TDoubleDoubleMap.getNoEntryValue()
).
-
putAll
Description copied from interface:TDoubleDoubleMap
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTDoubleDoubleMap
- Parameters:
m
- The map from which entries will be obtained to put into this map.
-
putAll
Description copied from interface:TDoubleDoubleMap
Put all the entries from the given Map into this map.- Specified by:
putAll
in interfaceTDoubleDoubleMap
- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
clear
public void clear()Description copied from interface:TDoubleDoubleMap
Empties the map.- Specified by:
clear
in interfaceTDoubleDoubleMap
-
keySet
Description copied from interface:TDoubleDoubleMap
Returns the keys of the map as a TDoubleSet- Specified by:
keySet
in interfaceTDoubleDoubleMap
- Returns:
- the keys of the map as a TDoubleSet
-
keys
public double[] keys()Description copied from interface:TDoubleDoubleMap
Returns the keys of the map as an array of double values.- Specified by:
keys
in interfaceTDoubleDoubleMap
- Returns:
- the keys of the map as an array of double values.
-
keys
public double[] keys(double[] array) Description copied from interface:TDoubleDoubleMap
Returns the keys of the map.- Specified by:
keys
in interfaceTDoubleDoubleMap
- Parameters:
array
- the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.- Returns:
- the keys of the map as an array.
-
valueCollection
Description copied from interface:TDoubleDoubleMap
Returns the values of the map as a TDoubleCollection- Specified by:
valueCollection
in interfaceTDoubleDoubleMap
- Returns:
- the values of the map as a TDoubleCollection
-
values
public double[] values()Description copied from interface:TDoubleDoubleMap
Returns the values of the map as an array of #e# values.- Specified by:
values
in interfaceTDoubleDoubleMap
- Returns:
- the values of the map as an array of #e# values.
-
values
public double[] values(double[] array) Description copied from interface:TDoubleDoubleMap
Returns the values of the map using an existing array.- Specified by:
values
in interfaceTDoubleDoubleMap
- Parameters:
array
- the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.- Returns:
- the values of the map as an array of #e# values.
-
equals
-
hashCode
public int hashCode() -
toString
-
getNoEntryKey
public double getNoEntryKey()Description copied from interface:TDoubleDoubleMap
Returns the value that will be returned fromTDoubleDoubleMap.get(double)
orTDoubleDoubleMap.put(double, double)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Specified by:
getNoEntryKey
in interfaceTDoubleDoubleMap
- Returns:
- the value that represents a null key in this collection.
-
getNoEntryValue
public double getNoEntryValue()Description copied from interface:TDoubleDoubleMap
Returns the value that will be returned fromTDoubleDoubleMap.get(double)
orTDoubleDoubleMap.put(double, double)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Specified by:
getNoEntryValue
in interfaceTDoubleDoubleMap
- Returns:
- the value that represents a null value in this collection.
-
forEachKey
Description copied from interface:TDoubleDoubleMap
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTDoubleDoubleMap
- Parameters:
procedure
- aTDoubleProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
Description copied from interface:TDoubleDoubleMap
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTDoubleDoubleMap
- Parameters:
procedure
- aT#F#Procedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
Description copied from interface:TDoubleDoubleMap
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTDoubleDoubleMap
- Parameters:
procedure
- aTODoubleDoubleProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
iterator
- Specified by:
iterator
in interfaceTDoubleDoubleMap
- Returns:
- a TDoubleDoubleIterator with access to this map's keys and values
-
putIfAbsent
public double putIfAbsent(double key, double value) Description copied from interface:TDoubleDoubleMap
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTDoubleDoubleMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TDoubleDoubleMap.getNoEntryValue()
).
-
transformValues
Description copied from interface:TDoubleDoubleMap
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTDoubleDoubleMap
- Parameters:
function
- aTDoubleFunction
value
-
retainEntries
Description copied from interface:TDoubleDoubleMap
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTDoubleDoubleMap
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(double key) Description copied from interface:TDoubleDoubleMap
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTDoubleDoubleMap
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(double key, double amount) Description copied from interface:TDoubleDoubleMap
Adjusts the primitive value mapped to key.- Specified by:
adjustValue
in interfaceTDoubleDoubleMap
- Parameters:
key
- the key of the value to incrementamount
- the amount to adjust the value by.- Returns:
- true if a mapping was found and modified.
-
adjustOrPutValue
public double adjustOrPutValue(double key, double adjust_amount, double put_amount) Description copied from interface:TDoubleDoubleMap
Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the put_amount is put in the map.- Specified by:
adjustOrPutValue
in interfaceTDoubleDoubleMap
- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to adjust the value byput_amount
- the value put into the map if the key is not present- Returns:
- the value present in the map after the adjustment or put operation
-