TDoubleShortMap

All Known Implementing Classes:

TDoubleShortHashMap, TSynchronizedDoubleShortMap, TUnmodifiableDoubleShortMap
```
public interface TDoubleShortMap
```
Interface for a primitive map of double keys and short values.

Method Summary

All Methods

Instance Methods

Abstract Methods
Modifier and Type	Method and Description
`short`	`adjustOrPutValue(double key, short adjust_amount, short put_amount)` Adjusts the primitive value mapped to the key if the key is present in the map.
`boolean`	`adjustValue(double key, short 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(short val)` Checks for the presence of `val` in the values of the map.
`boolean`	`forEachEntry(TDoubleShortProcedure 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(TShortProcedure procedure)` Executes `procedure` for each value in the map.
`short`	`get(double key)` Retrieves the value for `key`
`double`	`getNoEntryKey()` Returns the value that will be returned from `get(double)` or `put(double, short)` if no entry exists for a given key.
`short`	`getNoEntryValue()` Returns the value that will be returned from `get(double)` or `put(double, short)` if no entry exists for a given key.
`boolean`	`increment(double key)` Increments the primitive value mapped to key by 1
`boolean`	`isEmpty()` Returns `true` if this map contains no key-value mappings.
`TDoubleShortIterator`	`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.
`TDoubleSet`	`keySet()` Returns the keys of the map as a `TDoubleSet`
`short`	`put(double key, short value)` Inserts a key/value pair into the map.
`void`	`putAll(Map<? extends Double,? extends Short> map)` Put all the entries from the given Map into this map.
`void`	`putAll(TDoubleShortMap map)` Put all the entries from the given map into this map.
`short`	`putIfAbsent(double key, short value)` Inserts a key/value pair into the map if the specified key is not already associated with a value.
`short`	`remove(double key)` Deletes a key/value pair from the map.
`boolean`	`retainEntries(TDoubleShortProcedure 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(TShortFunction function)` Transform the values in this map using `function`.
`TShortCollection`	`valueCollection()` Returns the values of the map as a `TShortCollection`
`short[]`	`values()` Returns the values of the map as an array of `#e#` values.
`short[]`	`values(short[] array)` Returns the values of the map using an existing array.

- Method Detail
  - getNoEntryKey
```
double getNoEntryKey()
```
    Returns the value that will be returned from get(double) or put(double, short) 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
```
short getNoEntryValue()
```
    Returns the value that will be returned from get(double) or put(double, short) 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
```
short put(double key,
          short value)
```
    Inserts a key/value pair into the map.
    
    Parameters:
    
    key - an double value
    
    value - an short value
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).
  - putIfAbsent
```
short putIfAbsent(double key,
                  short value)
```
    Inserts a key/value pair into the map if the specified key is not already associated with a value.
    
    Parameters:
    
    key - an double value
    
    value - an short value
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).
  - putAll
```
void putAll(Map<? extends Double,? extends Short> 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(TDoubleShortMap 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
```
short get(double key)
```
    Retrieves the value for key
    
    Parameters:
    
    key - an double 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
```
short remove(double key)
```
    Deletes a key/value pair from the map.
    
    Parameters:
    
    key - an double 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
```
TDoubleSet keySet()
```
    Returns the keys of the map as a TDoubleSet
    
    Returns:
    
    the keys of the map as a TDoubleSet
  - keys
```
double[] keys()
```
    Returns the keys of the map as an array of double values.
    
    Returns:
    
    the keys of the map as an array of double values.
  - keys
```
double[] keys(double[] 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
```
TShortCollection valueCollection()
```
    Returns the values of the map as a TShortCollection
    
    Returns:
    
    the values of the map as a TShortCollection
  - values
```
short[] 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
```
short[] values(short[] 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(short val)
```
    Checks for the presence of val in the values of the map.
    
    Parameters:
    
    val - an short value
    
    Returns:
    
    a boolean value
  - containsKey
```
boolean containsKey(double key)
```
    Checks for the present of key in the keys of the map.
    
    Parameters:
    
    key - an double value
    
    Returns:
    
    a boolean value
  - iterator
```
TDoubleShortIterator iterator()
```
    Returns:
    
    a TDoubleShortIterator with access to this map's keys and values
  - forEachKey
```
boolean forEachKey(TDoubleProcedure procedure)
```
    Executes procedure for each key in the map.
    
    Parameters:
    
    procedure - a TDoubleProcedure value
    
    Returns:
    
    false if the loop over the keys terminated because the procedure returned false for some key.
  - forEachValue
```
boolean forEachValue(TShortProcedure procedure)
```
    Executes procedure for each value in the map.
    
    Parameters:
    
    procedure - a T#F#Procedure value
    
    Returns:
    
    false if the loop over the values terminated because the procedure returned false for some value.
  - forEachEntry
```
boolean forEachEntry(TDoubleShortProcedure procedure)
```
    Executes procedure for each key/value entry in the map.
    
    Parameters:
    
    procedure - a TODoubleShortProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - transformValues
```
void transformValues(TShortFunction function)
```
    Transform the values in this map using function.
    
    Parameters:
    
    function - a TShortFunction value
  - retainEntries
```
boolean retainEntries(TDoubleShortProcedure 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(double 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(double key,
                    short amount)
```
    Adjusts the primitive value mapped to key.
    
    Parameters:
    
    key - the key of the value to increment
    
    amount - the amount to adjust the value by.
    
    Returns:
    
    true if a mapping was found and modified.
  - adjustOrPutValue
```
short adjustOrPutValue(double key,
                       short adjust_amount,
                       short 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 increment
    
    adjust_amount - the amount to adjust the value by
    
    put_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

Interface TDoubleShortMap

Method Summary

Method Detail

getNoEntryKey

getNoEntryValue

put

putIfAbsent

putAll

putAll

get

clear

isEmpty

remove

size

keySet

keys

keys

valueCollection

values

values

containsValue

containsKey

iterator

forEachKey

forEachValue

forEachEntry

transformValues

retainEntries

increment

adjustValue

adjustOrPutValue