terraml.algorithm

Class BiSearch<Q>

java.lang.Object

terraml.algorithm.BiSearch<Q>

All Implemented Interfaces:

Serializable, Iterable<Q>, Collection<Q>, Set<Q>, SortedSet<Q>, BiTreeSet<Q>

public class BiSearch<Q>
extends Object
implements BiTreeSet<Q>, Serializable

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
BiSearch(Comparator<Q> comparator, BiNode<Q> root)
BiSearch(Comparator<Q> comp, Q item)

Method Summary

Modifier and Type	Method and Description
protected BiNode<Q>	add(BiNode<Q> src, Q item)
boolean	add(Q item)
boolean	addAll(Collection<? extends Q> collection)
protected boolean	btw(Q from, Q to, BiNode<Q> src)
void	clear()
protected List<Q>	collect(BiNode<Q> src, List<Q> list)
Comparator<? super Q>	comparator()
boolean	contains(Object item)
boolean	containsAll(Collection<?> collection)
boolean	containsAllFamily(Collection<Q> collection)
boolean	containsFamily(Q item)
protected boolean	eq(Q data, BiNode<Q> src)
protected int	familySize(BiNode<Q> src)
Q	first()
Iterator<Q>	firstFamily()
void	forEach(java.util.function.Consumer<? super Q> action)
protected BiNode<Q>	get(BiNode<Q> src, Q item)
protected BiNode<Q>	getFamily(BiNode<Q> src, Q item)
BiNode<Q>	getRoot() Basic getter method.
protected boolean	gt(Q data, BiNode<Q> src)
protected boolean	hasDuplicates(BiNode<Q> src)
protected BiNode<Q>	headSet(BiNode<Q> src, Q item)
BiTreeSet<Q>	headSet(Q toElement)
protected int	height(BiNode<Q> src)
boolean	isEmpty()
Iterator<Q>	iterator()
Q	last()
Iterator<Q>	lastFamily()
protected boolean	le(BiNode<Q> src)
protected boolean	lf(BiNode<Q> src)
protected Q	maximum(BiNode<Q> src)
protected BiNode<Q>	maximumFamily(BiNode<Q> src)
protected Q	minimum(BiNode<Q> src)
protected BiNode<Q>	minimumFamily(BiNode<Q> src)
java.util.stream.Stream<Q>	parallelStream()
protected boolean	re(BiNode<Q> src)
boolean	remove(Object item)
boolean	removeAll(Collection<?> collection)
void	removeAllFamily(Collection<? extends Q> collection)
protected BiNode<Q>	removeFamily(BiNode<Q> src, Q item)
void	removeFamily(Q item)
boolean	removeIf(java.util.function.Predicate<? super Q> filter)
boolean	retainAll(Collection<?> collection)
void	setRoot(BiNode<Q> obj) Basic setter method.
int	size()
protected int	size(BiNode<Q> src)
Spliterator<Q>	spliterator()
protected boolean	st(Q data, BiNode<Q> src)
java.util.stream.Stream<Q>	stream()
protected BiNode<Q>	subSet(BiNode<Q> src, Q from, Q to)
BiTreeSet<Q>	subSet(Q fromElement, Q toElement)
protected BiNode<Q>	tailSet(BiNode<Q> src, Q item)
BiTreeSet<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

BiSearch

public BiSearch(Comparator<Q> comp,
                Q item)

Parameters:

comp -

item -

BiSearch

public BiSearch(Comparator<Q> comparator,
                BiNode<Q> root)

Parameters:

comparator -

root -

Method Detail

hasDuplicates

protected boolean hasDuplicates(BiNode<Q> src)

Parameters:

src - source

Returns:

true if given node has duplicate nodes. Otherwise it returns false.

eq

protected boolean eq(Q data,
                     BiNode<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.

st

protected boolean st(Q data,
                     BiNode<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.

gt

protected boolean gt(Q data,
                     BiNode<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.

btw

protected boolean btw(Q from,
                      Q to,
                      BiNode<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.

le

protected boolean le(BiNode<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(BiNode<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(BiNode<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.

size

protected int size(BiNode<Q> src)

Parameters:

src - source

Returns:

count of elements on given node. It counts if any duplicates exists.

familySize

protected int familySize(BiNode<Q> src)

Parameters:

src - source

Returns:

count of elements on given node. It doesn't count if any duplicates exists.

height

protected int height(BiNode<Q> src)

Parameters:

src - source

Returns:

height of given node.

minimum

protected Q minimum(BiNode<Q> src)

Parameters:

src - source

Returns:

minimum comparable object.

maximum

protected Q maximum(BiNode<Q> src)

Parameters:

src - source

Returns:

maximum comparable object.

minimumFamily

protected BiNode<Q> minimumFamily(BiNode<Q> src)

Parameters:

src - source

Returns:

node that hold minimum comparable objects.

maximumFamily

protected BiNode<Q> maximumFamily(BiNode<Q> src)

Parameters:

src - source

Returns:

node that hold maximum comparable objects.

add

protected BiNode<Q> add(BiNode<Q> src,
                        Q item)

Parameters:

src - source

item - comparable object

Returns:

a new node that containing all given elements on given node plus a new one that created with given item.

add

public boolean add(Q item)

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>

removeFamily

protected BiNode<Q> removeFamily(BiNode<Q> src,
                                 Q item)

Parameters:

src - source

item - comparable object

Returns:

a new node that containing all elements from given node except given items family.

removeFamily

public void removeFamily(Q item)

Specified by:

removeFamily in interface BiTreeSet<Q>

removeAllFamily

public void removeAllFamily(Collection<? extends Q> collection)

Specified by:

removeAllFamily in interface BiTreeSet<Q>

remove

public boolean remove(Object item)

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>

getFamily

protected BiNode<Q> getFamily(BiNode<Q> src,
                              Q item)

Parameters:

src - source

item - comparable object

Returns:

a node that contains given comparable objects.

containsFamily

public boolean containsFamily(Q item)

Specified by:

containsFamily in interface BiTreeSet<Q>

Returns:

containsAllFamily

public boolean containsAllFamily(Collection<Q> collection)

Specified by:

containsAllFamily in interface BiTreeSet<Q>

Returns:

get

protected BiNode<Q> get(BiNode<Q> src,
                        Q item)

Type Parameters:

Q - generi type

Parameters:

src - source

item - comparable object

Returns:

a node that equals to given element.

contains

public boolean contains(Object item)

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>

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>

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:

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>

collect

protected List<Q> collect(BiNode<Q> src,
                          List<Q> list)

Parameters:

src -

list -

Returns:

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>

stream

public java.util.stream.Stream<Q> stream()

Specified by:

stream in interface Collection<Q>

Specified by:

stream in interface BiTreeSet<Q>

getRoot

public BiNode<Q> getRoot()

Basic getter method.

Returns:

root node.

setRoot

public void setRoot(BiNode<Q> obj)

Basic setter method.

Parameters:

obj - root object

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>

tailSet

protected BiNode<Q> tailSet(BiNode<Q> src,
                            Q item)

Parameters:

src -

item -

Returns:

tailSet

public BiTreeSet<Q> tailSet(Q fromElement)

Specified by:

tailSet in interface SortedSet<Q>

Specified by:

tailSet in interface BiTreeSet<Q>

headSet

protected BiNode<Q> headSet(BiNode<Q> src,
                            Q item)

Parameters:

src -

item -

Returns:

headSet

public BiTreeSet<Q> headSet(Q toElement)

Specified by:

headSet in interface SortedSet<Q>

Specified by:

headSet in interface BiTreeSet<Q>

subSet

protected BiNode<Q> subSet(BiNode<Q> src,
                           Q from,
                           Q to)

Parameters:

src -

from -

to -

Returns:

subSet

public BiTreeSet<Q> subSet(Q fromElement,
                           Q toElement)

Specified by:

subSet in interface SortedSet<Q>

Specified by:

subSet 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>

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>

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>

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>