Package gnu.trove.impl.unmodifiable
Class TUnmodifiableCharDoubleMap
java.lang.Object
gnu.trove.impl.unmodifiable.TUnmodifiableCharDoubleMap
- All Implemented Interfaces:
TCharDoubleMap
,Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondouble
adjustOrPutValue
(char 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
(char key, double amount) Adjusts the primitive value mapped to key.void
clear()
Empties the map.boolean
containsKey
(char 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
(TCharDoubleProcedure procedure) Executes procedure for each key/value entry in the map.boolean
forEachKey
(TCharProcedure procedure) Executes procedure for each key in the map.boolean
forEachValue
(TDoubleProcedure procedure) Executes procedure for each value in the map.double
get
(char key) Retrieves the value for key.char
Returns the value that will be returned fromTCharDoubleMap.get(char)
orTCharDoubleMap.put(char, double)
if no entry exists for a given key.double
Returns the value that will be returned fromTCharDoubleMap.get(char)
orTCharDoubleMap.put(char, double)
if no entry exists for a given key.int
hashCode()
boolean
increment
(char key) Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.iterator()
char[]
keys()
Returns the keys of the map as an array of char values.char[]
keys
(char[] array) Returns the keys of the map.keySet()
Returns the keys of the map as a TCharSetdouble
put
(char 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
(char key, double value) Inserts a key/value pair into the map if the specified key is not already associated with a value.double
remove
(char key) Deletes a key/value pair from the map.boolean
retainEntries
(TCharDoubleProcedure 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
-
TUnmodifiableCharDoubleMap
-
-
Method Details
-
size
public int size()Description copied from interface:TCharDoubleMap
Returns an int value that is the number of elements in the map.- Specified by:
size
in interfaceTCharDoubleMap
- Returns:
- an int value that is the number of elements in the map.
-
isEmpty
public boolean isEmpty()Description copied from interface:TCharDoubleMap
Returns true if this map contains no key-value mappings.- Specified by:
isEmpty
in interfaceTCharDoubleMap
- Returns:
- true if this map contains no key-value mappings
-
containsKey
public boolean containsKey(char key) Description copied from interface:TCharDoubleMap
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTCharDoubleMap
-
containsValue
public boolean containsValue(double val) Description copied from interface:TCharDoubleMap
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTCharDoubleMap
-
get
public double get(char key) Description copied from interface:TCharDoubleMap
Retrieves the value for key.- Specified by:
get
in interfaceTCharDoubleMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharDoubleMap.getNoEntryValue()
).
-
put
public double put(char key, double value) Description copied from interface:TCharDoubleMap
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTCharDoubleMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharDoubleMap.getNoEntryValue()
).
-
remove
public double remove(char key) Description copied from interface:TCharDoubleMap
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTCharDoubleMap
- Parameters:
key
- anchar
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharDoubleMap.getNoEntryValue()
).
-
putAll
Description copied from interface:TCharDoubleMap
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTCharDoubleMap
- Parameters:
m
- The map from which entries will be obtained to put into this map.
-
putAll
Description copied from interface:TCharDoubleMap
Put all the entries from the given Map into this map.- Specified by:
putAll
in interfaceTCharDoubleMap
- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
clear
public void clear()Description copied from interface:TCharDoubleMap
Empties the map.- Specified by:
clear
in interfaceTCharDoubleMap
-
keySet
Description copied from interface:TCharDoubleMap
Returns the keys of the map as a TCharSet- Specified by:
keySet
in interfaceTCharDoubleMap
- Returns:
- the keys of the map as a TCharSet
-
keys
public char[] keys()Description copied from interface:TCharDoubleMap
Returns the keys of the map as an array of char values.- Specified by:
keys
in interfaceTCharDoubleMap
- Returns:
- the keys of the map as an array of char values.
-
keys
public char[] keys(char[] array) Description copied from interface:TCharDoubleMap
Returns the keys of the map.- Specified by:
keys
in interfaceTCharDoubleMap
- 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:TCharDoubleMap
Returns the values of the map as a TDoubleCollection- Specified by:
valueCollection
in interfaceTCharDoubleMap
- Returns:
- the values of the map as a TDoubleCollection
-
values
public double[] values()Description copied from interface:TCharDoubleMap
Returns the values of the map as an array of #e# values.- Specified by:
values
in interfaceTCharDoubleMap
- Returns:
- the values of the map as an array of #e# values.
-
values
public double[] values(double[] array) Description copied from interface:TCharDoubleMap
Returns the values of the map using an existing array.- Specified by:
values
in interfaceTCharDoubleMap
- 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 char getNoEntryKey()Description copied from interface:TCharDoubleMap
Returns the value that will be returned fromTCharDoubleMap.get(char)
orTCharDoubleMap.put(char, 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 interfaceTCharDoubleMap
- Returns:
- the value that represents a null key in this collection.
-
getNoEntryValue
public double getNoEntryValue()Description copied from interface:TCharDoubleMap
Returns the value that will be returned fromTCharDoubleMap.get(char)
orTCharDoubleMap.put(char, 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 interfaceTCharDoubleMap
- Returns:
- the value that represents a null value in this collection.
-
forEachKey
Description copied from interface:TCharDoubleMap
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTCharDoubleMap
- Parameters:
procedure
- aTCharProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
Description copied from interface:TCharDoubleMap
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTCharDoubleMap
- 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:TCharDoubleMap
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTCharDoubleMap
- Parameters:
procedure
- aTOCharDoubleProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
iterator
- Specified by:
iterator
in interfaceTCharDoubleMap
- Returns:
- a TCharDoubleIterator with access to this map's keys and values
-
putIfAbsent
public double putIfAbsent(char key, double value) Description copied from interface:TCharDoubleMap
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTCharDoubleMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharDoubleMap.getNoEntryValue()
).
-
transformValues
Description copied from interface:TCharDoubleMap
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTCharDoubleMap
- Parameters:
function
- aTDoubleFunction
value
-
retainEntries
Description copied from interface:TCharDoubleMap
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTCharDoubleMap
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(char key) Description copied from interface:TCharDoubleMap
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTCharDoubleMap
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(char key, double amount) Description copied from interface:TCharDoubleMap
Adjusts the primitive value mapped to key.- Specified by:
adjustValue
in interfaceTCharDoubleMap
- 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(char key, double adjust_amount, double put_amount) Description copied from interface:TCharDoubleMap
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 interfaceTCharDoubleMap
- 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
-