red_black_tree< T >::Iterator Class Reference

Iterator class. More...

#include <red_black_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
	red_black_tree (std::vector< T > _elements={}) noexcept
	Contructor for red black tree class.
	red_black_tree (const red_black_tree &rb)
	Copy constructor for red black tree class.
	~red_black_tree () noexcept
	Destructor for red black tree class.
red_black_tree< T > &	operator= (const red_black_tree< T > &rb)
	operator = for red black tree class
bool	operator== (const red_black_tree< T > &rb) const
	operator == for red black tree class
bool	search (T key)
	search function.
void	insert (T key)
	insert function.
void	remove (T key)
	remove function.
size_t	size () const
	size function
void	clear ()
	clear function
std::vector< T >	inorder () const
	inorder function.
std::vector< T >	postorder () const
	postorder function.
std::vector< T >	preorder () const
	preorder function.
std::vector< std::vector< T > >	level_order () const
	level order function
Iterator	begin ()
	pointer that points to begin
Iterator	end ()
	pointer that points to end

Friends
std::ostream &	operator<< (std::ostream &out, red_black_tree< T > &rb)
	operator << for red black tree class

Detailed Description

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

Iterator class.

Constructor & Destructor Documentation

Iterator()

template<typename T>

red_black_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

begin()

Iterator red_black_tree< T >::begin ( )

inline

pointer that points to begin

Returns

Iterator

end()

Iterator red_black_tree< T >::end ( )

inline

pointer that points to end

Returns

Iterator

inorder()

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

inline

inorder function.

Returns

vector<T>, the elements inorder.

insert()

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

inline

insert function.

Parameters

key	key to be inserted.

level_order()

std::vector< std::vector< T > > red_black_tree< T >::level_order ( ) const

inline

level order function

Returns

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

operator!=()

template<typename T>

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

inline

operator != for type Iterator

Parameters

it	const Iterator

Returns

true if index == it.index

false otherwise

operator*()

template<typename T>

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

inline

operator * for type Iterator

Returns

T the value of the node

operator++() [1/2]

template<typename T>

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

inline

operator ++ for type Iterator

Returns

Iterator&

operator++() [2/2]

template<typename T>

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

inline

operator ++ for type Iterator

Returns

Iterator

operator--() [1/2]

template<typename T>

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

inline

operator – for type Iterator

Returns

Iterator&

operator--() [2/2]

template<typename T>

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

inline

operator – for type Iterator

Returns

Iterator

operator=() [1/2]

red_black_tree< T > & red_black_tree< T >::operator= ( const red_black_tree< T > & rb )

inline

operator = for red black tree class

Parameters

rb	the tree we want to copy

Returns

red_black_tree&

operator=() [2/2]

template<typename T>

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

inline

= operator for Iterator type

Parameters

index

the current index

Returns

Iterator&

operator==()

bool red_black_tree< T >::operator== ( const red_black_tree< T > & rb ) const

inline

operator == for red black tree class

Parameters

rb	the tree we want to compare

Returns

true if they are same, false otherwise

postorder()

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

inline

postorder function.

Returns

vector<T>, the elements postorder.

preorder()

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

inline

preorder function.

Returns

vector<T>, the elements preorder.

red_black_tree() [1/2]

red_black_tree< T >::red_black_tree ( const red_black_tree & rb )

inlineexplicit

Copy constructor for red black tree class.

Parameters

rb	the tree we want to copy

red_black_tree() [2/2]

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

inlineexplicitnoexcept

Contructor for red black tree class.

Parameters

_elements

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

remove()

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

inline

remove function.

Parameters

key	key to be removed.

search()

bool red_black_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 red_black_tree< T >::size ( ) const

inline

size function

Returns

size_t the size of the tree

---

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

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