Package gnu.trove.map
Interface TFloatByteMap
-
- All Known Implementing Classes:
TFloatByteHashMap
public interface TFloatByteMap
Interface for a primitive map of float keys and byte values.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description byte
adjustOrPutValue(float key, byte adjust_amount, byte put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map.boolean
adjustValue(float key, byte amount)
Adjusts the primitive value mapped to key.void
clear()
Empties the map.boolean
containsKey(float key)
Checks for the present of key in the keys of the map.boolean
containsValue(byte val)
Checks for the presence of val in the values of the map.boolean
forEachEntry(TFloatByteProcedure procedure)
Executes procedure for each key/value entry in the map.boolean
forEachKey(TFloatProcedure procedure)
Executes procedure for each key in the map.boolean
forEachValue(TByteProcedure procedure)
Executes procedure for each value in the map.byte
get(float key)
Retrieves the value for keyfloat
getNoEntryKey()
Returns the value that will be returned fromget(float)
orput(float, byte)
if no entry exists for a given key.byte
getNoEntryValue()
Returns the value that will be returned fromget(float)
orput(float, byte)
if no entry exists for a given key.boolean
increment(float key)
Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.TFloatByteIterator
iterator()
float[]
keys()
Returns the keys of the map as an array of float values.float[]
keys(float[] array)
Returns the keys of the map.TFloatSet
keySet()
Returns the keys of the map as a TFloatSetbyte
put(float key, byte value)
Inserts a key/value pair into the map.void
putAll(TFloatByteMap map)
Put all the entries from the given map into this map.void
putAll(java.util.Map<? extends java.lang.Float,? extends java.lang.Byte> map)
Put all the entries from the given Map into this map.byte
putIfAbsent(float key, byte value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.byte
remove(float key)
Deletes a key/value pair from the map.boolean
retainEntries(TFloatByteProcedure 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.void
transformValues(TByteFunction function)
Transform the values in this map using function.TByteCollection
valueCollection()
Returns the values of the map as a TByteCollectionbyte[]
values()
Returns the values of the map as an array of #e# values.byte[]
values(byte[] array)
Returns the values of the map using an existing array.
-
-
-
Method Detail
-
getNoEntryKey
float getNoEntryKey()
Returns the value that will be returned fromget(float)
orput(float, byte)
if no entry exists for a given key. The default value is generally zero, but can be changed during construction of the collection.- Returns:
- the value that represents a null key in this collection.
-
getNoEntryValue
byte getNoEntryValue()
Returns the value that will be returned fromget(float)
orput(float, byte)
if no entry exists for a given key. The default value is generally zero, but can be changed during construction of the collection.- Returns:
- the value that represents a null value in this collection.
-
put
byte put(float key, byte value)
Inserts a key/value pair into the map.- Parameters:
key
- anfloat
valuevalue
- anbyte
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
putIfAbsent
byte putIfAbsent(float key, byte value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Parameters:
key
- anfloat
valuevalue
- anbyte
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
putAll
void putAll(java.util.Map<? extends java.lang.Float,? extends java.lang.Byte> map)
Put all the entries from the given Map into this map.- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
putAll
void putAll(TFloatByteMap map)
Put all the entries from the given map into this map.- Parameters:
map
- The map from which entries will be obtained to put into this map.
-
get
byte get(float key)
Retrieves the value for key- Parameters:
key
- anfloat
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
clear
void clear()
Empties the map.
-
isEmpty
boolean isEmpty()
Returns true if this map contains no key-value mappings.- Returns:
- true if this map contains no key-value mappings
-
remove
byte remove(float key)
Deletes a key/value pair from the map.- Parameters:
key
- anfloat
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
size
int size()
Returns an int value that is the number of elements in the map.- Returns:
- an int value that is the number of elements in the map.
-
keySet
TFloatSet keySet()
Returns the keys of the map as a TFloatSet- Returns:
- the keys of the map as a TFloatSet
-
keys
float[] keys()
Returns the keys of the map as an array of float values.- Returns:
- the keys of the map as an array of float values.
-
keys
float[] keys(float[] array)
Returns the keys of the map.- 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
TByteCollection valueCollection()
Returns the values of the map as a TByteCollection- Returns:
- the values of the map as a TByteCollection
-
values
byte[] values()
Returns the values of the map as an array of #e# values.- Returns:
- the values of the map as an array of #e# values.
-
values
byte[] values(byte[] array)
Returns the values of the map using an existing array.- 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.
-
containsValue
boolean containsValue(byte val)
Checks for the presence of val in the values of the map.- Parameters:
val
- anbyte
value- Returns:
- a
boolean
value
-
containsKey
boolean containsKey(float key)
Checks for the present of key in the keys of the map.- Parameters:
key
- anfloat
value- Returns:
- a
boolean
value
-
iterator
TFloatByteIterator iterator()
- Returns:
- a TFloatByteIterator with access to this map's keys and values
-
forEachKey
boolean forEachKey(TFloatProcedure procedure)
Executes procedure for each key in the map.- Parameters:
procedure
- aTFloatProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
boolean forEachValue(TByteProcedure procedure)
Executes procedure for each value in the map.- Parameters:
procedure
- aT#F#Procedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
boolean forEachEntry(TFloatByteProcedure procedure)
Executes procedure for each key/value entry in the map.- Parameters:
procedure
- aTOFloatByteProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
transformValues
void transformValues(TByteFunction function)
Transform the values in this map using function.- Parameters:
function
- aTByteFunction
value
-
retainEntries
boolean retainEntries(TFloatByteProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
boolean increment(float key)
Increments the primitive value mapped to key by 1- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
boolean adjustValue(float key, byte amount)
Adjusts the primitive value mapped to key.- 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
byte adjustOrPutValue(float key, byte adjust_amount, byte put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.- 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 initial present- Returns:
- the value present in the map after the adjustment or put operation
-
-