speiger.src.collections.bytes.sets

Class ByteAVLTreeSet

java.lang.Object

java.util.AbstractCollection<java.lang.Byte>

speiger.src.collections.bytes.collections.AbstractByteCollection

speiger.src.collections.bytes.sets.AbstractByteSet

speiger.src.collections.bytes.sets.ByteAVLTreeSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Byte>, java.util.Collection<java.lang.Byte>, java.util.NavigableSet<java.lang.Byte>, java.util.Set<java.lang.Byte>, java.util.SortedSet<java.lang.Byte>, ByteCollection, ByteIterable, ByteNavigableSet, ByteSet, ByteSortedSet

public class ByteAVLTreeSet
extends AbstractByteSet
implements ByteNavigableSet

A Simple Type Specific AVL 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
ByteAVLTreeSet() Default Constructor
ByteAVLTreeSet(byte[] array) Helper constructor that allow to create a set from an array
ByteAVLTreeSet(byte[] array, ByteComparator comp) Helper constructor that allow to create a set from an array
ByteAVLTreeSet(byte[] array, int offset, int length) Helper constructor that allow to create a set from an array
ByteAVLTreeSet(byte[] array, int offset, int length, ByteComparator comp) Helper constructor that allow to create a set from an array
ByteAVLTreeSet(ByteCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ByteAVLTreeSet(ByteCollection collection, ByteComparator comp) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ByteAVLTreeSet(ByteComparator comp) Constructor that allows to define the sorter
ByteAVLTreeSet(ByteIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteAVLTreeSet(ByteIterator iterator, ByteComparator comp) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteAVLTreeSet(ByteSortedSet sortedSet) A Helper constructor that allows to create a Set with exactly the same values as the provided SortedSet.
ByteAVLTreeSet(java.util.Collection<? extends java.lang.Byte> collection) Deprecated.
ByteAVLTreeSet(java.util.Collection<? extends java.lang.Byte> collection, ByteComparator comp) Deprecated.
ByteAVLTreeSet(java.util.Iterator<java.lang.Byte> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ByteAVLTreeSet(java.util.Iterator<java.lang.Byte> iterator, ByteComparator comp) A Helper constructor that allows to create a set from a iterator of an unknown size

Method Summary

Modifier and Type	Method and Description
boolean	add(byte o) A Type-Specific add function to reduce (un)boxing
byte	ceiling(byte e) A Type Specific ceiling method to reduce boxing/unboxing.
java.lang.Byte	ceiling(java.lang.Byte e)
void	clear()
ByteComparator	comparator() A Type Specific Comparator method
boolean	contains(byte e) A Type-Specific implementation of contains.
boolean	contains(java.lang.Object e) This default implementation delegates to the corresponding type-specific function.
ByteAVLTreeSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
ByteBidirectionalIterator	descendingIterator()
ByteNavigableSet	descendingSet()
byte	findFirst(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
byte	firstByte() A method to get the first element in the set
byte	floor(byte e) A Type Specific floor method to reduce boxing/unboxing.
java.lang.Byte	floor(java.lang.Byte e)
void	forEach(ByteConsumer action) A Type Specific foreach function that reduces (un)boxing
<E> void	forEach(E input, ObjectByteConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
byte	getDefaultMaxValue() A Helper method to get the max value for SubSets.
byte	getDefaultMinValue() A Helper method to get the min value for SubSets.
ByteNavigableSet	headSet(byte toElement, boolean inclusive) A Type Specific HeadSet method to reduce boxing/unboxing
byte	higher(byte e) A Type Specific higher method to reduce boxing/unboxing.
java.lang.Byte	higher(java.lang.Byte e)
ByteBidirectionalIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ByteBidirectionalIterator	iterator(byte fromElement) A type Specific Iterator starting from a given key
byte	lastByte() A method to get the last element in the set
byte	lower(byte e) A Type Specific lower method to reduce boxing/unboxing.
java.lang.Byte	lower(java.lang.Byte e)
boolean	matchesAll(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Byte2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
byte	pollFirstByte() A method to get and remove the first element in the set
byte	pollLastByte() A method to get and remove the last element in the set
byte	reduce(byte identity, ByteByteUnaryOperator operator) Performs a reduction on the elements of this Iterable
byte	reduce(ByteByteUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remove(byte 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(byte value) A Helper method to set the max value for SubSets.
void	setDefaultMinValue(byte value) A Helper method to set the min value for SubSets.
int	size()
ByteNavigableSet	subSet(byte fromElement, boolean fromInclusive, byte toElement, boolean toInclusive) A Type Specific SubSet method to reduce boxing/unboxing
ByteNavigableSet	tailSet(byte fromElement, boolean inclusive) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.bytes.sets.AbstractByteSet

equals, hashCode

Methods inherited from class speiger.src.collections.bytes.collections.AbstractByteCollection

add, addAll, addAll, containsAll, containsAll, containsAny, containsAny, remByte, removeAll, removeAll, retainAll, retainAll, toByteArray, toByteArray

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.bytes.sets.ByteNavigableSet

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

Methods inherited from interface speiger.src.collections.bytes.sets.ByteSet

add, remByte

Methods inherited from interface speiger.src.collections.bytes.collections.ByteCollection

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

Methods inherited from interface speiger.src.collections.bytes.collections.ByteIterable

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

ByteAVLTreeSet

public ByteAVLTreeSet()

Default Constructor

ByteAVLTreeSet

public ByteAVLTreeSet(ByteComparator comp)

Constructor that allows to define the sorter

Parameters:

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

ByteAVLTreeSet

public ByteAVLTreeSet(byte[] array)

Helper constructor that allow to create a set from an array

Parameters:

array - the elements that should be used

ByteAVLTreeSet

public ByteAVLTreeSet(byte[] 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

ByteAVLTreeSet

public ByteAVLTreeSet(byte[] array,
                      ByteComparator 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

ByteAVLTreeSet

public ByteAVLTreeSet(byte[] array,
                      int offset,
                      int length,
                      ByteComparator 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

ByteAVLTreeSet

public ByteAVLTreeSet(ByteSortedSet 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

ByteAVLTreeSet

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

ByteAVLTreeSet

@Deprecated
public ByteAVLTreeSet(java.util.Collection<? extends java.lang.Byte> collection,
                                   ByteComparator 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

ByteAVLTreeSet

public ByteAVLTreeSet(ByteCollection 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

ByteAVLTreeSet

public ByteAVLTreeSet(ByteCollection collection,
                      ByteComparator 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

ByteAVLTreeSet

public ByteAVLTreeSet(java.util.Iterator<java.lang.Byte> 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

ByteAVLTreeSet

public ByteAVLTreeSet(java.util.Iterator<java.lang.Byte> iterator,
                      ByteComparator 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

ByteAVLTreeSet

public ByteAVLTreeSet(ByteIterator 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

ByteAVLTreeSet

public ByteAVLTreeSet(ByteIterator iterator,
                      ByteComparator 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(byte value)

Description copied from interface: ByteNavigableSet

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

Specified by:

setDefaultMaxValue in interface ByteNavigableSet

Parameters:

value - the new max value

getDefaultMaxValue

public byte getDefaultMaxValue()

Description copied from interface: ByteNavigableSet

A Helper method to get the max value for SubSets.

Specified by:

getDefaultMaxValue in interface ByteNavigableSet

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(byte value)

Description copied from interface: ByteNavigableSet

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

Specified by:

setDefaultMinValue in interface ByteNavigableSet

Parameters:

value - the new min value

getDefaultMinValue

public byte getDefaultMinValue()

Description copied from interface: ByteNavigableSet

A Helper method to get the min value for SubSets.

Specified by:

getDefaultMinValue in interface ByteNavigableSet

Returns:

the default min value.

add

public boolean add(byte o)

Description copied from interface: ByteCollection

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

Specified by:

add in interface ByteCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

lower

public byte lower(byte e)

Description copied from interface: ByteNavigableSet

A Type Specific lower method to reduce boxing/unboxing.

Specified by:

lower in interface ByteNavigableSet

Parameters:

e - that should be compared with.

Returns:

the greatest lower key that can be found

floor

public byte floor(byte e)

Description copied from interface: ByteNavigableSet

A Type Specific floor method to reduce boxing/unboxing.

Specified by:

floor in interface ByteNavigableSet

Parameters:

e - that should be compared with.

Returns:

the greatest lower or equal key that can be found

higher

public byte higher(byte e)

Description copied from interface: ByteNavigableSet

A Type Specific higher method to reduce boxing/unboxing.

Specified by:

higher in interface ByteNavigableSet

Parameters:

e - that should be compared with.

Returns:

the lowest higher key that can be found

ceiling

public byte ceiling(byte e)

Description copied from interface: ByteNavigableSet

A Type Specific ceiling method to reduce boxing/unboxing.

Specified by:

ceiling in interface ByteNavigableSet

Parameters:

e - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lower

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

Specified by:

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

Specified by:

lower in interface ByteNavigableSet

floor

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

Specified by:

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

Specified by:

floor in interface ByteNavigableSet

higher

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

Specified by:

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

Specified by:

higher in interface ByteNavigableSet

ceiling

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

Specified by:

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

Specified by:

ceiling in interface ByteNavigableSet

forEach

public void forEach(ByteConsumer action)

Description copied from interface: ByteIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface ByteIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

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

Description copied from interface: ByteIterable

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

Specified by:

forEach in interface ByteIterable

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(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

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

Specified by:

matchesAny in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

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

Specified by:

matchesNone in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

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

Specified by:

matchesAll in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public byte findFirst(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

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

Specified by:

findFirst in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

reduce

public byte reduce(byte identity,
                   ByteByteUnaryOperator operator)

Description copied from interface: ByteIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ByteIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public byte reduce(ByteByteUnaryOperator operator)

Description copied from interface: ByteIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ByteIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

count

public int count(Byte2BooleanFunction filter)

Description copied from interface: ByteIterable

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

Specified by:

count in interface ByteIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

contains

public boolean contains(byte e)

Description copied from class: AbstractByteCollection

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

Specified by:

contains in interface ByteCollection

Overrides:

contains in class AbstractByteCollection

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

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

Specified by:

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

Specified by:

contains in interface ByteCollection

Specified by:

contains in interface ByteSet

Overrides:

contains in class AbstractByteCollection

firstByte

public byte firstByte()

Description copied from interface: ByteSortedSet

A method to get the first element in the set

Specified by:

firstByte in interface ByteSortedSet

Returns:

first element in the set

lastByte

public byte lastByte()

Description copied from interface: ByteSortedSet

A method to get the last element in the set

Specified by:

lastByte in interface ByteSortedSet

Returns:

last element in the set

remove

public boolean remove(byte o)

Description copied from interface: ByteSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface ByteSet

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

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

Specified by:

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

Specified by:

remove in interface ByteCollection

Specified by:

remove in interface ByteSet

Overrides:

remove in class AbstractByteCollection

pollFirstByte

public byte pollFirstByte()

Description copied from interface: ByteSortedSet

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

Specified by:

pollFirstByte in interface ByteSortedSet

Returns:

first element in the set

pollLastByte

public byte pollLastByte()

Description copied from interface: ByteSortedSet

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

Specified by:

pollLastByte in interface ByteSortedSet

Returns:

last element in the set

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

copy

public ByteAVLTreeSet copy()

Description copied from interface: ByteCollection

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 ByteCollection

Specified by:

copy in interface ByteNavigableSet

Specified by:

copy in interface ByteSet

Specified by:

copy in interface ByteSortedSet

Overrides:

copy in class AbstractByteSet

Returns:

a Shallow Copy of the collection

comparator

public ByteComparator comparator()

Description copied from interface: ByteSortedSet

A Type Specific Comparator method

Specified by:

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

Specified by:

comparator in interface ByteSortedSet

Returns:

the type specific comparator

iterator

public ByteBidirectionalIterator iterator()

Description copied from interface: ByteCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface ByteCollection

Specified by:

iterator in interface ByteIterable

Specified by:

iterator in interface ByteNavigableSet

Specified by:

iterator in interface ByteSet

Specified by:

iterator in interface ByteSortedSet

Specified by:

iterator in class AbstractByteSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ByteBidirectionalIterator iterator(byte fromElement)

Description copied from interface: ByteSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ByteSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

descendingIterator

public ByteBidirectionalIterator descendingIterator()

Specified by:

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

Specified by:

descendingIterator in interface ByteNavigableSet

Returns:

a Type Specific desendingIterator

subSet

public ByteNavigableSet subSet(byte fromElement,
                               boolean fromInclusive,
                               byte toElement,
                               boolean toInclusive)

Description copied from interface: ByteNavigableSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface ByteNavigableSet

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 ByteNavigableSet headSet(byte toElement,
                                boolean inclusive)

Description copied from interface: ByteNavigableSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface ByteNavigableSet

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 ByteNavigableSet tailSet(byte fromElement,
                                boolean inclusive)

Description copied from interface: ByteNavigableSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface ByteNavigableSet

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

Specified by:

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

Specified by:

descendingSet in interface ByteNavigableSet

Returns:

a Type Specific desendingSet