speiger.src.collections.doubles.sets

Interface DoubleNavigableSet

All Superinterfaces:

java.util.Collection<java.lang.Double>, DoubleCollection, DoubleIterable, DoubleSet, DoubleSortedSet, java.lang.Iterable<java.lang.Double>, java.util.NavigableSet<java.lang.Double>, java.util.Set<java.lang.Double>, java.util.SortedSet<java.lang.Double>

All Known Implementing Classes:

DoubleAVLTreeSet, DoubleRBTreeSet

public interface DoubleNavigableSet
extends java.util.NavigableSet<java.lang.Double>, DoubleSortedSet

A Type Specific Navigable Set interface with a couple helper methods

Method Summary

Modifier and Type	Method and Description
double	ceiling(double key) A Type Specific ceiling method to reduce boxing/unboxing.
default java.lang.Double	ceiling(java.lang.Double e) Deprecated.
DoubleNavigableSet	copy() A Function that does a shallow clone of the Collection itself.
DoubleBidirectionalIterator	descendingIterator()
DoubleNavigableSet	descendingSet()
default java.lang.Double	first() Deprecated.
double	floor(double key) A Type Specific floor method to reduce boxing/unboxing.
default java.lang.Double	floor(java.lang.Double e) Deprecated.
double	getDefaultMaxValue() A Helper method to get the max value for SubSets.
double	getDefaultMinValue() A Helper method to get the min value for SubSets.
default DoubleNavigableSet	headSet(double toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default DoubleSortedSet	headSet(java.lang.Double toElement) Deprecated.
DoubleNavigableSet	headSet(double toElement, boolean inclusive) A Type Specific HeadSet method to reduce boxing/unboxing
default DoubleNavigableSet	headSet(java.lang.Double toElement, boolean inclusive) Deprecated.
double	higher(double key) A Type Specific higher method to reduce boxing/unboxing.
default java.lang.Double	higher(java.lang.Double e) Deprecated.
DoubleBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
default java.lang.Double	last() Deprecated.
double	lower(double key) A Type Specific lower method to reduce boxing/unboxing.
default java.lang.Double	lower(java.lang.Double e) Deprecated.
default java.lang.Double	pollFirst() Deprecated.
default java.lang.Double	pollLast() Deprecated.
void	setDefaultMaxValue(double e) A Helper method to set the max value for SubSets.
void	setDefaultMinValue(double e) A Helper method to set the min value for SubSets.
default DoubleSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
DoubleNavigableSet	subSet(double fromElement, boolean fromInclusive, double toElement, boolean toInclusive) A Type Specific SubSet method to reduce boxing/unboxing
default DoubleNavigableSet	subSet(java.lang.Double fromElement, boolean fromInclusive, java.lang.Double toElement, boolean toInclusive) Deprecated.
default DoubleNavigableSet	subSet(double fromElement, double toElement) A Type Specific SubSet method to reduce boxing/unboxing
default DoubleSortedSet	subSet(java.lang.Double fromElement, java.lang.Double toElement) Deprecated.
default DoubleNavigableSet	synchronize() Creates a Wrapped NavigableSet that is Synchronized
default DoubleNavigableSet	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableSet that is Synchronized
default DoubleNavigableSet	tailSet(double fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default DoubleSortedSet	tailSet(java.lang.Double fromElement) Deprecated.
DoubleNavigableSet	tailSet(double fromElement, boolean inclusive) A Type Specific TailSet method to reduce boxing/unboxing
default DoubleNavigableSet	tailSet(java.lang.Double fromElement, boolean inclusive) Deprecated.
default DoubleNavigableSet	unmodifiable() Creates a Wrapped NavigableSet that is unmodifiable

Methods inherited from interface speiger.src.collections.doubles.sets.DoubleSortedSet

comparator, firstDouble, iterator, lastDouble, pollFirstDouble, pollLastDouble

Methods inherited from interface speiger.src.collections.doubles.sets.DoubleSet

add, contains, remDouble, remove, remove

Methods inherited from interface speiger.src.collections.doubles.collections.DoubleCollection

add, addAll, addAll, addAll, addAll, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toDoubleArray, toDoubleArray

Methods inherited from interface speiger.src.collections.doubles.collections.DoubleIterable

arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Method Detail

lower

double lower(double key)

A Type Specific lower method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higher

double higher(double key)

A Type Specific higher method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floor

double floor(double key)

A Type Specific floor method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceiling

double ceiling(double key)

A Type Specific ceiling method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

setDefaultMaxValue

void setDefaultMaxValue(double e)

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

Parameters:

e - the new max value

getDefaultMaxValue

double getDefaultMaxValue()

A Helper method to get the max value for SubSets.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(double e)

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

Parameters:

e - the new min value

getDefaultMinValue

double getDefaultMinValue()

A Helper method to get the min value for SubSets.

Returns:

the default min value.

subSet

default DoubleNavigableSet subSet(double fromElement,
                                  double toElement)

Description copied from interface: DoubleSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface DoubleSortedSet

Parameters:

fromElement - where the SubSet should start

toElement - where the SubSet should end

Returns:

a SubSet that is within the range of the desired range

headSet

default DoubleNavigableSet headSet(double toElement)

Description copied from interface: DoubleSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface DoubleSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

default DoubleNavigableSet tailSet(double fromElement)

Description copied from interface: DoubleSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface DoubleSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

subSet

DoubleNavigableSet subSet(double fromElement,
                          boolean fromInclusive,
                          double toElement,
                          boolean toInclusive)

A Type Specific SubSet method to reduce boxing/unboxing

Parameters:

fromElement - where the SubSet should start

fromInclusive - if the fromElement is inclusive or not

toElement - where the SubSet should end

toInclusive - if the toElement is inclusive or not

Returns:

a SubSet that is within the range of the desired range

headSet

DoubleNavigableSet headSet(double toElement,
                           boolean inclusive)

A Type Specific HeadSet method to reduce boxing/unboxing

Parameters:

toElement - where the HeadSet should end

inclusive - if the toElement is inclusive or not

Returns:

a HeadSet that is within the range of the desired range

tailSet

DoubleNavigableSet tailSet(double fromElement,
                           boolean inclusive)

A Type Specific TailSet method to reduce boxing/unboxing

Parameters:

fromElement - where the TailSet should start

inclusive - if the fromElement is inclusive or not

Returns:

a TailSet that is within the range of the desired range

iterator

DoubleBidirectionalIterator iterator()

Description copied from interface: DoubleCollection

Returns a Type-Specific Iterator to reduce (un)boxing

Specified by:

iterator in interface java.util.Collection<java.lang.Double>

Specified by:

iterator in interface DoubleCollection

Specified by:

iterator in interface DoubleIterable

Specified by:

iterator in interface DoubleSet

Specified by:

iterator in interface DoubleSortedSet

Specified by:

iterator in interface java.lang.Iterable<java.lang.Double>

Specified by:

iterator in interface java.util.NavigableSet<java.lang.Double>

Specified by:

iterator in interface java.util.Set<java.lang.Double>

Returns:

a Type Specific iterator

See Also:

Collection.iterator()

descendingIterator

DoubleBidirectionalIterator descendingIterator()

Specified by:

descendingIterator in interface java.util.NavigableSet<java.lang.Double>

Returns:

a Type Specific desendingIterator

descendingSet

DoubleNavigableSet descendingSet()

Specified by:

descendingSet in interface java.util.NavigableSet<java.lang.Double>

Returns:

a Type Specific desendingSet

copy

DoubleNavigableSet copy()

Description copied from interface: DoubleCollection

A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface DoubleCollection

Specified by:

copy in interface DoubleSet

Specified by:

copy in interface DoubleSortedSet

Returns:

a Shallow Copy of the collection

synchronize

default DoubleNavigableSet synchronize()

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface DoubleCollection

Specified by:

synchronize in interface DoubleSet

Specified by:

synchronize in interface DoubleSortedSet

Returns:

a new NavigableSet that is synchronized

See Also:

DoubleSets.synchronize(speiger.src.collections.doubles.sets.DoubleSet)

synchronize

default DoubleNavigableSet synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableSet that is Synchronized

Specified by:

synchronize in interface DoubleCollection

Specified by:

synchronize in interface DoubleSet

Specified by:

synchronize in interface DoubleSortedSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableSet Wrapper that is synchronized

See Also:

DoubleSets.synchronize(speiger.src.collections.doubles.sets.DoubleSet)

unmodifiable

default DoubleNavigableSet unmodifiable()

Creates a Wrapped NavigableSet that is unmodifiable

Specified by:

unmodifiable in interface DoubleCollection

Specified by:

unmodifiable in interface DoubleSet

Specified by:

unmodifiable in interface DoubleSortedSet

Returns:

a new NavigableSet Wrapper that is unmodifiable

See Also:

DoubleSets.unmodifiable(speiger.src.collections.doubles.sets.DoubleSet)

spliterator

default DoubleSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface java.util.Collection<java.lang.Double>

Specified by:

spliterator in interface DoubleCollection

Specified by:

spliterator in interface DoubleIterable

Specified by:

spliterator in interface DoubleSet

Specified by:

spliterator in interface DoubleSortedSet

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Double>

Specified by:

spliterator in interface java.util.Set<java.lang.Double>

Specified by:

spliterator in interface java.util.SortedSet<java.lang.Double>

Returns:

type specific splititerator

lower

@Deprecated
default java.lang.Double lower(java.lang.Double e)

Deprecated.

Specified by:

lower in interface java.util.NavigableSet<java.lang.Double>

floor

@Deprecated
default java.lang.Double floor(java.lang.Double e)

Deprecated.

Specified by:

floor in interface java.util.NavigableSet<java.lang.Double>

ceiling

@Deprecated
default java.lang.Double ceiling(java.lang.Double e)

Deprecated.

Specified by:

ceiling in interface java.util.NavigableSet<java.lang.Double>

higher

@Deprecated
default java.lang.Double higher(java.lang.Double e)

Deprecated.

Specified by:

higher in interface java.util.NavigableSet<java.lang.Double>

first

@Deprecated
default java.lang.Double first()

Deprecated.

Specified by:

first in interface DoubleSortedSet

Specified by:

first in interface java.util.SortedSet<java.lang.Double>

last

@Deprecated
default java.lang.Double last()

Deprecated.

Specified by:

last in interface DoubleSortedSet

Specified by:

last in interface java.util.SortedSet<java.lang.Double>

pollFirst

@Deprecated
default java.lang.Double pollFirst()

Deprecated.

Specified by:

pollFirst in interface java.util.NavigableSet<java.lang.Double>

pollLast

@Deprecated
default java.lang.Double pollLast()

Deprecated.

Specified by:

pollLast in interface java.util.NavigableSet<java.lang.Double>

subSet

@Deprecated
default DoubleNavigableSet subSet(java.lang.Double fromElement,
                                               boolean fromInclusive,
                                               java.lang.Double toElement,
                                               boolean toInclusive)

Deprecated.

Specified by:

subSet in interface java.util.NavigableSet<java.lang.Double>

headSet

@Deprecated
default DoubleNavigableSet headSet(java.lang.Double toElement,
                                                boolean inclusive)

Deprecated.

Specified by:

headSet in interface java.util.NavigableSet<java.lang.Double>

tailSet

@Deprecated
default DoubleNavigableSet tailSet(java.lang.Double fromElement,
                                                boolean inclusive)

Deprecated.

Specified by:

tailSet in interface java.util.NavigableSet<java.lang.Double>

subSet

@Deprecated
default DoubleSortedSet subSet(java.lang.Double fromElement,
                                            java.lang.Double toElement)

Deprecated.

Specified by:

subSet in interface DoubleSortedSet

Specified by:

subSet in interface java.util.NavigableSet<java.lang.Double>

Specified by:

subSet in interface java.util.SortedSet<java.lang.Double>

headSet

@Deprecated
default DoubleSortedSet headSet(java.lang.Double toElement)

Deprecated.

Specified by:

headSet in interface DoubleSortedSet

Specified by:

headSet in interface java.util.NavigableSet<java.lang.Double>

Specified by:

headSet in interface java.util.SortedSet<java.lang.Double>

tailSet

@Deprecated
default DoubleSortedSet tailSet(java.lang.Double fromElement)

Deprecated.

Specified by:

tailSet in interface DoubleSortedSet

Specified by:

tailSet in interface java.util.NavigableSet<java.lang.Double>

Specified by:

tailSet in interface java.util.SortedSet<java.lang.Double>