speiger.src.collections.longs.sets

Class LongRBTreeSet

java.lang.Object

java.util.AbstractCollection<java.lang.Long>

speiger.src.collections.longs.collections.AbstractLongCollection

speiger.src.collections.longs.sets.AbstractLongSet

speiger.src.collections.longs.sets.LongRBTreeSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.NavigableSet<java.lang.Long>, java.util.Set<java.lang.Long>, java.util.SortedSet<java.lang.Long>, LongCollection, LongIterable, LongNavigableSet, LongSet, LongSortedSet

public class LongRBTreeSet
extends AbstractLongSet
implements LongNavigableSet

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
LongRBTreeSet() Default Constructor
LongRBTreeSet(java.util.Collection<? extends java.lang.Long> collection) Deprecated.
LongRBTreeSet(java.util.Collection<? extends java.lang.Long> collection, LongComparator comp) Deprecated.
LongRBTreeSet(java.util.Iterator<java.lang.Long> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
LongRBTreeSet(java.util.Iterator<java.lang.Long> iterator, LongComparator comp) A Helper constructor that allows to create a set from a iterator of an unknown size
LongRBTreeSet(long[] array) Helper constructor that allow to create a set from an array
LongRBTreeSet(long[] array, int offset, int length) Helper constructor that allow to create a set from an array
LongRBTreeSet(long[] array, int offset, int length, LongComparator comp) Helper constructor that allow to create a set from an array
LongRBTreeSet(long[] array, LongComparator comp) Helper constructor that allow to create a set from an array
LongRBTreeSet(LongCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongRBTreeSet(LongCollection collection, LongComparator comp) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongRBTreeSet(LongComparator comp) Constructor that allows to define the sorter
LongRBTreeSet(LongIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
LongRBTreeSet(LongIterator iterator, LongComparator comp) A Helper constructor that allows to create a set from a iterator of an unknown size
LongRBTreeSet(LongSortedSet 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(long o) A Type-Specific add function to reduce (un)boxing
long	ceiling(long e) A Type Specific ceiling method to reduce boxing/unboxing.
java.lang.Long	ceiling(java.lang.Long e)
void	clear()
LongComparator	comparator() A Type Specific Comparator method
boolean	contains(long e) A Type-Specific implementation of contains.
boolean	contains(java.lang.Object e) This default implementation delegates to the corresponding type-specific function.
LongRBTreeSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
LongBidirectionalIterator	descendingIterator()
LongNavigableSet	descendingSet()
long	findFirst(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
long	firstLong() A method to get the first element in the set
long	floor(long e) A Type Specific floor method to reduce boxing/unboxing.
java.lang.Long	floor(java.lang.Long e)
<E> void	forEach(E input, ObjectLongConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(LongConsumer action) A Type Specific foreach function that reduces (un)boxing
long	getDefaultMaxValue() A Helper method to get the max value for SubSets.
long	getDefaultMinValue() A Helper method to get the min value for SubSets.
LongNavigableSet	headSet(long toElement, boolean inclusive) A Type Specific HeadSet method to reduce boxing/unboxing
long	higher(long e) A Type Specific higher method to reduce boxing/unboxing.
java.lang.Long	higher(java.lang.Long e)
LongBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
LongBidirectionalIterator	iterator(long fromElement) A type Specific Iterator starting from a given key
long	lastLong() A method to get the last element in the set
long	lower(long e) A Type Specific lower method to reduce boxing/unboxing.
java.lang.Long	lower(java.lang.Long e)
boolean	matchesAll(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
long	pollFirstLong() A method to get and remove the first element in the set
long	pollLastLong() A method to get and remove the last element in the set
long	reduce(long identity, LongLongUnaryOperator operator) Performs a reduction on the elements of this Iterable
long	reduce(LongLongUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remove(long o) A Type Specific remove function to reduce boxing/unboxing
boolean	remove(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
void	setDefaultMaxValue(long value) A Helper method to set the max value for SubSets.
void	setDefaultMinValue(long value) A Helper method to set the min value for SubSets.
int	size()
LongNavigableSet	subSet(long fromElement, boolean fromInclusive, long toElement, boolean toInclusive) A Type Specific SubSet method to reduce boxing/unboxing
LongNavigableSet	tailSet(long fromElement, boolean inclusive) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.longs.sets.AbstractLongSet

equals, hashCode

Methods inherited from class speiger.src.collections.longs.collections.AbstractLongCollection

add, addAll, addAll, containsAll, containsAll, containsAny, containsAny, remLong, removeAll, removeAll, retainAll, retainAll, toLongArray, toLongArray

Methods inherited from class java.util.AbstractCollection

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.longs.sets.LongNavigableSet

first, headSet, headSet, headSet, last, pollFirst, pollLast, spliterator, subSet, subSet, subSet, synchronize, synchronize, tailSet, tailSet, tailSet, unmodifiable

Methods inherited from interface speiger.src.collections.longs.sets.LongSet

add, remLong

Methods inherited from interface speiger.src.collections.longs.collections.LongCollection

addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toLongArray, toLongArray

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pourAsList, pourAsSet, sorted

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

LongRBTreeSet

public LongRBTreeSet()

Default Constructor

LongRBTreeSet

public LongRBTreeSet(LongComparator comp)

Constructor that allows to define the sorter

Parameters:

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

LongRBTreeSet

public LongRBTreeSet(long[] array)

Helper constructor that allow to create a set from an array

Parameters:

array - the elements that should be used

LongRBTreeSet

public LongRBTreeSet(long[] 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

LongRBTreeSet

public LongRBTreeSet(long[] array,
                     LongComparator 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

LongRBTreeSet

public LongRBTreeSet(long[] array,
                     int offset,
                     int length,
                     LongComparator 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

LongRBTreeSet

public LongRBTreeSet(LongSortedSet 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

LongRBTreeSet

@Deprecated
public LongRBTreeSet(java.util.Collection<? extends java.lang.Long> 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

LongRBTreeSet

@Deprecated
public LongRBTreeSet(java.util.Collection<? extends java.lang.Long> collection,
                                  LongComparator 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

LongRBTreeSet

public LongRBTreeSet(LongCollection 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

LongRBTreeSet

public LongRBTreeSet(LongCollection collection,
                     LongComparator 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

LongRBTreeSet

public LongRBTreeSet(java.util.Iterator<java.lang.Long> 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

LongRBTreeSet

public LongRBTreeSet(java.util.Iterator<java.lang.Long> iterator,
                     LongComparator 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

LongRBTreeSet

public LongRBTreeSet(LongIterator 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

LongRBTreeSet

public LongRBTreeSet(LongIterator iterator,
                     LongComparator 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(long value)

Description copied from interface: LongNavigableSet

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

Specified by:

setDefaultMaxValue in interface LongNavigableSet

Parameters:

value - the new max value

getDefaultMaxValue

public long getDefaultMaxValue()

Description copied from interface: LongNavigableSet

A Helper method to get the max value for SubSets.

Specified by:

getDefaultMaxValue in interface LongNavigableSet

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(long value)

Description copied from interface: LongNavigableSet

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

Specified by:

setDefaultMinValue in interface LongNavigableSet

Parameters:

value - the new min value

getDefaultMinValue

public long getDefaultMinValue()

Description copied from interface: LongNavigableSet

A Helper method to get the min value for SubSets.

Specified by:

getDefaultMinValue in interface LongNavigableSet

Returns:

the default min value.

add

public boolean add(long o)

Description copied from interface: LongCollection

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

Specified by:

add in interface LongCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

lower

public long lower(long e)

Description copied from interface: LongNavigableSet

A Type Specific lower method to reduce boxing/unboxing.

Specified by:

lower in interface LongNavigableSet

Parameters:

e - that should be compared with.

Returns:

the greatest lower key that can be found

floor

public long floor(long e)

Description copied from interface: LongNavigableSet

A Type Specific floor method to reduce boxing/unboxing.

Specified by:

floor in interface LongNavigableSet

Parameters:

e - that should be compared with.

Returns:

the greatest lower or equal key that can be found

higher

public long higher(long e)

Description copied from interface: LongNavigableSet

A Type Specific higher method to reduce boxing/unboxing.

Specified by:

higher in interface LongNavigableSet

Parameters:

e - that should be compared with.

Returns:

the lowest higher key that can be found

ceiling

public long ceiling(long e)

Description copied from interface: LongNavigableSet

A Type Specific ceiling method to reduce boxing/unboxing.

Specified by:

ceiling in interface LongNavigableSet

Parameters:

e - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lower

public java.lang.Long lower(java.lang.Long e)

Specified by:

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

Specified by:

lower in interface LongNavigableSet

floor

public java.lang.Long floor(java.lang.Long e)

Specified by:

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

Specified by:

floor in interface LongNavigableSet

higher

public java.lang.Long higher(java.lang.Long e)

Specified by:

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

Specified by:

higher in interface LongNavigableSet

ceiling

public java.lang.Long ceiling(java.lang.Long e)

Specified by:

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

Specified by:

ceiling in interface LongNavigableSet

forEach

public void forEach(LongConsumer action)

Description copied from interface: LongIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface LongIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

public <E> void forEach(E input,
                        ObjectLongConsumer<E> action)

Description copied from interface: LongIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Specified by:

forEach in interface LongIterable

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(Long2BooleanFunction filter)

Description copied from interface: LongIterable

Helper function to reduce stream usage that allows to filter for any matches.

Specified by:

matchesAny in interface LongIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Long2BooleanFunction filter)

Description copied from interface: LongIterable

Helper function to reduce stream usage that allows to filter for no matches.

Specified by:

matchesNone in interface LongIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Long2BooleanFunction filter)

Description copied from interface: LongIterable

Helper function to reduce stream usage that allows to filter for all matches.

Specified by:

matchesAll in interface LongIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

reduce

public long reduce(long identity,
                   LongLongUnaryOperator operator)

Description copied from interface: LongIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface LongIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public long reduce(LongLongUnaryOperator operator)

Description copied from interface: LongIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface LongIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

findFirst

public long findFirst(Long2BooleanFunction filter)

Description copied from interface: LongIterable

Helper function to reduce stream usage that allows to filter for the first match.

Specified by:

findFirst in interface LongIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(Long2BooleanFunction filter)

Description copied from interface: LongIterable

Helper function to reduce stream usage that allows to count the valid elements.

Specified by:

count in interface LongIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

contains

public boolean contains(long e)

Description copied from class: AbstractLongCollection

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

Specified by:

contains in interface LongCollection

Overrides:

contains in class AbstractLongCollection

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: AbstractLongCollection

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.Long>

Specified by:

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

Specified by:

contains in interface LongCollection

Specified by:

contains in interface LongSet

Overrides:

contains in class AbstractLongCollection

firstLong

public long firstLong()

Description copied from interface: LongSortedSet

A method to get the first element in the set

Specified by:

firstLong in interface LongSortedSet

Returns:

first element in the set

lastLong

public long lastLong()

Description copied from interface: LongSortedSet

A method to get the last element in the set

Specified by:

lastLong in interface LongSortedSet

Returns:

last element in the set

remove

public boolean remove(long o)

Description copied from interface: LongSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface LongSet

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: AbstractLongCollection

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.Long>

Specified by:

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

Specified by:

remove in interface LongCollection

Specified by:

remove in interface LongSet

Overrides:

remove in class AbstractLongCollection

pollFirstLong

public long pollFirstLong()

Description copied from interface: LongSortedSet

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

Specified by:

pollFirstLong in interface LongSortedSet

Returns:

first element in the set

pollLastLong

public long pollLastLong()

Description copied from interface: LongSortedSet

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

Specified by:

pollLastLong in interface LongSortedSet

Returns:

last element in the set

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

copy

public LongRBTreeSet copy()

Description copied from interface: LongCollection

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 LongCollection

Specified by:

copy in interface LongNavigableSet

Specified by:

copy in interface LongSet

Specified by:

copy in interface LongSortedSet

Overrides:

copy in class AbstractLongSet

Returns:

a Shallow Copy of the collection

comparator

public LongComparator comparator()

Description copied from interface: LongSortedSet

A Type Specific Comparator method

Specified by:

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

Specified by:

comparator in interface LongSortedSet

Returns:

the type specific comparator

iterator

public LongBidirectionalIterator iterator()

Description copied from interface: LongCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface LongCollection

Specified by:

iterator in interface LongIterable

Specified by:

iterator in interface LongNavigableSet

Specified by:

iterator in interface LongSet

Specified by:

iterator in interface LongSortedSet

Specified by:

iterator in class AbstractLongSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public LongBidirectionalIterator iterator(long fromElement)

Description copied from interface: LongSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface LongSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

descendingIterator

public LongBidirectionalIterator descendingIterator()

Specified by:

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

Specified by:

descendingIterator in interface LongNavigableSet

Returns:

a Type Specific desendingIterator

subSet

public LongNavigableSet subSet(long fromElement,
                               boolean fromInclusive,
                               long toElement,
                               boolean toInclusive)

Description copied from interface: LongNavigableSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface LongNavigableSet

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 LongNavigableSet headSet(long toElement,
                                boolean inclusive)

Description copied from interface: LongNavigableSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface LongNavigableSet

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 LongNavigableSet tailSet(long fromElement,
                                boolean inclusive)

Description copied from interface: LongNavigableSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface LongNavigableSet

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 LongNavigableSet descendingSet()

Specified by:

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

Specified by:

descendingSet in interface LongNavigableSet

Returns:

a Type Specific desendingSet