speiger.src.collections.doubles.sets

Interface DoubleSortedSet

All Superinterfaces:

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

All Known Subinterfaces:

DoubleNavigableSet

All Known Implementing Classes:

DoubleAVLTreeSet, DoubleRBTreeSet

public interface DoubleSortedSet
extends DoubleSet, java.util.SortedSet<java.lang.Double>

A Type Specific SortedSet implementation to reduce boxing/unboxing with a couple extra methods that allow greater control over sets.

Note:

DoubleOrderedSet is only extended until 0.6.0 for Compat reasons. The supported classes already implement DoubleOrderedSet directly and will remove DoubleSortedSet implementations in favor of DoubleOrderedSet instead

Method Summary

Modifier and Type	Method and Description
DoubleComparator	comparator() A Type Specific Comparator method
DoubleSortedSet	copy() A Function that does a shallow clone of the Collection itself.
default java.lang.Double	first() Deprecated.
double	firstDouble() A method to get the first element in the set
DoubleSortedSet	headSet(double toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default DoubleSortedSet	headSet(java.lang.Double toElement) Deprecated.
DoubleBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
DoubleBidirectionalIterator	iterator(double fromElement) A type Specific Iterator starting from a given key
default java.lang.Double	last() Deprecated.
double	lastDouble() A method to get the last element in the set
double	pollFirstDouble() A method to get and remove the first element in the set
double	pollLastDouble() A method to get and remove the last element in the set
default DoubleSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
DoubleSortedSet	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 DoubleSortedSet	synchronize() Creates a Wrapped SortedSet that is Synchronized
default DoubleSortedSet	synchronize(java.lang.Object mutex) Creates a Wrapped SortedSet that is Synchronized
DoubleSortedSet	tailSet(double fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default DoubleSortedSet	tailSet(java.lang.Double fromElement) Deprecated.
default DoubleSortedSet	unmodifiable() Creates a Wrapped SortedSet that is unmodifiable

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

comparator

DoubleComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

copy

DoubleSortedSet 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

Returns:

a Shallow Copy of the collection

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 java.lang.Iterable<java.lang.Double>

Specified by:

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

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

DoubleBidirectionalIterator iterator(double fromElement)

A type Specific Iterator starting from a given key

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

Throws:

java.util.NoSuchElementException - if fromElement isn't found

synchronize

default DoubleSortedSet synchronize()

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface DoubleCollection

Specified by:

synchronize in interface DoubleSet

Returns:

a new SortedSet that is synchronized

See Also:

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

synchronize

default DoubleSortedSet synchronize(java.lang.Object mutex)

Creates a Wrapped SortedSet that is Synchronized

Specified by:

synchronize in interface DoubleCollection

Specified by:

synchronize in interface DoubleSet

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedSet Wrapper that is synchronized

See Also:

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

unmodifiable

default DoubleSortedSet unmodifiable()

Creates a Wrapped SortedSet that is unmodifiable

Specified by:

unmodifiable in interface DoubleCollection

Specified by:

unmodifiable in interface DoubleSet

Returns:

a new SortedSet 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 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

subSet

DoubleSortedSet subSet(double fromElement,
                       double toElement)

A Type Specific SubSet method to reduce boxing/unboxing

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

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

headSet

DoubleSortedSet headSet(double toElement)

A Type Specific HeadSet method to reduce boxing/unboxing

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

tailSet

DoubleSortedSet tailSet(double fromElement)

A Type Specific TailSet method to reduce boxing/unboxing

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

firstDouble

double firstDouble()

A method to get the first element in the set

Returns:

first element in the set

pollFirstDouble

double pollFirstDouble()

A method to get and remove the first element in the set

Returns:

first element in the set

lastDouble

double lastDouble()

A method to get the last element in the set

Returns:

last element in the set

pollLastDouble

double pollLastDouble()

A method to get and remove the last element in the set

Returns:

last element in the set

subSet

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

Deprecated.

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 java.util.SortedSet<java.lang.Double>

tailSet

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

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Double first()

Deprecated.

Specified by:

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

last

@Deprecated
default java.lang.Double last()

Deprecated.

Specified by:

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