CharAVLTreeSet (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractCollection<java.lang.Character>
- - speiger.src.collections.chars.collections.AbstractCharCollection
  - - speiger.src.collections.chars.sets.AbstractCharSet
    - - speiger.src.collections.chars.sets.CharAVLTreeSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.NavigableSet<java.lang.Character>, java.util.Set<java.lang.Character>, java.util.SortedSet<java.lang.Character>, CharCollection, CharIterable, CharNavigableSet, CharSet, CharSortedSet
```
public class CharAVLTreeSet
extends AbstractCharSet
implements CharNavigableSet
```
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
`CharAVLTreeSet()` Default Constructor
`CharAVLTreeSet(char[] array)` Helper constructor that allow to create a set from an array
`CharAVLTreeSet(char[] array, CharComparator comp)` Helper constructor that allow to create a set from an array
`CharAVLTreeSet(char[] array, int offset, int length)` Helper constructor that allow to create a set from an array
`CharAVLTreeSet(char[] array, int offset, int length, CharComparator comp)` Helper constructor that allow to create a set from an array
`CharAVLTreeSet(CharCollection collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`CharAVLTreeSet(CharCollection collection, CharComparator comp)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`CharAVLTreeSet(CharComparator comp)` Constructor that allows to define the sorter
`CharAVLTreeSet(CharIterator iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`CharAVLTreeSet(CharIterator iterator, CharComparator comp)` A Helper constructor that allows to create a set from a iterator of an unknown size
`CharAVLTreeSet(CharSortedSet sortedSet)` A Helper constructor that allows to create a Set with exactly the same values as the provided SortedSet.
`CharAVLTreeSet(java.util.Collection<? extends java.lang.Character> collection)` Deprecated.
`CharAVLTreeSet(java.util.Collection<? extends java.lang.Character> collection, CharComparator comp)` Deprecated.
`CharAVLTreeSet(java.util.Iterator<java.lang.Character> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`CharAVLTreeSet(java.util.Iterator<java.lang.Character> iterator, CharComparator 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(char o)` A Type-Specific add function to reduce (un)boxing
`boolean`	`addAndMoveToFirst(char o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(char o)` A customized add method that allows you to insert into the last index.
`char`	`ceiling(char e)` A Type Specific ceiling method to reduce boxing/unboxing.
`void`	`clear()`
`CharComparator`	`comparator()` A Type Specific Comparator method
`boolean`	`contains(char e)` A Type-Specific implementation of contains.
`boolean`	`contains(java.lang.Object e)` This default implementation delegates to the corresponding type-specific function.
`CharBidirectionalIterator`	`descendingIterator()`
`CharNavigableSet`	`descendingSet()`
`char`	`firstChar()` A method to get the first element in the set
`char`	`floor(char e)` A Type Specific floor method to reduce boxing/unboxing.
`char`	`getDefaultMaxValue()` A Helper method to get the max value for SubSets.
`char`	`getDefaultMinValue()` A Helper method to get the min value for SubSets.
`CharNavigableSet`	`headSet(char toElement, boolean inclusive)` A Type Specific HeadSet method to reduce boxing/unboxing
`char`	`higher(char e)` A Type Specific higher method to reduce boxing/unboxing.
`CharBidirectionalIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`CharBidirectionalIterator`	`iterator(char fromElement)` A type Specific Iterator starting from a given key
`char`	`lastChar()` A method to get the last element in the set
`char`	`lower(char e)` A Type Specific lower method to reduce boxing/unboxing.
`boolean`	`moveToFirst(char o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(char o)` A specific move method to move a given key to the last index.
`char`	`pollFirstChar()` A method to get and remove the first element in the set
`char`	`pollLastChar()` A method to get and remove the last element in the set
`boolean`	`remove(char 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(char value)` A Helper method to set the max value for SubSets.
`void`	`setDefaultMinValue(char value)` A Helper method to set the min value for SubSets.
`int`	`size()`
`CharNavigableSet`	`subSet(char fromElement, boolean fromInclusive, char toElement, boolean toInclusive)` A Type Specific SubSet method to reduce boxing/unboxing
`CharNavigableSet`	`tailSet(char fromElement, boolean inclusive)` A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.chars.sets.AbstractCharSet
equals, hashCode

Methods inherited from class speiger.src.collections.chars.collections.AbstractCharCollection
add, addAll, addAll, containsAll, containsAny, containsAny, remChar, removeAll, retainAll, toCharArray, toCharArray

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.chars.sets.CharNavigableSet
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.chars.sets.CharSet
add, remChar

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection
addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toCharArray, toCharArray

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

Class CharAVLTreeSet

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.chars.sets.AbstractCharSet

Methods inherited from class speiger.src.collections.chars.collections.AbstractCharCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.sets.CharNavigableSet

Methods inherited from interface speiger.src.collections.chars.sets.CharSet

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Constructor Detail

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

CharAVLTreeSet

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

add

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

lower

floor

higher

ceiling

contains

contains

firstChar

lastChar

remove

remove

pollFirstChar

pollLastChar

size

clear

comparator

iterator

iterator

descendingIterator

subSet

headSet

tailSet

descendingSet