speiger.src.collections.doubles.sets

Interface DoubleOrderedSet

All Superinterfaces:

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

All Known Implementing Classes:

DoubleArraySet, DoubleLinkedOpenCustomHashSet, DoubleLinkedOpenHashSet, ImmutableDoubleOpenHashSet

public interface DoubleOrderedSet
extends DoubleSet

A Special Set Interface giving Access to some really usefull functions The Idea behind this interface is to allow access to functions that give control to the Order of elements. Since Linked implementations as examples can be reordered outside of the Insertion Order. This interface provides basic access to such functions while also providing some Sorted/NaivgableSet implementations that still fit into here.

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(double o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(double o) A customized add method that allows you to insert into the last index.
DoubleOrderedSet	copy() A Function that does a shallow clone of the Collection itself.
double	firstDouble() A method to get the first element in the set
DoubleBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
DoubleBidirectionalIterator	iterator(double fromElement) A type Specific Iterator starting from a given key
double	lastDouble() A method to get the last element in the set
boolean	moveToFirst(double o) A specific move method to move a given key to the first index.
boolean	moveToLast(double o) A specific move method to move a given key to the last index.
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
default DoubleOrderedSet	synchronize() Creates a Wrapped OrderedSet that is Synchronized
default DoubleOrderedSet	synchronize(java.lang.Object mutex) Creates a Wrapped OrderedSet that is Synchronized
default DoubleOrderedSet	unmodifiable() Creates a Wrapped OrderedSet that is unmodifiable

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

add, contains, remDouble, remove, remove

Methods inherited from interface java.util.Set

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

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 java.util.Collection

parallelStream, stream

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

Method Detail

addAndMoveToFirst

boolean addAndMoveToFirst(double o)

A customized add method that allows you to insert into the first index.

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

boolean addAndMoveToLast(double o)

A customized add method that allows you to insert into the last index.

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

boolean moveToFirst(double o)

A specific move method to move a given key to the first index.

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place

moveToLast

boolean moveToLast(double o)

A specific move method to move a given key to the last index.

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place

copy

DoubleOrderedSet 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

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>

Returns:

type specific splititerator

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

synchronize

default DoubleOrderedSet synchronize()

Creates a Wrapped OrderedSet that is Synchronized

Specified by:

synchronize in interface DoubleCollection

Specified by:

synchronize in interface DoubleSet

Returns:

a new OrderedSet that is synchronized

See Also:

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

synchronize

default DoubleOrderedSet synchronize(java.lang.Object mutex)

Creates a Wrapped OrderedSet 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 OrderedSet Wrapper that is synchronized

See Also:

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

unmodifiable

default DoubleOrderedSet unmodifiable()

Creates a Wrapped OrderedSet that is unmodifiable

Specified by:

unmodifiable in interface DoubleCollection

Specified by:

unmodifiable in interface DoubleSet

Returns:

a new OrderedSet Wrapper that is unmodifiable

See Also:

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