speiger.src.collections.floats.sets

Interface FloatSortedSet

All Superinterfaces:

java.util.Collection<java.lang.Float>, FloatCollection, FloatIterable, FloatSet, java.lang.Iterable<java.lang.Float>, java.util.Set<java.lang.Float>, java.util.SortedSet<java.lang.Float>

All Known Subinterfaces:

FloatNavigableSet

All Known Implementing Classes:

FloatArraySet, FloatAVLTreeSet, FloatLinkedOpenCustomHashSet, FloatLinkedOpenHashSet, FloatRBTreeSet

public interface FloatSortedSet
extends FloatSet, java.util.SortedSet<java.lang.Float>

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

Method Summary

Modifier and Type	Method and Description
boolean	addAndMoveToFirst(float o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(float o) A customized add method that allows you to insert into the last index.
FloatComparator	comparator() A Type Specific Comparator method
default java.lang.Float	first() Deprecated.
float	firstFloat() A method to get the first element in the set
FloatSortedSet	headSet(float toElement) A Type Specific HeadSet method to reduce boxing/unboxing
default FloatSortedSet	headSet(java.lang.Float toElement) Deprecated.
FloatBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
FloatBidirectionalIterator	iterator(float fromElement) A type Specific Iterator starting from a given key
default java.lang.Float	last() Deprecated.
float	lastFloat() A method to get the last element in the set
boolean	moveToFirst(float o) A specific move method to move a given key to the first index.
boolean	moveToLast(float o) A specific move method to move a given key to the last index.
float	pollFirstFloat() A method to get and remove the first element in the set
float	pollLastFloat() A method to get and remove the last element in the set
default FloatSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
FloatSortedSet	subSet(float fromElement, float toElement) A Type Specific SubSet method to reduce boxing/unboxing
default FloatSortedSet	subSet(java.lang.Float fromElement, java.lang.Float toElement) Deprecated.
FloatSortedSet	tailSet(float fromElement) A Type Specific TailSet method to reduce boxing/unboxing
default FloatSortedSet	tailSet(java.lang.Float fromElement) Deprecated.

Methods inherited from interface speiger.src.collections.floats.sets.FloatSet

add, contains, remFloat, remove, remove

Methods inherited from interface speiger.src.collections.floats.collections.FloatCollection

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

Methods inherited from interface speiger.src.collections.floats.collections.FloatIterable

forEach, forEach

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

addAndMoveToFirst

boolean addAndMoveToFirst(float 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)

Note:

some implementations do not support this method

addAndMoveToLast

boolean addAndMoveToLast(float 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)

Note:

some implementations do not support this method

moveToFirst

boolean moveToFirst(float 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, some implementations do not support this method

moveToLast

boolean moveToLast(float 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, some implementations do not support this method

comparator

FloatComparator comparator()

A Type Specific Comparator method

Specified by:

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

Returns:

the type specific comparator

iterator

FloatBidirectionalIterator iterator()

Description copied from interface: FloatCollection

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

Specified by:

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

Specified by:

iterator in interface FloatCollection

Specified by:

iterator in interface FloatIterable

Specified by:

iterator in interface FloatSet

Specified by:

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

Specified by:

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

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

FloatBidirectionalIterator iterator(float 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 FloatSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

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

Specified by:

spliterator in interface FloatCollection

Specified by:

spliterator in interface FloatIterable

Specified by:

spliterator in interface FloatSet

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

type specific splititerator

subSet

FloatSortedSet subSet(float fromElement,
                      float 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

FloatSortedSet headSet(float 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

FloatSortedSet tailSet(float 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.

firstFloat

float firstFloat()

A method to get the first element in the set

Returns:

first element in the set

pollFirstFloat

float pollFirstFloat()

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

Returns:

first element in the set

lastFloat

float lastFloat()

A method to get the last element in the set

Returns:

last element in the set

pollLastFloat

float pollLastFloat()

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

Returns:

last element in the set

subSet

@Deprecated
default FloatSortedSet subSet(java.lang.Float fromElement,
                                           java.lang.Float toElement)

Deprecated.

Specified by:

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

headSet

@Deprecated
default FloatSortedSet headSet(java.lang.Float toElement)

Deprecated.

Specified by:

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

tailSet

@Deprecated
default FloatSortedSet tailSet(java.lang.Float fromElement)

Deprecated.

Specified by:

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

first

@Deprecated
default java.lang.Float first()

Deprecated.

Specified by:

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

last

@Deprecated
default java.lang.Float last()

Deprecated.

Specified by:

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