Long2DoubleMaps.EmptyMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Long,java.lang.Double>
- - speiger.src.collections.longs.maps.abstracts.AbstractLong2DoubleMap
  - - speiger.src.collections.longs.utils.maps.Long2DoubleMaps.EmptyMap

All Implemented Interfaces:

java.util.function.LongToDoubleFunction, java.util.Map<java.lang.Long,java.lang.Double>, Long2DoubleFunction, Long2DoubleMap

Enclosing class:

Long2DoubleMaps
```
public static class Long2DoubleMaps.EmptyMap
extends AbstractLong2DoubleMap
```
Empty Map impementation that is used for the emptyMap() function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2DoubleMap
  AbstractLong2DoubleMap.BasicEntry
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2DoubleMap
  Long2DoubleMap.BuilderCache, Long2DoubleMap.Entry, Long2DoubleMap.FastEntrySet, Long2DoubleMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description

EmptyMap()

Constructors
Constructor and Description
`EmptyMap()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`addTo(long key, double value)` A Helper method to add a primitives together.
`double`	`computeDouble(long key, LongDoubleUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`double`	`computeDoubleIfAbsent(long key, Long2DoubleFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`double`	`computeDoubleIfPresent(long key, LongDoubleUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`Long2DoubleMaps.EmptyMap`	`copy()` A Function that does a shallow clone of the Map itself.
`double`	`get(long key)` A Type Specific get method to reduce boxing/unboxing
`double`	`getOrDefault(long key, double defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`LongSet`	`keySet()`
`ObjectSet<Long2DoubleMap.Entry>`	`long2DoubleEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`mergeAllDouble(Long2DoubleMap m, DoubleDoubleUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`double`	`mergeDouble(long key, double value, DoubleDoubleUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`double`	`put(long key, double value)` Type Specific method to reduce boxing/unboxing of values
`double`	`putIfAbsent(long key, double value)` Type Specific method to reduce boxing/unboxing of values
`double`	`remove(long key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(long key, double value)` Type Specific remove function to reduce boxing/unboxing
`double`	`removeOrDefault(long key, double defaultValue)` Type-Specific Remove function with a default return value if wanted.
`double`	`subFrom(long key, double value)` A Helper method to subtract from primitive from each other.
`double`	`supplyDoubleIfAbsent(long key, DoubleSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`DoubleCollection`	`values()`

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2DoubleMap
addToAll, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, replaceDoubles, replaceDoubles, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2DoubleMap
applyAsDouble, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, merge, put, put, putAll, putAll, putIfAbsent, remove, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map
clear, isEmpty, size

- Constructor Detail
  - EmptyMap
```
public EmptyMap()
```
- Method Detail
  - put
```
public double put(long key,
                  double value)
```
    Description copied from interface: Long2DoubleMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.put(Object, Object)
  - putIfAbsent
```
public double putIfAbsent(long key,
                          double value)
```
    Description copied from interface: Long2DoubleMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.putIfAbsent(Object, Object)
  - addTo
```
public double addTo(long key,
                    double value)
```
    Description copied from interface: Long2DoubleMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted / added
    
    Returns:
    
    the last present value or default return value.
  - subFrom
```
public double subFrom(long key,
                      double value)
```
    Description copied from interface: Long2DoubleMap
    
    A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the Long2DoubleMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - remove
```
public double remove(long key)
```
    Description copied from interface: Long2DoubleMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - removeOrDefault
```
public double removeOrDefault(long key,
                              double defaultValue)
```
    Description copied from interface: Long2DoubleMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Parameters:
    
    key - the element that should be removed
    
    defaultValue - the value that should be returned if the entry doesn't exist
    
    Returns:
    
    the value that was removed or default value
    
    See Also:
    
    Map.remove(Object, Object)
  - remove
```
public boolean remove(long key,
                      double value)
```
    Description copied from interface: Long2DoubleMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    value - the expected value that should be found
    
    Returns:
    
    true if the key and value was found and removed
    
    See Also:
    
    Map.remove(Object, Object)
  - get
```
public double get(long key)
```
    Description copied from interface: Long2DoubleMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public double getOrDefault(long key,
                           double defaultValue)
```
    Description copied from interface: Long2DoubleMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Long2DoubleMap
    
    Overrides:
    
    getOrDefault in class AbstractLong2DoubleMap
    
    Parameters:
    
    key - the key that is searched for
    
    defaultValue - the value that should be returned if the key is not present
    
    Returns:
    
    the searched value or defaultValue value
  - computeDouble
```
public double computeDouble(long key,
                            LongDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Long2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDouble in interface Long2DoubleMap
    
    Overrides:
    
    computeDouble in class AbstractLong2DoubleMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeDoubleIfAbsent
```
public double computeDoubleIfAbsent(long key,
                                    Long2DoubleFunction mappingFunction)
```
    Description copied from interface: Long2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDoubleIfAbsent in interface Long2DoubleMap
    
    Overrides:
    
    computeDoubleIfAbsent in class AbstractLong2DoubleMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeDoubleIfPresent
```
public double computeDoubleIfPresent(long key,
                                     LongDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Long2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDoubleIfPresent in interface Long2DoubleMap
    
    Overrides:
    
    computeDoubleIfPresent in class AbstractLong2DoubleMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if present
    
    Returns:
    
    the result of the default return value or present value
  - supplyDoubleIfAbsent
```
public double supplyDoubleIfAbsent(long key,
                                   DoubleSupplier valueProvider)
```
    Description copied from interface: Long2DoubleMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyDoubleIfAbsent in interface Long2DoubleMap
    
    Overrides:
    
    supplyDoubleIfAbsent in class AbstractLong2DoubleMap
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - mergeDouble
```
public double mergeDouble(long key,
                          double value,
                          DoubleDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Long2DoubleMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeDouble in interface Long2DoubleMap
    
    Overrides:
    
    mergeDouble in class AbstractLong2DoubleMap
    
    Parameters:
    
    key - the key that should be be searched for
    
    value - the value that should be merged with
    
    mappingFunction - the operator that should generate the new Value
    
    Returns:
    
    the result of the merge
  - mergeAllDouble
```
public void mergeAllDouble(Long2DoubleMap m,
                           DoubleDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Long2DoubleMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllDouble in interface Long2DoubleMap
    
    Overrides:
    
    mergeAllDouble in class AbstractLong2DoubleMap
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - keySet
```
public LongSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Long,java.lang.Double>
    
    Specified by:
    
    keySet in interface Long2DoubleMap
    
    Overrides:
    
    keySet in class AbstractLong2DoubleMap
  - values
```
public DoubleCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Long,java.lang.Double>
    
    Specified by:
    
    values in interface Long2DoubleMap
    
    Overrides:
    
    values in class AbstractLong2DoubleMap
  - long2DoubleEntrySet
```
public ObjectSet<Long2DoubleMap.Entry> long2DoubleEntrySet()
```
    Description copied from interface: Long2DoubleMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - copy
```
public Long2DoubleMaps.EmptyMap copy()
```
    Description copied from interface: Long2DoubleMap
    
    A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface Long2DoubleMap
    
    Overrides:
    
    copy in class AbstractLong2DoubleMap
    
    Returns:
    
    a Shallow Copy of the Map

Class Long2DoubleMaps.EmptyMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2DoubleMap

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2DoubleMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2DoubleMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2DoubleMap

Methods inherited from interface java.util.Map

Constructor Detail

EmptyMap

Method Detail

put

putIfAbsent

addTo

subFrom

remove

removeOrDefault

remove

get

getOrDefault

computeDouble

computeDoubleIfAbsent

computeDoubleIfPresent

supplyDoubleIfAbsent

mergeDouble

mergeAllDouble

keySet

values

long2DoubleEntrySet

copy