com.github.jtendermint.merkletree.iavl

Class AVLTree<K extends Comparable<K>>

java.lang.Object

com.github.jtendermint.merkletree.iavl.AVLTree<K>

public class AVLTree<K extends Comparable<K>>
extends Object

Self balancing binary search tree

Constructor Summary

Constructors

Constructor and Description
AVLTree(Hashing<K> hashalgorithm)

Method Summary

Modifier and Type	Method and Description
boolean	add(K entry) Add a new entry
boolean	contains(K entry) Check if an entry is already present
KeyIndex<K>	get(int index)
K	get(K entry)
HashWithCount	getHashWithCount()
int	getHeight()
Node<K>	getRoot()
byte[]	getRootHash()
IterateFunct.Loop	iterateNodes(IterateFunct<K> function) Iterate over every node.
int	size()
String	toPrettyString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AVLTree

public AVLTree(Hashing<K> hashalgorithm)

Method Detail

size

public int size()

Returns:

the tree size (elements in tree)

getHeight

public int getHeight()

Returns:

the tree-height

contains

public boolean contains(K entry)

Check if an entry is already present

Parameters:

entry - the non-null entry to lookup

Returns:

true if this entry exists in the tree

get

public K get(K entry)

Parameters:

entry - the non-null entry to get

Returns:

an entry from the tree, uses Object.equals(Object) for equality-checks

get

public KeyIndex<K> get(int index)

Parameters:

index - the index to get

Returns:

a KeyIndex representing the lookup result

add

public boolean add(K entry)

Add a new entry

Parameters:

entry - the non-null entry to add

Returns:

true if tree was updated, false if simple add possible

getHashWithCount

public HashWithCount getHashWithCount()

Returns:

the Root-Hash and the amount of hashes

getRootHash

public byte[] getRootHash()

Returns:

the root-hash. Maybe null

getRoot

public Node<K> getRoot()

Returns:

the Root-Node. Maybe null

toPrettyString

public String toPrettyString()

Returns:

a prettified representation of this tree for debugging: ((1 2) (3 4))

iterateNodes

public IterateFunct.Loop iterateNodes(IterateFunct<K> function)

Iterate over every node. check Leafnodes with node.isLeafNode()

Parameters:

function - the function to apply to each node while iterating

Returns:

Run.STOP when done