IntRBTreeSet (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractCollection<java.lang.Integer>
- - speiger.src.collections.ints.collections.AbstractIntCollection
  - - speiger.src.collections.ints.sets.AbstractIntSet
    - - speiger.src.collections.ints.sets.IntRBTreeSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>, java.util.Collection<java.lang.Integer>, java.util.NavigableSet<java.lang.Integer>, java.util.Set<java.lang.Integer>, java.util.SortedSet<java.lang.Integer>, IntCollection, IntIterable, IntNavigableSet, IntSet, IntSortedSet
```
public class IntRBTreeSet
extends AbstractIntSet
implements IntNavigableSet
```
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
`IntRBTreeSet()` Default Constructor
`IntRBTreeSet(java.util.Collection<? extends java.lang.Integer> collection)` Deprecated.
`IntRBTreeSet(java.util.Collection<? extends java.lang.Integer> collection, IntComparator comp)` Deprecated.
`IntRBTreeSet(int[] array)` Helper constructor that allow to create a set from an array
`IntRBTreeSet(int[] array, IntComparator comp)` Helper constructor that allow to create a set from an array
`IntRBTreeSet(int[] array, int offset, int length)` Helper constructor that allow to create a set from an array
`IntRBTreeSet(int[] array, int offset, int length, IntComparator comp)` Helper constructor that allow to create a set from an array
`IntRBTreeSet(IntCollection collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`IntRBTreeSet(IntCollection collection, IntComparator comp)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`IntRBTreeSet(IntComparator comp)` Constructor that allows to define the sorter
`IntRBTreeSet(IntIterator iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`IntRBTreeSet(IntIterator iterator, IntComparator comp)` A Helper constructor that allows to create a set from a iterator of an unknown size
`IntRBTreeSet(IntSortedSet sortedSet)` A Helper constructor that allows to create a Set with exactly the same values as the provided SortedSet.
`IntRBTreeSet(java.util.Iterator<java.lang.Integer> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`IntRBTreeSet(java.util.Iterator<java.lang.Integer> iterator, IntComparator comp)` A Helper constructor that allows to create a set from a iterator of an unknown size

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(int o)` A Type-Specific add function to reduce (un)boxing
`boolean`	`addAndMoveToFirst(int o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(int o)` A customized add method that allows you to insert into the last index.
`int`	`ceiling(int e)` A Type Specific ceiling method to reduce boxing/unboxing.
`void`	`clear()`
`IntComparator`	`comparator()` A Type Specific Comparator method
`boolean`	`contains(int e)` A Type-Specific implementation of contains.
`boolean`	`contains(java.lang.Object e)` This default implementation delegates to the corresponding type-specific function.
`IntBidirectionalIterator`	`descendingIterator()`
`IntNavigableSet`	`descendingSet()`
`int`	`firstInt()` A method to get the first element in the set
`int`	`floor(int e)` A Type Specific floor method to reduce boxing/unboxing.
`int`	`getDefaultMaxValue()` A Helper method to get the max value for SubSets.
`int`	`getDefaultMinValue()` A Helper method to get the min value for SubSets.
`IntNavigableSet`	`headSet(int toElement, boolean inclusive)` A Type Specific HeadSet method to reduce boxing/unboxing
`int`	`higher(int e)` A Type Specific higher method to reduce boxing/unboxing.
`IntBidirectionalIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`IntBidirectionalIterator`	`iterator(int fromElement)` A type Specific Iterator starting from a given key
`int`	`lastInt()` A method to get the last element in the set
`int`	`lower(int e)` A Type Specific lower method to reduce boxing/unboxing.
`boolean`	`moveToFirst(int o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(int o)` A specific move method to move a given key to the last index.
`int`	`pollFirstInt()` A method to get and remove the first element in the set
`int`	`pollLastInt()` A method to get and remove the last element in the set
`boolean`	`remove(int 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(int value)` A Helper method to set the max value for SubSets.
`void`	`setDefaultMinValue(int value)` A Helper method to set the min value for SubSets.
`int`	`size()`
`IntNavigableSet`	`subSet(int fromElement, boolean fromInclusive, int toElement, boolean toInclusive)` A Type Specific SubSet method to reduce boxing/unboxing
`IntNavigableSet`	`tailSet(int fromElement, boolean inclusive)` A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.ints.sets.AbstractIntSet
equals, hashCode

Methods inherited from class speiger.src.collections.ints.collections.AbstractIntCollection
add, addAll, addAll, containsAll, containsAny, containsAny, remInt, removeAll, retainAll, toIntArray, toIntArray

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.ints.sets.IntNavigableSet
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.ints.sets.IntSet
add, remInt

Methods inherited from interface speiger.src.collections.ints.collections.IntCollection
addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toIntArray, toIntArray

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable
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
  - IntRBTreeSet
```
public IntRBTreeSet()
```
    Default Constructor
  - IntRBTreeSet
```
public IntRBTreeSet(IntComparator comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - IntRBTreeSet
```
public IntRBTreeSet(int[] array)
```
    Helper constructor that allow to create a set from an array
    
    Parameters:
    
    array - the elements that should be used
  - IntRBTreeSet
```
public IntRBTreeSet(int[] 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
  - IntRBTreeSet
```
public IntRBTreeSet(int[] array,
                    IntComparator 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
  - IntRBTreeSet
```
public IntRBTreeSet(int[] array,
                    int offset,
                    int length,
                    IntComparator 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
  - IntRBTreeSet
```
public IntRBTreeSet(IntSortedSet 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
  - IntRBTreeSet
```
@Deprecated
public IntRBTreeSet(java.util.Collection<? extends java.lang.Integer> 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
  - IntRBTreeSet
```
@Deprecated
public IntRBTreeSet(java.util.Collection<? extends java.lang.Integer> collection,
                                 IntComparator 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
  - IntRBTreeSet
```
public IntRBTreeSet(IntCollection 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
  - IntRBTreeSet
```
public IntRBTreeSet(IntCollection collection,
                    IntComparator 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
  - IntRBTreeSet
```
public IntRBTreeSet(java.util.Iterator<java.lang.Integer> 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
  - IntRBTreeSet
```
public IntRBTreeSet(java.util.Iterator<java.lang.Integer> iterator,
                    IntComparator 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
  - IntRBTreeSet
```
public IntRBTreeSet(IntIterator 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
  - IntRBTreeSet
```
public IntRBTreeSet(IntIterator iterator,
                    IntComparator 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(int value)
```
    Description copied from interface: IntNavigableSet
    
    A Helper method to set the max value for SubSets. (Default: int.MIN_VALUE)
    
    Specified by:
    
    setDefaultMaxValue in interface IntNavigableSet
    
    Parameters:
    
    value - the new max value
  - getDefaultMaxValue
```
public int getDefaultMaxValue()
```
    Description copied from interface: IntNavigableSet
    
    A Helper method to get the max value for SubSets.
    
    Specified by:
    
    getDefaultMaxValue in interface IntNavigableSet
    
    Returns:
    
    the default max value.
  - setDefaultMinValue
```
public void setDefaultMinValue(int value)
```
    Description copied from interface: IntNavigableSet
    
    A Helper method to set the min value for SubSets. (Default: int.MAX_VALUE)
    
    Specified by:
    
    setDefaultMinValue in interface IntNavigableSet
    
    Parameters:
    
    value - the new min value
  - getDefaultMinValue
```
public int getDefaultMinValue()
```
    Description copied from interface: IntNavigableSet
    
    A Helper method to get the min value for SubSets.
    
    Specified by:
    
    getDefaultMinValue in interface IntNavigableSet
    
    Returns:
    
    the default min value.
  - add
```
public boolean add(int o)
```
    Description copied from interface: IntCollection
    
    A Type-Specific add function to reduce (un)boxing
    
    Specified by:
    
    add in interface IntCollection
    
    Parameters:
    
    o - the element that should be added
    
    Returns:
    
    true if the element was added to the collection
  - addAndMoveToFirst
```
public boolean addAndMoveToFirst(int o)
```
    Description copied from interface: IntSortedSet
    
    A customized add method that allows you to insert into the first index.
    
    Specified by:
    
    addAndMoveToFirst in interface IntSortedSet
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - addAndMoveToLast
```
public boolean addAndMoveToLast(int o)
```
    Description copied from interface: IntSortedSet
    
    A customized add method that allows you to insert into the last index.
    
    Specified by:
    
    addAndMoveToLast in interface IntSortedSet
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - moveToFirst
```
public boolean moveToFirst(int o)
```
    Description copied from interface: IntSortedSet
    
    A specific move method to move a given key to the first index.
    
    Specified by:
    
    moveToFirst in interface IntSortedSet
    
    Parameters:
    
    o - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(int o)
```
    Description copied from interface: IntSortedSet
    
    A specific move method to move a given key to the last index.
    
    Specified by:
    
    moveToLast in interface IntSortedSet
    
    Parameters:
    
    o - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - lower
```
public int lower(int e)
```
    Description copied from interface: IntNavigableSet
    
    A Type Specific lower method to reduce boxing/unboxing.
    
    Specified by:
    
    lower in interface IntNavigableSet
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower key that can be found
  - floor
```
public int floor(int e)
```
    Description copied from interface: IntNavigableSet
    
    A Type Specific floor method to reduce boxing/unboxing.
    
    Specified by:
    
    floor in interface IntNavigableSet
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower or equal key that can be found
  - higher
```
public int higher(int e)
```
    Description copied from interface: IntNavigableSet
    
    A Type Specific higher method to reduce boxing/unboxing.
    
    Specified by:
    
    higher in interface IntNavigableSet
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher key that can be found
  - ceiling
```
public int ceiling(int e)
```
    Description copied from interface: IntNavigableSet
    
    A Type Specific ceiling method to reduce boxing/unboxing.
    
    Specified by:
    
    ceiling in interface IntNavigableSet
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher or equal key that can be found
  - contains
```
public boolean contains(int e)
```
    Description copied from class: AbstractIntCollection
    
    A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.
    
    Specified by:
    
    contains in interface IntCollection
    
    Overrides:
    
    contains in class AbstractIntCollection
    
    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: AbstractIntCollection
    
    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.Integer>
    
    Specified by:
    
    contains in interface java.util.Set<java.lang.Integer>
    
    Specified by:
    
    contains in interface IntCollection
    
    Specified by:
    
    contains in interface IntSet
    
    Overrides:
    
    contains in class AbstractIntCollection
  - firstInt
```
public int firstInt()
```
    Description copied from interface: IntSortedSet
    
    A method to get the first element in the set
    
    Specified by:
    
    firstInt in interface IntSortedSet
    
    Returns:
    
    first element in the set
  - lastInt
```
public int lastInt()
```
    Description copied from interface: IntSortedSet
    
    A method to get the last element in the set
    
    Specified by:
    
    lastInt in interface IntSortedSet
    
    Returns:
    
    last element in the set
  - remove
```
public boolean remove(int o)
```
    Description copied from interface: IntSet
    
    A Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface IntSet
    
    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: AbstractIntCollection
    
    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.Integer>
    
    Specified by:
    
    remove in interface java.util.Set<java.lang.Integer>
    
    Specified by:
    
    remove in interface IntCollection
    
    Specified by:
    
    remove in interface IntSet
    
    Overrides:
    
    remove in class AbstractIntCollection
  - pollFirstInt
```
public int pollFirstInt()
```
    Description copied from interface: IntSortedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirstInt in interface IntSortedSet
    
    Returns:
    
    first element in the set
  - pollLastInt
```
public int pollLastInt()
```
    Description copied from interface: IntSortedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLastInt in interface IntSortedSet
    
    Returns:
    
    last element in the set
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    size in interface java.util.Set<java.lang.Integer>
    
    Specified by:
    
    size in class java.util.AbstractCollection<java.lang.Integer>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    clear in interface java.util.Set<java.lang.Integer>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<java.lang.Integer>
  - comparator
```
public IntComparator comparator()
```
    Description copied from interface: IntSortedSet
    
    A Type Specific Comparator method
    
    Specified by:
    
    comparator in interface java.util.SortedSet<java.lang.Integer>
    
    Specified by:
    
    comparator in interface IntSortedSet
    
    Returns:
    
    the type specific comparator
  - iterator
```
public IntBidirectionalIterator iterator()
```
    Description copied from interface: IntCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Integer>
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    iterator in interface java.util.NavigableSet<java.lang.Integer>
    
    Specified by:
    
    iterator in interface java.util.Set<java.lang.Integer>
    
    Specified by:
    
    iterator in interface IntCollection
    
    Specified by:
    
    iterator in interface IntIterable
    
    Specified by:
    
    iterator in interface IntNavigableSet
    
    Specified by:
    
    iterator in interface IntSet
    
    Specified by:
    
    iterator in interface IntSortedSet
    
    Specified by:
    
    iterator in class AbstractIntSet
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
public IntBidirectionalIterator iterator(int fromElement)
```
    Description copied from interface: IntSortedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface IntSortedSet
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - descendingIterator
```
public IntBidirectionalIterator descendingIterator()
```
    Specified by:
    
    descendingIterator in interface java.util.NavigableSet<java.lang.Integer>
    
    Specified by:
    
    descendingIterator in interface IntNavigableSet
    
    Returns:
    
    a Type Specific desendingIterator
  - subSet
```
public IntNavigableSet subSet(int fromElement,
                              boolean fromInclusive,
                              int toElement,
                              boolean toInclusive)
```
    Description copied from interface: IntNavigableSet
    
    A Type Specific SubSet method to reduce boxing/unboxing
    
    Specified by:
    
    subSet in interface IntNavigableSet
    
    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 IntNavigableSet headSet(int toElement,
                               boolean inclusive)
```
    Description copied from interface: IntNavigableSet
    
    A Type Specific HeadSet method to reduce boxing/unboxing
    
    Specified by:
    
    headSet in interface IntNavigableSet
    
    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 IntNavigableSet tailSet(int fromElement,
                               boolean inclusive)
```
    Description copied from interface: IntNavigableSet
    
    A Type Specific TailSet method to reduce boxing/unboxing
    
    Specified by:
    
    tailSet in interface IntNavigableSet
    
    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 IntNavigableSet descendingSet()
```
    Specified by:
    
    descendingSet in interface java.util.NavigableSet<java.lang.Integer>
    
    Specified by:
    
    descendingSet in interface IntNavigableSet
    
    Returns:
    
    a Type Specific desendingSet

Class IntRBTreeSet

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.ints.sets.AbstractIntSet

Methods inherited from class speiger.src.collections.ints.collections.AbstractIntCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.ints.sets.IntNavigableSet

Methods inherited from interface speiger.src.collections.ints.sets.IntSet

Methods inherited from interface speiger.src.collections.ints.collections.IntCollection

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Constructor Detail

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

IntRBTreeSet

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

add

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

lower

floor

higher

ceiling

contains

contains

firstInt

lastInt

remove

remove

pollFirstInt

pollLastInt

size

clear

comparator

iterator

iterator

descendingIterator

subSet

headSet

tailSet

descendingSet