Implements ForwardListIterator. More...

#include <forward_list.h>

Public Types
using	iterator_type = std::conditional_t<IF_CONST, const T, T>
	Alias for iterator type.
using	iterator_category = std::forward_iterator_tag
	Alias for forward iterator tag, define iterator direction.
using	difference_type = std::ptrdiff_t
	Alias for pointer difference type.
using	value_type = T
	Alias for data type used by iterator.
using	size_type = std::size_t
	Alias for size type used in class.
using	pointer = iterator_type*
	Alias for pointer to data type used by iterator.
using	reference = iterator_type&
	Alias for reference to type used by iterator.

Public Member Functions
	ForwardListIterator () noexcept=default
	Construct a new ForwardListIterator object.
	ForwardListIterator (NodeBase *node) noexcept
	Construct a new ForwardListIterator object.
auto	operator= (NodeBase *node) -> ForwardListIterator &
	Overload operator= to assign `node` to currently pointed ForwardListIterator.
auto	operator++ () -> ForwardListIterator &
	Overload pre-increment operator++ to point ForwardListIterator at next Node.
auto	operator++ (int) -> ForwardListIterator
	Overload post-increment operator++ to point ForwardListIterator at next Node.
auto	operator== (const ForwardListIterator< IF_CONST > &other) const -> bool
	Overload operator!= for ForwardListIterator objects comparison.
auto	operator!= (const ForwardListIterator< IF_CONST > &other) const -> bool
	Overload operator!= for ForwardListIterator objects comparison.
auto	operator* () const -> reference
	Overload operator* to dereference Node value / data.
auto	operator-> () -> pointer
	Overload operator-> to get pointer to Node value / data.
	operator ForwardListIterator< true > ()
	convert ForwardListIterator to Basic_Const_Iterator

Friends
class	ForwardList
	Forward friend declaration of ForwardList.

Detailed Description

template<typename T>
template<bool IF_CONST>
class dsa::ForwardList< T >::ForwardListIterator< IF_CONST >

Implements ForwardListIterator.

Class is used to generate iterator and const_iterator types. Template variable IF_CONST control whether reference or const reference is returned to underlying data type

Template Parameters

IF_CONST if true generate iterator with const reference to underlying data type

Definition at line 167 of file forward_list.h.

Member Typedef Documentation

◆ difference_type

template<typename T>

template<bool IF_CONST>

using dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::difference_type = std::ptrdiff_t

Alias for pointer difference type.

Used by STL to define distance between two pointers

Definition at line 192 of file forward_list.h.

◆ iterator_category

template<typename T>

template<bool IF_CONST>

using dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::iterator_category = std::forward_iterator_tag

Alias for forward iterator tag, define iterator direction.

Used by STL to define iterator features. Forward iterator allows iteration only in forward direction.

Definition at line 185 of file forward_list.h.

◆ iterator_type

template<typename T>

template<bool IF_CONST>

using dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::iterator_type = std::conditional_t<IF_CONST, const T, T>

Alias for iterator type.

Template Parameters

IF_CONST	if `true` generate iterator with const reference to underlying data type
T	data type

Definition at line 177 of file forward_list.h.

◆ pointer

template<typename T>

template<bool IF_CONST>

using dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::pointer = iterator_type*

Alias for pointer to data type used by iterator.

Template Parameters

T*	pointer to data type

Definition at line 213 of file forward_list.h.

◆ reference

template<typename T>

template<bool IF_CONST>

using dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::reference = iterator_type&

Alias for reference to type used by iterator.

Definition at line 218 of file forward_list.h.

◆ size_type

template<typename T>

template<bool IF_CONST>

using dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::size_type = std::size_t

Alias for size type used in class.

Template Parameters

T size type

Definition at line 206 of file forward_list.h.

◆ value_type

template<typename T>

template<bool IF_CONST>

using dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::value_type = T

Alias for data type used by iterator.

Template Parameters

T	iterated element type

Definition at line 199 of file forward_list.h.

Constructor & Destructor Documentation

◆ ForwardListIterator()

template<typename T>

template<bool IF_CONST>

dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::ForwardListIterator ( NodeBase * node )

inlinenoexcept

Construct a new ForwardListIterator object.

Parameters

[in] node input Node

Definition at line 230 of file forward_list.h.

231 : m_current_node{ node }

232 {}

dsa::ForwardList

Implements ForwardList using Node with pointer to next element as internal base.

Definition forward_list.h:39

Member Function Documentation

◆ operator ForwardListIterator< true >()

template<typename T>

template<bool IF_CONST>

dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator ForwardListIterator< true > ( )

inline

convert ForwardListIterator to Basic_Const_Iterator

Definition at line 330 of file forward_list.h.

            {
                return ForwardListIterator<true>(m_current_node);
            }

◆ operator!=()

template<typename T>

template<bool IF_CONST>

auto dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator!= ( const ForwardListIterator< IF_CONST > & other ) const -> bool

inline

Overload operator!= for ForwardListIterator objects comparison.

Parameters

[in] other input ForwardListIterator of other object

Returns: bool comparison result

Return values

true	if ForwardListIterator objects are different
false	if ForwardListIterator objects are the same

Definition at line 294 of file forward_list.h.

            {
                return !operator==(other);
            }

◆ operator*()

template<typename T>

template<bool IF_CONST>

auto dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator* ( ) const -> reference

inline

Overload operator* to dereference Node value / data.

Returns: T& reference or const reference to data stored in Node

Definition at line 304 of file forward_list.h.

            {
                if (Node* node = dynamic_cast<Node*>(m_current_node))
                {
                    return node->value();
                }
                throw std::runtime_error("Invalid iterator dereference");
            }

◆ operator++() [1/2]

template<typename T>

template<bool IF_CONST>

auto dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator++ ( ) -> ForwardListIterator&

inline

Overload pre-increment operator++ to point ForwardListIterator at next Node.

Returns: ForwardListIterator& reference to next Node

Definition at line 251 of file forward_list.h.

            {
                if (m_current_node)
                {
                    m_current_node = m_current_node->m_next;
                }
 
                return *this;
            }

◆ operator++() [2/2]

template<typename T>

template<bool IF_CONST>

auto dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator++ ( int ) -> ForwardListIterator

inline

Overload post-increment operator++ to point ForwardListIterator at next Node.

Returns: ForwardListIterator& reference to next ForwardListIterator

Definition at line 266 of file forward_list.h.

            {
                const ForwardListIterator iterator = *this;
                ++(*this);
                return iterator;
            }

◆ operator->()

template<typename T>

template<bool IF_CONST>

auto dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator-> ( ) -> pointer

inline

Overload operator-> to get pointer to Node value / data.

Returns: T* pointer to data stored in Node

Definition at line 318 of file forward_list.h.

            {
                if (Node* node = dynamic_cast<Node*>(m_current_node))
                {
                    return &node->value();
                }
                throw std::runtime_error("Invalid iterator pointer");
            }

◆ operator=()

template<typename T>

template<bool IF_CONST>

auto dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator= ( NodeBase * node ) -> ForwardListIterator&

inline

Overload operator= to assign node to currently pointed ForwardListIterator.

Parameters

[in] node input Node

Returns: ForwardListIterator& reference to updated Node

Definition at line 240 of file forward_list.h.

            {
                this->m_current_node = node;
                return *this;
            }

◆ operator==()

template<typename T>

template<bool IF_CONST>

auto dsa::ForwardList< T >::ForwardListIterator< IF_CONST >::operator== ( const ForwardListIterator< IF_CONST > & other ) const -> bool

inline

Overload operator!= for ForwardListIterator objects comparison.

Parameters

[in] other input ForwardListIterator of other object

Returns: bool comparison result

Return values

true	if ForwardListIterator objects are the same
false	if ForwardListIterator objects are different

Definition at line 281 of file forward_list.h.

            {
                return m_current_node == other.m_current_node;
            }

◆ ForwardList

template<typename T>

template<bool IF_CONST>

friend class ForwardList

friend

Forward friend declaration of ForwardList.

Definition at line 340 of file forward_list.h.

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

include/dsa/forward_list.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ iterator_type

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ ForwardListIterator()

Member Function Documentation

◆ operator ForwardListIterator< true >()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator->()

◆ operator=()

◆ operator==()

Friends And Related Symbol Documentation

◆ ForwardList