speiger.src.collections.shorts.sets

Class ShortRBTreeSet

java.lang.Object

java.util.AbstractCollection<java.lang.Short>

speiger.src.collections.shorts.collections.AbstractShortCollection

speiger.src.collections.shorts.sets.AbstractShortSet

speiger.src.collections.shorts.sets.ShortRBTreeSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Short>, java.util.Collection<java.lang.Short>, java.util.NavigableSet<java.lang.Short>, java.util.Set<java.lang.Short>, java.util.SortedSet<java.lang.Short>, ShortCollection, ShortIterable, ShortNavigableSet, ShortSet, ShortSortedSet

public class ShortRBTreeSet
extends AbstractShortSet
implements ShortNavigableSet

A Simple Type Specific RB TreeSet implementation that reduces boxing/unboxing. It is using a bit more memory then FastUtil, but it saves a lot of Performance on the Optimized removal and iteration logic. Which makes the implementation actually useable and does not get outperformed by Javas default implementation.

Constructor Summary

Constructors

Constructor and Description
ShortRBTreeSet() Default Constructor
ShortRBTreeSet(java.util.Collection<? extends java.lang.Short> collection) Deprecated.
ShortRBTreeSet(java.util.Collection<? extends java.lang.Short> collection, ShortComparator comp) Deprecated.
ShortRBTreeSet(java.util.Iterator<java.lang.Short> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortRBTreeSet(java.util.Iterator<java.lang.Short> iterator, ShortComparator comp) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortRBTreeSet(short[] array) Helper constructor that allow to create a set from an array
ShortRBTreeSet(short[] array, int offset, int length) Helper constructor that allow to create a set from an array
ShortRBTreeSet(short[] array, int offset, int length, ShortComparator comp) Helper constructor that allow to create a set from an array
ShortRBTreeSet(short[] array, ShortComparator comp) Helper constructor that allow to create a set from an array
ShortRBTreeSet(ShortCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ShortRBTreeSet(ShortCollection collection, ShortComparator comp) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ShortRBTreeSet(ShortComparator comp) Constructor that allows to define the sorter
ShortRBTreeSet(ShortIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortRBTreeSet(ShortIterator iterator, ShortComparator comp) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortRBTreeSet(ShortSortedSet sortedSet) A Helper constructor that allows to create a Set with exactly the same values as the provided SortedSet.

Method Summary

Modifier and Type	Method and Description
boolean	add(short o) A Type-Specific add function to reduce (un)boxing
boolean	addAndMoveToFirst(short o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(short o) A customized add method that allows you to insert into the last index.
short	ceiling(short e) A Type Specific ceiling method to reduce boxing/unboxing.
void	clear()
ShortComparator	comparator() A Type Specific Comparator method
boolean	contains(java.lang.Object e) This default implementation delegates to the corresponding type-specific function.
boolean	contains(short e) A Type-Specific implementation of contains.
ShortBidirectionalIterator	descendingIterator()
ShortNavigableSet	descendingSet()
short	firstShort() A method to get the first element in the set
short	floor(short e) A Type Specific floor method to reduce boxing/unboxing.
short	getDefaultMaxValue() A Helper method to get the max value for SubSets.
short	getDefaultMinValue() A Helper method to get the min value for SubSets.
ShortNavigableSet	headSet(short toElement, boolean inclusive) A Type Specific HeadSet method to reduce boxing/unboxing
short	higher(short e) A Type Specific higher method to reduce boxing/unboxing.
ShortBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ShortBidirectionalIterator	iterator(short fromElement) A type Specific Iterator starting from a given key
short	lastShort() A method to get the last element in the set
short	lower(short e) A Type Specific lower method to reduce boxing/unboxing.
boolean	moveToFirst(short o) A specific move method to move a given key to the first index.
boolean	moveToLast(short o) A specific move method to move a given key to the last index.
short	pollFirstShort() A method to get and remove the first element in the set
short	pollLastShort() A method to get and remove the last element in the set
boolean	remove(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
boolean	remove(short o) A Type Specific remove function to reduce boxing/unboxing
void	setDefaultMaxValue(short value) A Helper method to set the max value for SubSets.
void	setDefaultMinValue(short value) A Helper method to set the min value for SubSets.
int	size()
ShortNavigableSet	subSet(short fromElement, boolean fromInclusive, short toElement, boolean toInclusive) A Type Specific SubSet method to reduce boxing/unboxing
ShortNavigableSet	tailSet(short fromElement, boolean inclusive) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.shorts.sets.AbstractShortSet

equals, hashCode

Methods inherited from class speiger.src.collections.shorts.collections.AbstractShortCollection

add, addAll, addAll, containsAll, containsAny, containsAny, removeAll, remShort, retainAll, toShortArray, toShortArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.sets.ShortNavigableSet

ceiling, first, floor, headSet, headSet, headSet, higher, last, lower, pollFirst, pollLast, spliterator, subSet, subSet, subSet, tailSet, tailSet, tailSet

Methods inherited from interface speiger.src.collections.shorts.sets.ShortSet

add, remShort

Methods inherited from interface speiger.src.collections.shorts.collections.ShortCollection

addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toShortArray, toShortArray

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

forEach, forEach

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ShortRBTreeSet

public ShortRBTreeSet()

Default Constructor

ShortRBTreeSet

public ShortRBTreeSet(ShortComparator comp)

Constructor that allows to define the sorter

Parameters:

comp - the function that decides how the tree is sorted, can be null

ShortRBTreeSet

public ShortRBTreeSet(short[] array)

Helper constructor that allow to create a set from an array

Parameters:

array - the elements that should be used

ShortRBTreeSet

public ShortRBTreeSet(short[] array,
                      int offset,
                      int length)

Helper constructor that allow to create a set from an array

Parameters:

array - the elements that should be used

offset - the starting index within the array

length - the amount of elements that are within the array

Throws:

java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range

ShortRBTreeSet

public ShortRBTreeSet(short[] array,
                      ShortComparator comp)

Helper constructor that allow to create a set from an array

Parameters:

array - the elements that should be used

comp - the sorter of the tree, can be null

ShortRBTreeSet

public ShortRBTreeSet(short[] array,
                      int offset,
                      int length,
                      ShortComparator comp)

Helper constructor that allow to create a set from an array

Parameters:

array - the elements that should be used

offset - the starting index within the array

length - the amount of elements that are within the array

comp - the sorter of the tree, can be null

Throws:

java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range

ShortRBTreeSet

public ShortRBTreeSet(ShortSortedSet sortedSet)

A Helper constructor that allows to create a Set with exactly the same values as the provided SortedSet.

Parameters:

sortedSet - the set the elements should be added to the TreeSet

Note:

this also includes the Comparator if present

ShortRBTreeSet

@Deprecated
public ShortRBTreeSet(java.util.Collection<? extends java.lang.Short> collection)

Deprecated.

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the TreeSet

ShortRBTreeSet

@Deprecated
public ShortRBTreeSet(java.util.Collection<? extends java.lang.Short> collection,
                                   ShortComparator comp)

Deprecated.

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the TreeSet

comp - the sorter of the tree, can be null

ShortRBTreeSet

public ShortRBTreeSet(ShortCollection collection)

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the TreeSet

ShortRBTreeSet

public ShortRBTreeSet(ShortCollection collection,
                      ShortComparator comp)

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the TreeSet

comp - the sorter of the tree, can be null

ShortRBTreeSet

public ShortRBTreeSet(java.util.Iterator<java.lang.Short> iterator)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

ShortRBTreeSet

public ShortRBTreeSet(java.util.Iterator<java.lang.Short> iterator,
                      ShortComparator comp)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

comp - the sorter of the tree, can be null

ShortRBTreeSet

public ShortRBTreeSet(ShortIterator iterator)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

ShortRBTreeSet

public ShortRBTreeSet(ShortIterator iterator,
                      ShortComparator comp)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

comp - the sorter of the tree, can be null

Method Detail

setDefaultMaxValue

public void setDefaultMaxValue(short value)

Description copied from interface: ShortNavigableSet

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

Specified by:

setDefaultMaxValue in interface ShortNavigableSet

Parameters:

value - the new max value

getDefaultMaxValue

public short getDefaultMaxValue()

Description copied from interface: ShortNavigableSet

A Helper method to get the max value for SubSets.

Specified by:

getDefaultMaxValue in interface ShortNavigableSet

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(short value)

Description copied from interface: ShortNavigableSet

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

Specified by:

setDefaultMinValue in interface ShortNavigableSet

Parameters:

value - the new min value

getDefaultMinValue

public short getDefaultMinValue()

Description copied from interface: ShortNavigableSet

A Helper method to get the min value for SubSets.

Specified by:

getDefaultMinValue in interface ShortNavigableSet

Returns:

the default min value.

add

public boolean add(short o)

Description copied from interface: ShortCollection

A Type-Specific add function to reduce (un)boxing

Specified by:

add in interface ShortCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

addAndMoveToFirst

public boolean addAndMoveToFirst(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

addAndMoveToFirst in interface ShortSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

addAndMoveToLast in interface ShortSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

moveToFirst in interface ShortSortedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

moveToLast in interface ShortSortedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

lower

public short lower(short e)

Description copied from interface: ShortNavigableSet

A Type Specific lower method to reduce boxing/unboxing.

Specified by:

lower in interface ShortNavigableSet

Parameters:

e - that should be compared with.

Returns:

the greatest lower key that can be found

floor

public short floor(short e)

Description copied from interface: ShortNavigableSet

A Type Specific floor method to reduce boxing/unboxing.

Specified by:

floor in interface ShortNavigableSet

Parameters:

e - that should be compared with.

Returns:

the greatest lower or equal key that can be found

higher

public short higher(short e)

Description copied from interface: ShortNavigableSet

A Type Specific higher method to reduce boxing/unboxing.

Specified by:

higher in interface ShortNavigableSet

Parameters:

e - that should be compared with.

Returns:

the lowest higher key that can be found

ceiling

public short ceiling(short e)

Description copied from interface: ShortNavigableSet

A Type Specific ceiling method to reduce boxing/unboxing.

Specified by:

ceiling in interface ShortNavigableSet

Parameters:

e - that should be compared with.

Returns:

the lowest higher or equal key that can be found

contains

public boolean contains(short e)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.

Specified by:

contains in interface ShortCollection

Overrides:

contains in class AbstractShortCollection

Parameters:

e - the element that should be searched for.

Returns:

true if the value was found.

contains

public boolean contains(java.lang.Object e)

Description copied from class: AbstractShortCollection

This default implementation delegates to the corresponding type-specific function.

This default implementation delegates to the corresponding type-specific function.

Specified by:

contains in interface java.util.Collection<java.lang.Short>

Specified by:

contains in interface java.util.Set<java.lang.Short>

Specified by:

contains in interface ShortCollection

Specified by:

contains in interface ShortSet

Overrides:

contains in class AbstractShortCollection

firstShort

public short firstShort()

Description copied from interface: ShortSortedSet

A method to get the first element in the set

Specified by:

firstShort in interface ShortSortedSet

Returns:

first element in the set

lastShort

public short lastShort()

Description copied from interface: ShortSortedSet

A method to get the last element in the set

Specified by:

lastShort in interface ShortSortedSet

Returns:

last element in the set

remove

public boolean remove(short o)

Description copied from interface: ShortSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface ShortSet

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

remove

public boolean remove(java.lang.Object o)

Description copied from class: AbstractShortCollection

This default implementation delegates to the corresponding type-specific function.

This default implementation delegates to the corresponding type-specific function.

Specified by:

remove in interface java.util.Collection<java.lang.Short>

Specified by:

remove in interface java.util.Set<java.lang.Short>

Specified by:

remove in interface ShortCollection

Specified by:

remove in interface ShortSet

Overrides:

remove in class AbstractShortCollection

pollFirstShort

public short pollFirstShort()

Description copied from interface: ShortSortedSet

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

Specified by:

pollFirstShort in interface ShortSortedSet

Returns:

first element in the set

pollLastShort

public short pollLastShort()

Description copied from interface: ShortSortedSet

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

Specified by:

pollLastShort in interface ShortSortedSet

Returns:

last element in the set

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.Short>

Specified by:

size in interface java.util.Set<java.lang.Short>

Specified by:

size in class java.util.AbstractCollection<java.lang.Short>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<java.lang.Short>

Specified by:

clear in interface java.util.Set<java.lang.Short>

Overrides:

clear in class java.util.AbstractCollection<java.lang.Short>

comparator

public ShortComparator comparator()

Description copied from interface: ShortSortedSet

A Type Specific Comparator method

Specified by:

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

Specified by:

comparator in interface ShortSortedSet

Returns:

the type specific comparator

iterator

public ShortBidirectionalIterator iterator()

Description copied from interface: ShortCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface ShortCollection

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in interface ShortNavigableSet

Specified by:

iterator in interface ShortSet

Specified by:

iterator in interface ShortSortedSet

Specified by:

iterator in class AbstractShortSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ShortBidirectionalIterator iterator(short fromElement)

Description copied from interface: ShortSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ShortSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

descendingIterator

public ShortBidirectionalIterator descendingIterator()

Specified by:

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

Specified by:

descendingIterator in interface ShortNavigableSet

Returns:

a Type Specific desendingIterator

subSet

public ShortNavigableSet subSet(short fromElement,
                                boolean fromInclusive,
                                short toElement,
                                boolean toInclusive)

Description copied from interface: ShortNavigableSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface ShortNavigableSet

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

public ShortNavigableSet headSet(short toElement,
                                 boolean inclusive)

Description copied from interface: ShortNavigableSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface ShortNavigableSet

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

public ShortNavigableSet tailSet(short fromElement,
                                 boolean inclusive)

Description copied from interface: ShortNavigableSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface ShortNavigableSet

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

descendingSet

public ShortNavigableSet descendingSet()

Specified by:

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

Specified by:

descendingSet in interface ShortNavigableSet

Returns:

a Type Specific desendingSet