#include <AVLTreeElement.h>

Inheritance diagram for bridges::datastructure::AVLTreeElement< K, E >:

Detailed Description

template<typename K, typename E>
class bridges::datastructure::AVLTreeElement< K, E >

This class can be used to create avl tree elements, derived from BSTElement.

This class extends the BSTElement class by adding height and balance factor attributes to allow for easier use in a avl tree implementation.

Generic Parameters: K that is the search key type, E the application data type

Author: Kalpathi Subramanian

Date: 6/18/15, 7/15/16

There is a tutorial about AVLs : https://bridgesuncc.github.io/tutorials/AVL.html

Public Member Functions
	AVLTreeElement (const K &k, const E &val=E(), const string &lab=string())

virtual const string	getDStype () const override

int	getHeight () const

void	setHeight (const int &h)

int	getBalanceFactor () const

void	setBalanceFactor (const int &bf)

virtual AVLTreeElement *	getLeft () override

virtual const AVLTreeElement *	getLeft () const override

void	setLeft (AVLTreeElement *l)

virtual AVLTreeElement *	getRight () override

virtual const AVLTreeElement *	getRight () const override

void	setRight (AVLTreeElement *r)

Public Member Functions inherited from bridges::datastructure::BSTElement< K, E >
	BSTElement (const K &k, BSTElement l, BSTElement r, const E &val=E(), const string &lab=string())

	BSTElement (const K &k, const E &val=E(), const string &lab=string())

K	getKey () const

void	setKey (const K &k)

void	setLeft (BSTElement *l)

void	setRight (BSTElement *r)

Public Member Functions inherited from bridges::datastructure::BinTreeElement< E >
	BinTreeElement (BinTreeElement l, BinTreeElement r, const E &e=E(), const string &lab=string())

	BinTreeElement (const E &e=E(), const string &lab=string())

void	setLeft (BinTreeElement *l)

void	setRight (BinTreeElement *r)

Public Member Functions inherited from bridges::datastructure::TreeElement< E >
	TreeElement (const E &e=E(), const string &lab=string())
	Construct a TreeElement from given values. More...

vector< TreeElement * > &	getChildren ()
	Get the children of this node. More...

const vector< TreeElement * > &	getChildren () const
	Get the children of this node. More...

TreeElement *	getChild (const int &n)
	Gets the nth child of this node. More...

const TreeElement *	getChild (const int &n) const
	Gets the nth child of this node - constant version. More...

void	addChild (TreeElement *child)
	Adds a child to children. More...

void	setChild (const size_t &index, TreeElement *kid)
	Sets child at index to "kid". More...

Public Member Functions inherited from bridges::datastructure::Element< E >
	Element (const E &val=E(), const string &lab=string())

	Element (const Element &e)

Element &	operator= (const Element &e)

E &	operator= (E const &e)

virtual	~Element ()

ElementVisualizer *	getVisualizer ()
	Get the element visualizer object. More...

const ElementVisualizer *	getVisualizer () const
	Get the element visualizer object - constant version. More...

LinkVisualizer *	getLinkVisualizer (const Element *el)
	Returns the LinkVisualizer of element. More...

LinkVisualizer *	getLinkVisualizer (const Element *el) const
	Returns the LinkVisualizer of element. More...

string const &	getLabel () const
	Gets the label of this element. More...

void	setLabel (const string &lab)
	Sets label of this element. More...

E const &	getValue () const
	Gets the object held in the generic object E. More...

E &	getValue ()
	Gets the object held in the generic object E. More...

void	setValue (const E &val)
	Sets generic object to "val". More...

void	setSize (const double &sz)
	Sets size of the element. More...

double	getSize () const
	Get element size. More...

void	setColor (const Color &col)
	Set the color of the Element. More...

void	setColor (const string col)
	Set the color by name. More...

Color	getColor () const
	Get the current color of the element. More...

void	setOpacity (double opacity)
	Set opacity of element - use the 4th color component. More...

double	getOpacity ()

void	setShape (const Shape &shp)
	Set the shape of the element. More...

Shape	getShape () const
	Returns the shape of the element. More...

void	setLocation (const double &locX, const double &locY)
	Sets the location attributes of an element. More...

double	getLocationX () const
	Gets the X coordinate of the location. More...

double	getLocationY () const
	Gets the Y coordinate of the location. More...

Public Member Functions inherited from bridges::datastructure::DataStructure
virtual	~DataStructure ()=default

Additional Inherited Members
Static Protected Member Functions inherited from bridges::datastructure::Element< E >
static const string	getLinkRepresentation (const LinkVisualizer &lv, const string &src, const string &dest)

Protected Attributes inherited from bridges::datastructure::BSTElement< K, E >
K	key = K()

Protected Attributes inherited from bridges::datastructure::Element< E >
unordered_map< Element *, LinkVisualizer >	links

Constructor & Destructor Documentation

◆ AVLTreeElement()

template<typename K , typename E >

bridges::datastructure::AVLTreeElement< K, E >::AVLTreeElement	(	const K &	k,
		const E &	val = `E()`,
		const string &	lab = `string()`
	)

inline

Constructs a AVLTreeElement with the provided value, label, key, setting the left and right AVLTreeElements to NULL. The defaults will be used if not provided.

Parameters

k	The key for ordering
val	The data to hold
lab	The label to show

Member Function Documentation

◆ getBalanceFactor()

template<typename K , typename E >

int bridges::datastructure::AVLTreeElement< K, E >::getBalanceFactor ( ) const

inline

Get balance factor of this node

Returns: The balance factor of this AVLTreeElement

◆ getDStype()

template<typename K , typename E >

virtual const string bridges::datastructure::AVLTreeElement< K, E >::getDStype ( ) const

inlineoverridevirtual

Return the data structure name

Returns: the data structure type

Reimplemented from bridges::datastructure::BSTElement< K, E >.

◆ getHeight()

template<typename K , typename E >

int bridges::datastructure::AVLTreeElement< K, E >::getHeight ( ) const

inline

Get the height of the tree

Returns: The height of this AVLTreeElement

◆ getLeft() [1/2]

template<typename K , typename E >

virtual const AVLTreeElement* bridges::datastructure::AVLTreeElement< K, E >::getLeft ( ) const

inlineoverridevirtual

Gets the left child - Constant version

Returns: The left child

Reimplemented from bridges::datastructure::BSTElement< K, E >.

◆ getLeft() [2/2]

template<typename K , typename E >

virtual AVLTreeElement* bridges::datastructure::AVLTreeElement< K, E >::getLeft ( )

inlineoverridevirtual

Gets the left child

Returns: The left child

Reimplemented from bridges::datastructure::BSTElement< K, E >.

◆ getRight() [1/2]

template<typename K , typename E >

virtual const AVLTreeElement* bridges::datastructure::AVLTreeElement< K, E >::getRight ( ) const

inlineoverridevirtual

Return the right child - Constant version

Returns: The right child

Reimplemented from bridges::datastructure::BSTElement< K, E >.

◆ getRight() [2/2]

template<typename K , typename E >

virtual AVLTreeElement* bridges::datastructure::AVLTreeElement< K, E >::getRight ( )

inlineoverridevirtual

Return the right child

Returns: The right child

Reimplemented from bridges::datastructure::BSTElement< K, E >.

◆ setBalanceFactor()

template<typename K , typename E >

void bridges::datastructure::AVLTreeElement< K, E >::setBalanceFactor ( const int & bf )

inline

Set the balance factor of this node

Parameters

bf	the balance factor to set at this node

◆ setHeight()

template<typename K , typename E >

void bridges::datastructure::AVLTreeElement< K, E >::setHeight ( const int & h )

inline

Set the height to "h"

Parameters

h	the height of the tree at this node

◆ setLeft()

template<typename K , typename E >

void bridges::datastructure::AVLTreeElement< K, E >::setLeft ( AVLTreeElement< K, E > * l )

inline

Sets left child to "l"

Parameters

l	The left tree element

◆ setRight()

template<typename K , typename E >

void bridges::datastructure::AVLTreeElement< K, E >::setRight ( AVLTreeElement< K, E > * r )

inline

Sets right child to "r"

Parameters

r	The right BSTElement

The documentation for this class was generated from the following file:

/home/erik/work/bridges/bridges-cxx/src/AVLTreeElement.h

Detailed Description

template<typename K, typename E> class bridges::datastructure::AVLTreeElement< K, E >

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ AVLTreeElement()

Member Function Documentation

◆ getBalanceFactor()

◆ getDStype()

◆ getHeight()

◆ getLeft() [1/2]

◆ getLeft() [2/2]

◆ getRight() [1/2]

◆ getRight() [2/2]

◆ setBalanceFactor()

◆ setHeight()

◆ setLeft()

◆ setRight()

template<typename K, typename E>
class bridges::datastructure::AVLTreeElement< K, E >