avl_tree< T >::Iterator Class Reference

Iterator class. More...

#include <avl_tree.h>

Public Member Functions
	Iterator (const int64_t &index, std::vector< T > &els) noexcept
	Construct a new Iterator object.
Iterator &	operator= (int64_t index)
	= operator for Iterator type
Iterator &	operator++ ()
	operator ++ for type Iterator
Iterator	operator++ (int)
	operator ++ for type Iterator
Iterator &	operator-- ()
	operator – for type Iterator
Iterator	operator-- (int)
	operator – for type Iterator
bool	operator!= (const Iterator &it)
	operator != for type Iterator
T	operator* ()
	operator * for type Iterator
	avl_tree (std::vector< T > _elements={}) noexcept
	Contructor for AVL tree class.
	avl_tree (const avl_tree &a)
	Copy constructor for avl tree class.
avl_tree &	operator= (const avl_tree &a)
	operator = for avl tree class
	~avl_tree () noexcept
	Destroy the avl tree object.
void	insert (T key)
	insert function.
void	clear ()
	clear function Erase all the nodes from the tree.
T	get_root ()
	get_root function
bool	search (T key)
	search function.
Iterator	begin ()
	pointer that points to begin
Iterator	end ()
	pointer that points to end
size_t	size () const
	size function
void	remove (T key)
	remove function.
std::vector< T >	inorder () const
	inorder function.
std::vector< T >	preorder () const
	preorder function.
std::vector< T >	postorder () const
	postorder function.
std::vector< std::vector< T > >	level_order ()
	level order function.

Friends
std::ostream &	operator<< (std::ostream &out, avl_tree< T > &t)
	visualize function

Detailed Description

template<typename T>
class avl_tree< T >::Iterator

Iterator class.

Constructor & Destructor Documentation

Iterator()

template<typename T>

avl_tree< T >::Iterator::Iterator ( const int64_t & index, std::vector< T > & els )

inlineexplicitnoexcept

Construct a new Iterator object.

Parameters

els	vector<T> - the elements in inorder fashion

Member Function Documentation

avl_tree() [1/2]

avl_tree< T >::avl_tree ( const avl_tree & a )

inlineexplicit

Copy constructor for avl tree class.

Parameters

a	the tree we want to copy

avl_tree() [2/2]

avl_tree< T >::avl_tree ( std::vector< T > _elements = {} )

inlineexplicitnoexcept

Contructor for AVL tree class.

Parameters

__elements

you can directly pass a vector<T> so you don't have to do insert multiple times.

begin()

Iterator avl_tree< T >::begin ( )

inline

pointer that points to begin

Returns

Iterator

end()

Iterator avl_tree< T >::end ( )

inline

pointer that points to end

Returns

Iterator

get_root()

T avl_tree< T >::get_root ( )

inline

get_root function

Returns

T: the root value Created for bubble.h container

inorder()

std::vector< T > avl_tree< T >::inorder ( ) const

inline

inorder function.

Returns

vector<T>, the elements inorder.

insert()

void avl_tree< T >::insert ( T key )

inline

insert function.

Parameters

key	key to be inserted.

level_order()

std::vector< std::vector< T > > avl_tree< T >::level_order ( )

inline

level order function.

Returns

vector<T>, the level order traversal of the tree

operator!=()

template<typename T>

bool avl_tree< T >::Iterator::operator!= ( const Iterator & it )

inline

operator != for type Iterator

Parameters

it	const Iterator

Returns

true if the current element that exist in the index is not equal to the it.element that exist in the it.index

false otherwise

operator*()

template<typename T>

T avl_tree< T >::Iterator::operator* ( )

inline

operator * for type Iterator

Returns

T the value of the node

operator++() [1/2]

template<typename T>

Iterator & avl_tree< T >::Iterator::operator++ ( )

inline

operator ++ for type Iterator

Returns

Iterator&

operator++() [2/2]

template<typename T>

Iterator avl_tree< T >::Iterator::operator++ ( int )

inline

operator ++ for type Iterator

Returns

Iterator

operator--() [1/2]

template<typename T>

Iterator & avl_tree< T >::Iterator::operator-- ( )

inline

operator – for type Iterator

Returns

Iterator&

operator--() [2/2]

template<typename T>

Iterator avl_tree< T >::Iterator::operator-- ( int )

inline

operator – for type Iterator

Returns

Iterator

operator=() [1/2]

avl_tree & avl_tree< T >::operator= ( const avl_tree & a )

inline

operator = for avl tree class

Parameters

a	the tree we want to copy

Returns

avl_tree&

operator=() [2/2]

template<typename T>

Iterator & avl_tree< T >::Iterator::operator= ( int64_t index )

inline

= operator for Iterator type

Parameters

index

the current index

Returns

Iterator&

postorder()

std::vector< T > avl_tree< T >::postorder ( ) const

inline

postorder function.

Returns

vector<T>, the elements postorder.

preorder()

std::vector< T > avl_tree< T >::preorder ( ) const

inline

preorder function.

Returns

vector<T>, the elements preorder.

remove()

void avl_tree< T >::remove ( T key )

inline

remove function.

Parameters

key	key to be removed.

search()

bool avl_tree< T >::search ( T key )

inline

search function.

Parameters

key	key to be searched.

Returns

true if the key exists in the tree.

size()

size_t avl_tree< T >::size ( ) const

inline

size function

Returns

size_t the size of the tree

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, avl_tree< T > & t )

friend

visualize function

Returns

.dot file that can be previewed using graphviz in vscode.

operator << for avl_tree class

---

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

• /Users/runner/work/AlgoPlus/AlgoPlus/src/classes/tree/avl_tree.h