AVLSearch (terraml-algorithm 1.0.0 API)

java.lang.Object
- terraml.algorithm.AVLSearch<Q>

All Implemented Interfaces:

Serializable, Iterable<Q>, Collection<Q>, Set<Q>, SortedSet<Q>, BiTreeSet<Q>
```
public class AVLSearch<Q>
extends Object
implements BiTreeSet<Q>
```
Version:

1.0.0-SNAPSHOT

Author:

M.Çağrı Tepebaşılı - cagritepebasili [at] protonmail [dot] com

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AVLSearch(Comparator<Q> comparator)`
`AVLSearch(Comparator<Q> comparator, AVLNode<Q> root)`
`AVLSearch(Comparator<Q> comparator, Q data)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_removeFamily(AVLNode<Q> node)`
`boolean`	`add(Q data)`
`boolean`	`addAll(Collection<? extends Q> collection)`
`void`	`clear()`
`protected List<Q>`	`collect(AVLNode<Q> src, List<Q> list)`
`Comparator<? super Q>`	`comparator()`
`protected boolean`	`contains(AVLNode<Q> src, Q data)`
`boolean`	`contains(Object object)`
`boolean`	`containsAll(Collection<?> collection)`
`boolean`	`containsAllFamily(Collection<Q> collection)`
`protected boolean`	`containsFamily(AVLNode<Q> src, Q data)`
`boolean`	`containsFamily(Q object)`
`protected boolean`	`eq(AVLNode<Q> src, AVLNode<Q> tar)`
`protected boolean`	`eq(Q data, AVLNode<Q> src)`
`protected boolean`	`eq(Q data0, Q data1)`
`Q`	`first()`
`Iterator<Q>`	`firstFamily()`
`void`	`forEach(java.util.function.Consumer<? super Q> action)`
`Comparator<Q>`	`getComparator()`
`AVLNode<Q>`	`getRoot()`
`protected boolean`	`gt(AVLNode<Q> src, AVLNode<Q> tar)`
`protected boolean`	`gt(Q data, AVLNode<Q> src)`
`protected boolean`	`gt(Q data0, Q data1)`
`protected AVLNode<Q>`	`headSet(AVLNode<Q> src, Q item)`
`SortedSet<Q>`	`headSet(Q toElement)`
`protected int`	`height(AVLNode<Q> node)`
`boolean`	`isEmpty()`
`Iterator<Q>`	`iterator()`
`Q`	`last()`
`Iterator<Q>`	`lastFamily()`
`protected boolean`	`le(AVLNode<Q> src)`
`protected boolean`	`lf(AVLNode<Q> src)`
`protected Q`	`maximum(AVLNode<Q> src)`
`protected AVLNode<Q>`	`maximumFamily(AVLNode<Q> src)`
`protected Q`	`minimum(AVLNode<Q> src)`
`protected AVLNode<Q>`	`minimumFamily(AVLNode<Q> src)`
`java.util.stream.Stream<Q>`	`parallelStream()`
`protected boolean`	`re(AVLNode<Q> src)`
`protected void`	`rebalance(AVLNode<Q> node)`
`protected void`	`reheight(AVLNode<Q> node)`
`boolean`	`remove(Object object)`
`boolean`	`removeAll(Collection<?> collection)`
`void`	`removeAllFamily(Collection<? extends Q> collection)`
`void`	`removeFamily(Q object)`
`boolean`	`removeIf(java.util.function.Predicate<? super Q> filter)`
`boolean`	`retainAll(Collection<?> collection)`
`protected AVLNode<Q>`	`rotateLeft(AVLNode<Q> node)`
`protected AVLNode<Q>`	`rotateLeftThenRight(AVLNode<Q> node)`
`protected AVLNode<Q>`	`rotateRight(AVLNode<Q> node)`
`protected AVLNode<Q>`	`rotateRightThenLeft(AVLNode<Q> node)`
`protected void`	`setBalance(Collection<AVLNode<Q>> nodes)`
`void`	`setRoot(AVLNode<Q> root)`
`int`	`size()`
`protected int`	`size(AVLNode<Q> src)`
`Spliterator<Q>`	`spliterator()`
`protected boolean`	`st(AVLNode<Q> src, AVLNode<Q> tar)`
`protected boolean`	`st(Q data, AVLNode<Q> src)`
`protected boolean`	`st(Q data0, Q data1)`
`java.util.stream.Stream<Q>`	`stream()`
`protected AVLNode<Q>`	`subSet(AVLNode<Q> src, Q from, Q to)`
`SortedSet<Q>`	`subSet(Q fromElement, Q toElement)`
`protected AVLNode<Q>`	`tailSet(AVLNode<Q> src, Q item)`
`SortedSet<Q>`	`tailSet(Q fromElement)`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Set
equals, hashCode

- Constructor Detail
  - AVLSearch
```
public AVLSearch(Comparator<Q> comparator)
```
    Parameters:
    
    comparator -
  - AVLSearch
```
public AVLSearch(Comparator<Q> comparator,
                 AVLNode<Q> root)
```
    Parameters:
    
    comparator -
    
    root -
  - AVLSearch
```
public AVLSearch(Comparator<Q> comparator,
                 Q data)
```
    Parameters:
    
    comparator -
    
    data -
- Method Detail
  - add
```
public boolean add(Q data)
```
    Specified by:
    
    add in interface Collection<Q>
    
    Specified by:
    
    add in interface Set<Q>
    
    Specified by:
    
    add in interface BiTreeSet<Q>
  - addAll
```
public boolean addAll(Collection<? extends Q> collection)
```
    Specified by:
    
    addAll in interface Collection<Q>
    
    Specified by:
    
    addAll in interface Set<Q>
    
    Specified by:
    
    addAll in interface BiTreeSet<Q>
  - contains
```
protected boolean contains(AVLNode<Q> src,
                           Q data)
```
    Parameters:
    
    src -
    
    data -
    
    Returns:
  - contains
```
public boolean contains(Object object)
```
    Specified by:
    
    contains in interface Collection<Q>
    
    Specified by:
    
    contains in interface Set<Q>
    
    Specified by:
    
    contains in interface BiTreeSet<Q>
  - containsAll
```
public boolean containsAll(Collection<?> collection)
```
    Specified by:
    
    containsAll in interface Collection<Q>
    
    Specified by:
    
    containsAll in interface Set<Q>
    
    Specified by:
    
    containsAll in interface BiTreeSet<Q>
  - containsFamily
```
protected boolean containsFamily(AVLNode<Q> src,
                                 Q data)
```
    Parameters:
    
    src -
    
    data -
    
    Returns:
  - containsFamily
```
public boolean containsFamily(Q object)
```
    Specified by:
    
    containsFamily in interface BiTreeSet<Q>
    
    Returns:
  - containsAllFamily
```
public boolean containsAllFamily(Collection<Q> collection)
```
    Specified by:
    
    containsAllFamily in interface BiTreeSet<Q>
    
    Returns:
  - removeFamily
```
public void removeFamily(Q object)
```
    Specified by:
    
    removeFamily in interface BiTreeSet<Q>
    
    Parameters:
    
    data -
  - removeAllFamily
```
public void removeAllFamily(Collection<? extends Q> collection)
```
    Specified by:
    
    removeAllFamily in interface BiTreeSet<Q>
  - removeIf
```
public boolean removeIf(java.util.function.Predicate<? super Q> filter)
```
    Specified by:
    
    removeIf in interface Collection<Q>
    
    Specified by:
    
    removeIf in interface BiTreeSet<Q>
  - remove
```
public boolean remove(Object object)
```
    Specified by:
    
    remove in interface Collection<Q>
    
    Specified by:
    
    remove in interface Set<Q>
    
    Specified by:
    
    remove in interface BiTreeSet<Q>
  - removeAll
```
public boolean removeAll(Collection<?> collection)
```
    Specified by:
    
    removeAll in interface Collection<Q>
    
    Specified by:
    
    removeAll in interface Set<Q>
    
    Specified by:
    
    removeAll in interface BiTreeSet<Q>
  - _removeFamily
```
protected void _removeFamily(AVLNode<Q> node)
```
    Parameters:
    
    node -
  - rebalance
```
protected void rebalance(AVLNode<Q> node)
```
    Parameters:
    
    node -
  - rotateLeft
```
protected AVLNode<Q> rotateLeft(AVLNode<Q> node)
```
    Parameters:
    
    node -
    
    Returns:
  - rotateRight
```
protected AVLNode<Q> rotateRight(AVLNode<Q> node)
```
    Parameters:
    
    node -
    
    Returns:
  - rotateLeftThenRight
```
protected AVLNode<Q> rotateLeftThenRight(AVLNode<Q> node)
```
    Parameters:
    
    node -
    
    Returns:
  - rotateRightThenLeft
```
protected AVLNode<Q> rotateRightThenLeft(AVLNode<Q> node)
```
    Parameters:
    
    node -
    
    Returns:
  - minimum
```
protected Q minimum(AVLNode<Q> src)
```
    Parameters:
    
    src -
    
    Returns:
  - maximum
```
protected Q maximum(AVLNode<Q> src)
```
    Parameters:
    
    src - source
    
    Returns:
    
    maximum comparable object.
  - last
```
public Q last()
```
    Specified by:
    
    last in interface SortedSet<Q>
    
    Specified by:
    
    last in interface BiTreeSet<Q>
  - first
```
public Q first()
```
    Specified by:
    
    first in interface SortedSet<Q>
    
    Specified by:
    
    first in interface BiTreeSet<Q>
  - minimumFamily
```
protected AVLNode<Q> minimumFamily(AVLNode<Q> src)
```
    Parameters:
    
    src - source
    
    Returns:
    
    node that hold minimum comparable objects.
  - maximumFamily
```
protected AVLNode<Q> maximumFamily(AVLNode<Q> src)
```
    Parameters:
    
    src - source
    
    Returns:
    
    node that hold maximum comparable objects.
  - lastFamily
```
public Iterator<Q> lastFamily()
```
    Specified by:
    
    lastFamily in interface BiTreeSet<Q>
    
    Returns:
  - firstFamily
```
public Iterator<Q> firstFamily()
```
    Specified by:
    
    firstFamily in interface BiTreeSet<Q>
    
    Returns:
  - tailSet
```
protected AVLNode<Q> tailSet(AVLNode<Q> src,
                             Q item)
```
    Parameters:
    
    src -
    
    item -
    
    Returns:
  - tailSet
```
public SortedSet<Q> tailSet(Q fromElement)
```
    Specified by:
    
    tailSet in interface SortedSet<Q>
    
    Specified by:
    
    tailSet in interface BiTreeSet<Q>
  - headSet
```
protected AVLNode<Q> headSet(AVLNode<Q> src,
                             Q item)
```
    Parameters:
    
    src -
    
    item -
    
    Returns:
  - headSet
```
public SortedSet<Q> headSet(Q toElement)
```
    Specified by:
    
    headSet in interface SortedSet<Q>
    
    Specified by:
    
    headSet in interface BiTreeSet<Q>
  - subSet
```
protected AVLNode<Q> subSet(AVLNode<Q> src,
                            Q from,
                            Q to)
```
    Parameters:
    
    src -
    
    from -
    
    to -
    
    Returns:
  - subSet
```
public SortedSet<Q> subSet(Q fromElement,
                           Q toElement)
```
    Specified by:
    
    subSet in interface SortedSet<Q>
    
    Specified by:
    
    subSet in interface BiTreeSet<Q>
  - collect
```
protected List<Q> collect(AVLNode<Q> src,
                          List<Q> list)
```
    Parameters:
    
    src -
    
    list -
    
    Returns:
  - size
```
protected int size(AVLNode<Q> src)
```
    Parameters:
    
    src -
    
    Returns:
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Q>
    
    Specified by:
    
    size in interface Set<Q>
    
    Specified by:
    
    size in interface BiTreeSet<Q>
  - spliterator
```
public Spliterator<Q> spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<Q>
    
    Specified by:
    
    spliterator in interface Collection<Q>
    
    Specified by:
    
    spliterator in interface Set<Q>
    
    Specified by:
    
    spliterator in interface SortedSet<Q>
    
    Specified by:
    
    spliterator in interface BiTreeSet<Q>
  - comparator
```
public Comparator<? super Q> comparator()
```
    Specified by:
    
    comparator in interface SortedSet<Q>
    
    Specified by:
    
    comparator in interface BiTreeSet<Q>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Q>
    
    Specified by:
    
    clear in interface Set<Q>
    
    Specified by:
    
    clear in interface BiTreeSet<Q>
  - retainAll
```
public boolean retainAll(Collection<?> collection)
```
    Specified by:
    
    retainAll in interface Collection<Q>
    
    Specified by:
    
    retainAll in interface Set<Q>
    
    Specified by:
    
    retainAll in interface BiTreeSet<Q>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<Q>
    
    Specified by:
    
    toArray in interface Set<Q>
    
    Specified by:
    
    toArray in interface BiTreeSet<Q>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<Q>
    
    Specified by:
    
    toArray in interface Set<Q>
    
    Specified by:
    
    toArray in interface BiTreeSet<Q>
  - iterator
```
public Iterator<Q> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Q>
    
    Specified by:
    
    iterator in interface Collection<Q>
    
    Specified by:
    
    iterator in interface Set<Q>
    
    Specified by:
    
    iterator in interface BiTreeSet<Q>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<Q>
    
    Specified by:
    
    isEmpty in interface Set<Q>
    
    Specified by:
    
    isEmpty in interface BiTreeSet<Q>
  - parallelStream
```
public java.util.stream.Stream<Q> parallelStream()
```
    Specified by:
    
    parallelStream in interface Collection<Q>
    
    Specified by:
    
    parallelStream in interface BiTreeSet<Q>
  - stream
```
public java.util.stream.Stream<Q> stream()
```
    Specified by:
    
    stream in interface Collection<Q>
    
    Specified by:
    
    stream in interface BiTreeSet<Q>
  - forEach
```
public void forEach(java.util.function.Consumer<? super Q> action)
```
    Specified by:
    
    forEach in interface Iterable<Q>
    
    Specified by:
    
    forEach in interface BiTreeSet<Q>
  - setBalance
```
protected void setBalance(Collection<AVLNode<Q>> nodes)
```
    Parameters:
    
    nodes -
  - eq
```
protected boolean eq(AVLNode<Q> src,
                     AVLNode<Q> tar)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result equals to 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - eq
```
protected boolean eq(Q data,
                     AVLNode<Q> src)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result equals to 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - eq
```
protected boolean eq(Q data0,
                     Q data1)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result equals to 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - st
```
protected boolean st(AVLNode<Q> src,
                     AVLNode<Q> tar)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result equals to 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - st
```
protected boolean st(Q data,
                     AVLNode<Q> src)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result smaller than 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - st
```
protected boolean st(Q data0,
                     Q data1)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result equals to 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - gt
```
protected boolean gt(AVLNode<Q> src,
                     AVLNode<Q> tar)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result equals to 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - gt
```
protected boolean gt(Q data,
                     AVLNode<Q> src)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result greater than 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - gt
```
protected boolean gt(Q data0,
                     Q data1)
```
    Parameters:
    
    data - comparable object
    
    src - source
    
    Returns:
    
    true if comparison result equals to 0. Otherwise it returns false. Also if any given arguments is null then it returns false.
  - le
```
protected boolean le(AVLNode<Q> src)
```
    Parameters:
    
    src - source
    
    Returns:
    
    true if given nodes left child is empty. Otherwise it returns false. Also if given node is null then it returns false.
  - re
```
protected boolean re(AVLNode<Q> src)
```
    Parameters:
    
    src - source
    
    Returns:
    
    true if given nodes right child is empty. Otherwise it returns false. Also if given node is null then it returns false.
  - lf
```
protected boolean lf(AVLNode<Q> src)
```
    Parameters:
    
    src - source
    
    Returns:
    
    true if given nodes left and right child is empty(leaf). Otherwise it returns false. Also if given node is null then it returns false.
  - height
```
protected int height(AVLNode<Q> node)
```
    Parameters:
    
    node -
    
    Returns:
  - reheight
```
protected void reheight(AVLNode<Q> node)
```
    Parameters:
    
    node -
  - getComparator
```
public Comparator<Q> getComparator()
```
    Returns:
  - getRoot
```
public AVLNode<Q> getRoot()
```
    Returns:
  - setRoot
```
public void setRoot(AVLNode<Q> root)
```
    Parameters:
    
    root -

Class AVLSearch<Q>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Constructor Detail

AVLSearch

AVLSearch

AVLSearch

Method Detail

add

addAll

contains

contains

containsAll

containsFamily

containsFamily

containsAllFamily

removeFamily

removeAllFamily

removeIf

remove

removeAll

_removeFamily

rebalance

rotateLeft

rotateRight

rotateLeftThenRight

rotateRightThenLeft

minimum

maximum

last

first

minimumFamily

maximumFamily

lastFamily

firstFamily

tailSet

tailSet

headSet

headSet

subSet

subSet

collect

size

size

spliterator

comparator

clear

retainAll

toArray

toArray

iterator

isEmpty

parallelStream

stream

forEach

setBalance

eq

eq

eq

st

st

st

gt

gt

gt

le

re

lf

height

reheight

getComparator

getRoot

setRoot