#include <BSTElement.h>

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

Detailed Description

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

This class can be used to create binary search tree elements, derived from BinTreeElement.

This class extends the BinTreeElement class by adding a "key" property to allow for use in a binary search tree implementation.

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

See also: There is a tutorial about Binary Search Trees : http://bridgesuncc.github.io/tutorials/BinarySearchTree.html

Author: Kalpathi Subramanian

Date: 6/18/15, 7/17/16, 7/12/19

Public Member Functions
	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())

virtual const string	getDStype () const override

K	getKey () const

void	setKey (const K &k)

virtual BSTElement *	getLeft () override

virtual const BSTElement *	getLeft () const override

void	setLeft (BSTElement *l)

virtual BSTElement *	getRight () override

virtual const BSTElement *	getRight () const override

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

Protected Member Functions
virtual const string	getElementRepresentation () const override

Protected Attributes
K	key = K()

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

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)

Constructor & Destructor Documentation

◆ BSTElement() [1/2]

template<typename K , typename E >

bridges::datastructure::BSTElement< K, E >::BSTElement	(	const K &	k,
		BSTElement< K, E > *	l,
		BSTElement< K, E > *	r,
		const E &	val = `E()`,
		const string &	lab = `string()`
	)

inline

Constructs a BSTElement with the provided value, label, key, left and right BSTElements. The defaults will be used if not provided.

Parameters

k	The key for ordering
l	The left BSTElement
r	The right BSTElement
val	The data to hold
lab	The label to show

◆ BSTElement() [2/2]

template<typename K , typename E >

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

inline

Constructs a BSTElement with the provided value, label, key, setting the left and right BSTElements 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

◆ getDStype()

template<typename K , typename E >

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

inlineoverridevirtual

Returns the data structure name

Returns: the data structure name

Reimplemented from bridges::datastructure::BinTreeElement< E >.

Reimplemented in bridges::datastructure::KdTreeElement< K, E >, and bridges::datastructure::AVLTreeElement< K, E >.

◆ getElementRepresentation()

template<typename K , typename E >

virtual const string bridges::datastructure::BSTElement< K, E >::getElementRepresentation ( ) const

inlineoverrideprotectedvirtual

Gets the JSON representation of this element

Reimplemented from bridges::datastructure::Element< E >.

Reimplemented in bridges::datastructure::KdTreeElement< K, E >.

◆ getKey()

template<typename K , typename E >

K bridges::datastructure::BSTElement< K, E >::getKey ( ) const

inline

Returns the key value

Returns: The key of this BSTElement

◆ getLeft() [1/2]

template<typename K , typename E >

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

inlineoverridevirtual

Return the left child

Returns: The left child

Reimplemented from bridges::datastructure::BinTreeElement< E >.

Reimplemented in bridges::datastructure::KdTreeElement< K, E >, and bridges::datastructure::AVLTreeElement< K, E >.

◆ getLeft() [2/2]

template<typename K , typename E >

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

inlineoverridevirtual

Return the left child - Constant version

Returns: The left child

Reimplemented from bridges::datastructure::BinTreeElement< E >.

Reimplemented in bridges::datastructure::KdTreeElement< K, E >, and bridges::datastructure::AVLTreeElement< K, E >.

◆ getRight() [1/2]

template<typename K , typename E >

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

inlineoverridevirtual

Return the right child

Returns: The right child

Reimplemented from bridges::datastructure::BinTreeElement< E >.

Reimplemented in bridges::datastructure::KdTreeElement< K, E >, and bridges::datastructure::AVLTreeElement< K, E >.

◆ getRight() [2/2]

template<typename K , typename E >

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

inlineoverridevirtual

Return the right child - Constant version

Returns: The right child

Reimplemented from bridges::datastructure::BinTreeElement< E >.

Reimplemented in bridges::datastructure::KdTreeElement< K, E >, and bridges::datastructure::AVLTreeElement< K, E >.

◆ setKey()

template<typename K , typename E >

void bridges::datastructure::BSTElement< K, E >::setKey ( const K & k )

inline

Set key to "k"

Parameters

k	The key of this BSTElement

◆ setLeft()

template<typename K , typename E >

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

inline

Sets left to "l"

Parameters

l	The left child

◆ setRight()

template<typename K , typename E >

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

inline

Sets right child to "r"

Parameters

r	The right BSTElement

Member Data Documentation

◆ key

template<typename K , typename E >

K bridges::datastructure::BSTElement< K, E >::key = K()

protected

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

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

Detailed Description

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ BSTElement() [1/2]

◆ BSTElement() [2/2]

Member Function Documentation

◆ getDStype()

◆ getElementRepresentation()

◆ getKey()

◆ getLeft() [1/2]

◆ getLeft() [2/2]

◆ getRight() [1/2]

◆ getRight() [2/2]

◆ setKey()

◆ setLeft()

◆ setRight()

Member Data Documentation

◆ key

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