speiger.src.collections.floats.maps.interfaces

Interface Float2DoubleNavigableMap

All Superinterfaces:

Float2DoubleFunction, Float2DoubleMap, Float2DoubleSortedMap, java.util.Map<java.lang.Float,java.lang.Double>, java.util.NavigableMap<java.lang.Float,java.lang.Double>, java.util.SortedMap<java.lang.Float,java.lang.Double>

All Known Implementing Classes:

Float2DoubleAVLTreeMap, Float2DoubleMaps.SynchronizedNavigableMap, Float2DoubleMaps.UnmodifyableNavigableMap, Float2DoubleRBTreeMap

public interface Float2DoubleNavigableMap
extends Float2DoubleSortedMap, java.util.NavigableMap<java.lang.Float,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.floats.maps.interfaces.Float2DoubleSortedMap

Float2DoubleSortedMap.FastSortedSet

Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2DoubleMap

Float2DoubleMap.BuilderCache, Float2DoubleMap.Entry, Float2DoubleMap.FastEntrySet, Float2DoubleMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2DoubleSortedMap

comparator, firstDoubleValue, firstFloatKey, firstKey, lastDoubleValue, lastFloatKey, lastKey, pollFirstFloatKey, pollLastFloatKey, values

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2DoubleMap

addTo, addToAll, builder, compute, computeDouble, computeDoubleIfAbsent, computeDoubleIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, float2DoubleEntrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllDouble, mergeDouble, 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 java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

copy

Float2DoubleNavigableMap copy()

Description copied from interface: Float2DoubleMap

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 Float2DoubleMap

Specified by:

copy in interface Float2DoubleSortedMap

Returns:

a Shallow Copy of the Map

descendingMap

Float2DoubleNavigableMap descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

FloatNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

FloatNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Float2DoubleMap.Entry firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Float2DoubleMap.Entry lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Float2DoubleMap.Entry pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Float2DoubleMap.Entry pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

FloatNavigableSet keySet()

Specified by:

keySet in interface Float2DoubleMap

Specified by:

keySet in interface Float2DoubleSortedMap

Specified by:

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

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Float2DoubleNavigableMap synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Float2DoubleMap

Specified by:

synchronize in interface Float2DoubleSortedMap

Returns:

a new NavigableMap that is synchronized

See Also:

Float2DoubleMaps.synchronize(speiger.src.collections.floats.maps.interfaces.Float2DoubleMap)

synchronize

default Float2DoubleNavigableMap synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Float2DoubleMap

Specified by:

synchronize in interface Float2DoubleSortedMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Float2DoubleMaps.synchronize(speiger.src.collections.floats.maps.interfaces.Float2DoubleMap)

unmodifiable

default Float2DoubleNavigableMap unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Float2DoubleMap

Specified by:

unmodifiable in interface Float2DoubleSortedMap

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Float2DoubleMaps.unmodifiable(speiger.src.collections.floats.maps.interfaces.Float2DoubleMap)

subMap

Float2DoubleNavigableMap subMap(float fromKey,
                                boolean fromInclusive,
                                float 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

Float2DoubleNavigableMap headMap(float 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

Float2DoubleNavigableMap tailMap(float 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 Float2DoubleNavigableMap subMap(float fromKey,
                                        float toKey)

Description copied from interface: Float2DoubleSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Float2DoubleSortedMap

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 Float2DoubleNavigableMap headMap(float toKey)

Description copied from interface: Float2DoubleSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Float2DoubleSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Float2DoubleNavigableMap tailMap(float fromKey)

Description copied from interface: Float2DoubleSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Float2DoubleSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(float e)

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

Parameters:

e - the new max value

getDefaultMaxValue

float getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(float e)

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

Parameters:

e - the new min value

getDefaultMinValue

float getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

float lowerKey(float 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

float higherKey(float 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

float floorKey(float 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

float ceilingKey(float 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

Float2DoubleMap.Entry lowerEntry(float 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

Float2DoubleMap.Entry higherEntry(float 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

Float2DoubleMap.Entry floorEntry(float 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

Float2DoubleMap.Entry ceilingEntry(float 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.Float lowerKey(java.lang.Float key)

Deprecated.

Specified by:

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

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Float2DoubleMap.Entry lowerEntry(java.lang.Float key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Float2DoubleMap.Entry floorEntry(java.lang.Float key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Float2DoubleMap.Entry ceilingEntry(java.lang.Float key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Float2DoubleMap.Entry higherEntry(java.lang.Float key)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Float2DoubleNavigableMap subMap(java.lang.Float fromKey,
                                                     boolean fromInclusive,
                                                     java.lang.Float toKey,
                                                     boolean toInclusive)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Float2DoubleNavigableMap headMap(java.lang.Float toKey,
                                                      boolean inclusive)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Float2DoubleNavigableMap tailMap(java.lang.Float fromKey,
                                                      boolean inclusive)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Float2DoubleNavigableMap subMap(java.lang.Float fromKey,
                                                     java.lang.Float toKey)

Deprecated.

Specified by:

subMap in interface Float2DoubleSortedMap

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Float2DoubleNavigableMap headMap(java.lang.Float toKey)

Deprecated.

Specified by:

headMap in interface Float2DoubleSortedMap

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Float2DoubleNavigableMap tailMap(java.lang.Float fromKey)

Deprecated.

Specified by:

tailMap in interface Float2DoubleSortedMap

Specified by:

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

Specified by:

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