AlgoPlus v0.1.0
Loading...
Searching...
No Matches
dequeue_list< T >::Iterator Class Reference

Iterator class. More...

#include <dequeue_list.h>

Public Member Functions

 Iterator (const std::shared_ptr< node > &q) noexcept
 Construct a new Iterator object.
 
Iteratoroperator= (std::shared_ptr< node > current)
 = operator for Iterator type
 
Iteratoroperator++ ()
 operator ++ for type Iterator
 
Iterator operator++ (int)
 operator ++ for type Iterator
 
bool operator!= (const Iterator &it)
 operator != for type Iterator
 
operator* ()
 operator * for type Iterator
 
 dequeue_list (std::vector< T > v={}) noexcept
 Construct a new dequeue list object.
 
 dequeue_list (const dequeue_list &q)
 Copy constructor for dequeue list class.
 
dequeue_listoperator= (const dequeue_list &q)
 operator = for dequeue list class
 
void clear ()
 clear function
 
size_t size ()
 size functon
 
void push_back (T key)
 push_back function
 
void push_front (T key)
 push_front function
 
front ()
 top function
 
back ()
 back function
 
void pop_front ()
 pop_front function removes the front from the dequeue
 
void pop_back ()
 pop_back function removes the back from the queue
 
Iterator begin ()
 pointer to the front of the dequeue
 
Iterator end ()
 pointer to the end of the dequeue
 

Detailed Description

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

Iterator class.

Constructor & Destructor Documentation

◆ Iterator()

template<typename T>
dequeue_list< T >::Iterator::Iterator ( const std::shared_ptr< node > & q)
inlineexplicitnoexcept

Construct a new Iterator object.

Parameters
qdequeue_list pointer

Member Function Documentation

◆ back()

T dequeue_list< T >::back ( )
inline

back function

Returns
T the back of the dequeue

◆ begin()

Iterator dequeue_list< T >::begin ( )
inline

pointer to the front of the dequeue

Returns
Iterator

◆ dequeue_list() [1/2]

dequeue_list< T >::dequeue_list ( const dequeue_list & q)
inlineexplicit

Copy constructor for dequeue list class.

Parameters
qthe dequeue we want to copy

◆ dequeue_list() [2/2]

dequeue_list< T >::dequeue_list ( std::vector< T > v = {})
inlineexplicitnoexcept

Construct a new dequeue list object.

Parameters
vinitializer vector

◆ end()

Iterator dequeue_list< T >::end ( )
inline

pointer to the end of the dequeue

Returns
Iterator

◆ front()

T dequeue_list< T >::front ( )
inline

top function

Returns
T the top of the dequeue

◆ operator!=()

template<typename T>
bool dequeue_list< T >::Iterator::operator!= ( const Iterator & it)
inline

operator != for type Iterator

Parameters
itconst Iterator
Returns
true if curr_root == it.curr_root
false otherwise

◆ operator*()

template<typename T>
T dequeue_list< T >::Iterator::operator* ( )
inline

operator * for type Iterator

Returns
T the value of the node

◆ operator++() [1/2]

template<typename T>
Iterator & dequeue_list< T >::Iterator::operator++ ( )
inline

operator ++ for type Iterator

Returns
Iterator&

◆ operator++() [2/2]

template<typename T>
Iterator dequeue_list< T >::Iterator::operator++ ( int )
inline

operator ++ for type Iterator

Returns
Iterator

◆ operator=() [1/2]

dequeue_list & dequeue_list< T >::operator= ( const dequeue_list & q)
inline

operator = for dequeue list class

Parameters
qthe dequeue we want to copy
Returns
dequeue_list&

◆ operator=() [2/2]

template<typename T>
Iterator & dequeue_list< T >::Iterator::operator= ( std::shared_ptr< node > current)
inline

= operator for Iterator type

Parameters
currentsmart pointer of type node
Returns
Iterator&

◆ push_back()

void dequeue_list< T >::push_back ( T key)
inline

push_back function

Parameters
keythe key to be pushed back

◆ push_front()

void dequeue_list< T >::push_front ( T key)
inline

push_front function

Parameters
keythe key to be pushed front

◆ size()

size_t dequeue_list< T >::size ( )
inline

size functon

Returns
size_t the size of the stack

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