circular_linked_list< T >::Iterator Class Reference

Iterator class. More...

#include <circular_linked_list.h>

Public Member Functions
	Iterator (const std::shared_ptr< node > &l) noexcept
	Construct a new Iterator object.
Iterator &	operator= (std::shared_ptr< node > current)
	= operator for Iterator type
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
	circular_linked_list (std::vector< T > _elements={}) noexcept
	Construct a new circular linked list object.
	circular_linked_list (const circular_linked_list &c)
	copy constructor for the circular linked list class
circular_linked_list &	operator= (const circular_linked_list &c)
	operator = for circular linked list class
bool	empty ()
	empty function
size_t	size ()
	size function
Iterator	begin ()
	pointer that points to begin
Iterator	end ()
	pointer that points to end
void	push_back (T key)
	push_back function
void	push_front (T key)
	push_front function
void	erase (T key)
	erase function
bool	search (T key)
	search function
std::vector< T >	elements ()
	elements function
void	visualize ()
	visualize function returns a .dot file that can be previewd with graphviz plugin in vscode

Friends
std::ostream &	operator<< (std::ostream &out, circular_linked_list< T > &l1)
	<< operator for the circular list class

Detailed Description

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

Iterator class.

Constructor & Destructor Documentation

Iterator()

template<typename T>

circular_linked_list< T >::Iterator::Iterator ( const std::shared_ptr< node > & l )

inlineexplicitnoexcept

Construct a new Iterator object.

Parameters

l	linked list type

Member Function Documentation

begin()

Iterator circular_linked_list< T >::begin ( )

inline

pointer that points to begin

Returns

Iterator

circular_linked_list() [1/2]

circular_linked_list< T >::circular_linked_list ( const circular_linked_list & c )

inlineexplicit

copy constructor for the circular linked list class

Parameters

c	the list we want to copy

circular_linked_list() [2/2]

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

inlineexplicitnoexcept

Construct a new circular linked list object.

Parameters

__elements

vector<T> so you dont have to do multiple insertions

elements()

std::vector< T > circular_linked_list< T >::elements ( )

inline

elements function

Returns

std::vector<T> the elements of the list

empty()

bool circular_linked_list< T >::empty ( )

inline

empty function

Returns

true if the list is empty

false otherwise

end()

Iterator circular_linked_list< T >::end ( )

inline

pointer that points to end

Returns

Iterator

erase()

void circular_linked_list< T >::erase ( T key )

inline

erase function

Parameters

key	the key to be erased

operator!=()

template<typename T>

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

inline

operator != for type Iterator

Parameters

it	const Iterator

Returns

true if curr_root == it.curr_root

false otherwise

operator*()

template<typename T>

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

inline

operator * for type Iterator

Returns

T the value of the node

operator++() [1/2]

template<typename T>

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

inline

operator ++ for type Iterator

Returns

Iterator&

operator++() [2/2]

template<typename T>

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

inline

operator ++ for type Iterator

Returns

Iterator

operator=() [1/2]

circular_linked_list & circular_linked_list< T >::operator= ( const circular_linked_list & c )

inline

operator = for circular linked list class

Parameters

c	the list we want to copy

Returns

circular_linked_list&

operator=() [2/2]

template<typename T>

Iterator & circular_linked_list< T >::Iterator::operator= ( std::shared_ptr< node > current )

inline

= operator for Iterator type

Parameters

current

smart pointer of type node

Returns

Iterator&

push_back()

void circular_linked_list< T >::push_back ( T key )

inline

push_back function

Parameters

key	the key to be inserted

push_front()

void circular_linked_list< T >::push_front ( T key )

inline

push_front function

Parameters

key	the key to be inserted

search()

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

inline

search function

Parameters

key	the key to be searched

Returns

true if the key exist in the list

false otherwise

size()

size_t circular_linked_list< T >::size ( )

inline

size function

Returns

size_t the size of the list

---

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

• /Users/runner/work/AlgoPlus/AlgoPlus/src/classes/list/circular_linked_list.h