speiger.src.collections.doubles.maps.interfaces

Interface Double2DoubleNavigableMap

All Superinterfaces:

Double2DoubleMap, Double2DoubleSortedMap, java.util.function.DoubleUnaryOperator, java.util.Map<java.lang.Double,java.lang.Double>, java.util.NavigableMap<java.lang.Double,java.lang.Double>, java.util.SortedMap<java.lang.Double,java.lang.Double>

All Known Implementing Classes:

Double2DoubleAVLTreeMap, Double2DoubleMaps.SynchronizedNavigableMap, Double2DoubleMaps.UnmodifyableNavigableMap, Double2DoubleRBTreeMap

public interface Double2DoubleNavigableMap
extends Double2DoubleSortedMap, java.util.NavigableMap<java.lang.Double,java.lang.Double>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2DoubleSortedMap

Double2DoubleSortedMap.FastSortedSet

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2DoubleMap

Double2DoubleMap.BuilderCache, Double2DoubleMap.Entry, Double2DoubleMap.FastEntrySet, Double2DoubleMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Double2DoubleMap.Entry	ceilingEntry(double key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
default Double2DoubleMap.Entry	ceilingEntry(java.lang.Double key) Deprecated.
double	ceilingKey(double key) A Type Specific ceilingKey method to reduce boxing/unboxing.
default java.lang.Double	ceilingKey(java.lang.Double key) Deprecated.
Double2DoubleNavigableMap	copy() A Function that does a shallow clone of the Map itself.
DoubleNavigableSet	descendingKeySet()
Double2DoubleNavigableMap	descendingMap()
Double2DoubleMap.Entry	firstEntry()
Double2DoubleMap.Entry	floorEntry(double key) A Type Specific floorEntry method to reduce boxing/unboxing.
default Double2DoubleMap.Entry	floorEntry(java.lang.Double key) Deprecated.
double	floorKey(double key) A Type Specific floorKey method to reduce boxing/unboxing.
default java.lang.Double	floorKey(java.lang.Double key) Deprecated.
double	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
double	getDefaultMinValue() A Helper method to get the min value for SubMaps.
default Double2DoubleNavigableMap	headMap(double toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Double2DoubleNavigableMap	headMap(java.lang.Double toKey) Deprecated.
Double2DoubleNavigableMap	headMap(double toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
default Double2DoubleNavigableMap	headMap(java.lang.Double toKey, boolean inclusive) Deprecated.
Double2DoubleMap.Entry	higherEntry(double key) A Type Specific higherEntry method to reduce boxing/unboxing.
default Double2DoubleMap.Entry	higherEntry(java.lang.Double key) Deprecated.
double	higherKey(double key) A Type Specific higherKey method to reduce boxing/unboxing.
default java.lang.Double	higherKey(java.lang.Double key) Deprecated.
DoubleNavigableSet	keySet()
Double2DoubleMap.Entry	lastEntry()
Double2DoubleMap.Entry	lowerEntry(double key) A Type Specific lowerEntry method to reduce boxing/unboxing.
default Double2DoubleMap.Entry	lowerEntry(java.lang.Double key) Deprecated.
double	lowerKey(double key) A Type Specific lowerKey method to reduce boxing/unboxing.
default java.lang.Double	lowerKey(java.lang.Double key) Deprecated.
DoubleNavigableSet	navigableKeySet()
Double2DoubleMap.Entry	pollFirstEntry()
Double2DoubleMap.Entry	pollLastEntry()
void	setDefaultMaxValue(double e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(double e) A Helper method to set the min value for SubMaps.
Double2DoubleNavigableMap	subMap(double fromKey, boolean fromInclusive, double toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
default Double2DoubleNavigableMap	subMap(java.lang.Double fromKey, boolean fromInclusive, java.lang.Double toKey, boolean toInclusive) Deprecated.
default Double2DoubleNavigableMap	subMap(double fromKey, double toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Double2DoubleNavigableMap	subMap(java.lang.Double fromKey, java.lang.Double toKey) Deprecated.
default Double2DoubleNavigableMap	synchronize() Creates a Wrapped NavigableMap that is Synchronized
default Double2DoubleNavigableMap	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableMap that is Synchronized
default Double2DoubleNavigableMap	tailMap(double fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Double2DoubleNavigableMap	tailMap(java.lang.Double fromKey) Deprecated.
Double2DoubleNavigableMap	tailMap(double fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing
default Double2DoubleNavigableMap	tailMap(java.lang.Double fromKey, boolean inclusive) Deprecated.
default Double2DoubleNavigableMap	unmodifiable() Creates a Wrapped NavigableMap that is unmodifiable

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2DoubleSortedMap

comparator, firstDoubleKey, firstDoubleValue, firstKey, lastDoubleKey, lastDoubleValue, lastKey, pollFirstDoubleKey, pollLastDoubleKey, values

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2DoubleMap

addTo, addToAll, applyAsDouble, builder, compute, computeDouble, computeDoubleIfAbsent, computeDoubleIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, double2DoubleEntrySet, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllDouble, mergeDouble, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceDoubles, replaceDoubles, setDefaultReturnValue, subFrom, supplyDoubleIfAbsent

Methods inherited from interface speiger.src.collections.doubles.functions.function.DoubleUnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.function.DoubleUnaryOperator

andThen, compose

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

copy

Double2DoubleNavigableMap copy()

Description copied from interface: Double2DoubleMap

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 Double2DoubleMap

Specified by:

copy in interface Double2DoubleSortedMap

Returns:

a Shallow Copy of the Map

descendingMap

Double2DoubleNavigableMap descendingMap()

Specified by:

descendingMap in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific desendingMap

navigableKeySet

DoubleNavigableSet navigableKeySet()

Specified by:

navigableKeySet in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

DoubleNavigableSet descendingKeySet()

Specified by:

descendingKeySet in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific Desending Key Set

firstEntry

Double2DoubleMap.Entry firstEntry()

Specified by:

firstEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific firstEntry

lastEntry

Double2DoubleMap.Entry lastEntry()

Specified by:

lastEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific lastEntry

pollFirstEntry

Double2DoubleMap.Entry pollFirstEntry()

Specified by:

pollFirstEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Double2DoubleMap.Entry pollLastEntry()

Specified by:

pollLastEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific pollLastEntry

keySet

DoubleNavigableSet keySet()

Specified by:

keySet in interface Double2DoubleMap

Specified by:

keySet in interface Double2DoubleSortedMap

Specified by:

keySet in interface java.util.Map<java.lang.Double,java.lang.Double>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Double,java.lang.Double>

Returns:

a Type Specific Navigable Key Set

synchronize

default Double2DoubleNavigableMap synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Double2DoubleMap

Specified by:

synchronize in interface Double2DoubleSortedMap

Returns:

a new NavigableMap that is synchronized

See Also:

Double2DoubleMaps.synchronize(speiger.src.collections.doubles.maps.interfaces.Double2DoubleMap)

synchronize

default Double2DoubleNavigableMap synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Double2DoubleMap

Specified by:

synchronize in interface Double2DoubleSortedMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Double2DoubleMaps.synchronize(speiger.src.collections.doubles.maps.interfaces.Double2DoubleMap)

unmodifiable

default Double2DoubleNavigableMap unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Double2DoubleMap

Specified by:

unmodifiable in interface Double2DoubleSortedMap

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Double2DoubleMaps.unmodifiable(speiger.src.collections.doubles.maps.interfaces.Double2DoubleMap)

subMap

Double2DoubleNavigableMap subMap(double fromKey,
                                 boolean fromInclusive,
                                 double toKey,
                                 boolean toInclusive)

A Type Specific SubMap method to reduce boxing/unboxing

Parameters:

fromKey - where the submap should start

fromInclusive - if the fromKey is inclusive or not

toKey - where the subMap should end

toInclusive - if the toKey is inclusive or not

Returns:

a SubMap that is within the range of the desired range

headMap

Double2DoubleNavigableMap headMap(double toKey,
                                  boolean inclusive)

A Type Specific HeadMap method to reduce boxing/unboxing

Parameters:

toKey - where the HeadMap should end

inclusive - if the toKey is inclusive or not

Returns:

a HeadMap that is within the range of the desired range

tailMap

Double2DoubleNavigableMap tailMap(double fromKey,
                                  boolean inclusive)

A Type Specific TailMap method to reduce boxing/unboxing

Parameters:

fromKey - where the TailMap should start

inclusive - if the fromKey is inclusive or not

Returns:

a TailMap that is within the range of the desired range

subMap

default Double2DoubleNavigableMap subMap(double fromKey,
                                         double toKey)

Description copied from interface: Double2DoubleSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Double2DoubleSortedMap

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

headMap

default Double2DoubleNavigableMap headMap(double toKey)

Description copied from interface: Double2DoubleSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Double2DoubleSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Double2DoubleNavigableMap tailMap(double fromKey)

Description copied from interface: Double2DoubleSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Double2DoubleSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(double e)

A Helper method to set the max value for SubMaps. (Default: double.MIN_VALUE)

Parameters:

e - the new max value

getDefaultMaxValue

double getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(double e)

A Helper method to set the min value for SubMaps. (Default: double.MAX_VALUE)

Parameters:

e - the new min value

getDefaultMinValue

double getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

double lowerKey(double key)

A Type Specific lowerKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

double higherKey(double key)

A Type Specific higherKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

double floorKey(double key)

A Type Specific floorKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

double ceilingKey(double key)

A Type Specific ceilingKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

Double2DoubleMap.Entry lowerEntry(double key)

A Type Specific lowerEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

Double2DoubleMap.Entry higherEntry(double key)

A Type Specific higherEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

Double2DoubleMap.Entry floorEntry(double key)

A Type Specific floorEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal entry that can be found, or null

ceilingEntry

Double2DoubleMap.Entry ceilingEntry(double key)

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal entry that can be found, or null

lowerKey

@Deprecated
default java.lang.Double lowerKey(java.lang.Double key)

Deprecated.

Specified by:

lowerKey in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

floorKey

@Deprecated
default java.lang.Double floorKey(java.lang.Double key)

Deprecated.

Specified by:

floorKey in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

ceilingKey

@Deprecated
default java.lang.Double ceilingKey(java.lang.Double key)

Deprecated.

Specified by:

ceilingKey in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

higherKey

@Deprecated
default java.lang.Double higherKey(java.lang.Double key)

Deprecated.

Specified by:

higherKey in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

lowerEntry

@Deprecated
default Double2DoubleMap.Entry lowerEntry(java.lang.Double key)

Deprecated.

Specified by:

lowerEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

floorEntry

@Deprecated
default Double2DoubleMap.Entry floorEntry(java.lang.Double key)

Deprecated.

Specified by:

floorEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

ceilingEntry

@Deprecated
default Double2DoubleMap.Entry ceilingEntry(java.lang.Double key)

Deprecated.

Specified by:

ceilingEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

higherEntry

@Deprecated
default Double2DoubleMap.Entry higherEntry(java.lang.Double key)

Deprecated.

Specified by:

higherEntry in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

subMap

@Deprecated
default Double2DoubleNavigableMap subMap(java.lang.Double fromKey,
                                                      boolean fromInclusive,
                                                      java.lang.Double toKey,
                                                      boolean toInclusive)

Deprecated.

Specified by:

subMap in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

headMap

@Deprecated
default Double2DoubleNavigableMap headMap(java.lang.Double toKey,
                                                       boolean inclusive)

Deprecated.

Specified by:

headMap in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

tailMap

@Deprecated
default Double2DoubleNavigableMap tailMap(java.lang.Double fromKey,
                                                       boolean inclusive)

Deprecated.

Specified by:

tailMap in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

subMap

@Deprecated
default Double2DoubleNavigableMap subMap(java.lang.Double fromKey,
                                                      java.lang.Double toKey)

Deprecated.

Specified by:

subMap in interface Double2DoubleSortedMap

Specified by:

subMap in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Specified by:

subMap in interface java.util.SortedMap<java.lang.Double,java.lang.Double>

headMap

@Deprecated
default Double2DoubleNavigableMap headMap(java.lang.Double toKey)

Deprecated.

Specified by:

headMap in interface Double2DoubleSortedMap

Specified by:

headMap in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Specified by:

headMap in interface java.util.SortedMap<java.lang.Double,java.lang.Double>

tailMap

@Deprecated
default Double2DoubleNavigableMap tailMap(java.lang.Double fromKey)

Deprecated.

Specified by:

tailMap in interface Double2DoubleSortedMap

Specified by:

tailMap in interface java.util.NavigableMap<java.lang.Double,java.lang.Double>

Specified by:

tailMap in interface java.util.SortedMap<java.lang.Double,java.lang.Double>