Template for a double linked list iterator. More...

#include <cmsis-plus/utils/lists.h>

Public Types
Public Types
using	value_type = U
	Type of value "pointed to" by the iterator.

using	pointer = U *
	Type of pointer to object "pointed to" by the iterator.

using	reference = U &
	Type of reference to object "pointed to" by the iterator.

using	iterator_pointer = N *
	Type of reference to the iterator internal pointer.

using	difference_type = ptrdiff_t
	Type of pointer difference.

using	iterator_category = std::forward_iterator_tag
	Category of iterator.

Public Member Functions
Constructors & Destructor
constexpr	double_list_iterator ()

constexpr	double_list_iterator (iterator_pointer const node)

constexpr	double_list_iterator (reference element)

Operators
pointer	operator-> () const

reference	operator* () const

double_list_iterator &	operator++ ()

double_list_iterator	operator++ (int)

double_list_iterator &	operator-- ()

double_list_iterator	operator-- (int)

bool	operator== (const double_list_iterator &other) const

bool	operator!= (const double_list_iterator &other) const

Public Member Functions
pointer	get_pointer (void) const
	Get the object node from the intrusive node.

iterator_pointer	get_iterator_pointer () const

Protected Attributes
Private Member Variables
iterator_pointer	node_
	Pointer to intrusive node.

Detailed Description

template<typename T, typename N, T *N::* MP, typename U = T>
class os::utils::double_list_iterator< T, N, MP, U >

Template Parameters

T	Type of object returned by the iterator.
N	Type of intrusive node. Must have the public members prev & next.
MP	Name of the intrusive node member in object T.
U	Type stored in the list, derived from T.

This class provides an interface similar to std::list::iterator.

Definition at line 208 of file lists.h.

Member Typedef Documentation

◆ difference_type

template<typename T , typename N , T *N::* MP, typename U = T>

using os::utils::double_list_iterator< T, N, MP, U >::difference_type = ptrdiff_t

Definition at line 239 of file lists.h.

◆ iterator_category

template<typename T , typename N , T *N::* MP, typename U = T>

using os::utils::double_list_iterator< T, N, MP, U >::iterator_category = std::forward_iterator_tag

Definition at line 244 of file lists.h.

◆ iterator_pointer

template<typename T , typename N , T *N::* MP, typename U = T>

using os::utils::double_list_iterator< T, N, MP, U >::iterator_pointer = N*

Definition at line 234 of file lists.h.

◆ pointer

template<typename T , typename N , T *N::* MP, typename U = T>

using os::utils::double_list_iterator< T, N, MP, U >::pointer = U*

Definition at line 224 of file lists.h.

◆ reference

template<typename T , typename N , T *N::* MP, typename U = T>

using os::utils::double_list_iterator< T, N, MP, U >::reference = U&

Definition at line 229 of file lists.h.

◆ value_type

template<typename T , typename N , T *N::* MP, typename U = T>

using os::utils::double_list_iterator< T, N, MP, U >::value_type = U

Definition at line 219 of file lists.h.

Constructor & Destructor Documentation

◆ double_list_iterator() [1/3]

template<typename T , typename N , T *N::* MP, typename U >

constexpr os::utils::double_list_iterator< T, N, MP, U >::double_list_iterator

constexpr

Definition at line 872 of file lists.h.

        : node_{}
    {
    }

◆ double_list_iterator() [2/3]

template<typename T , typename N , T *N::* MP, typename U >

constexpr os::utils::double_list_iterator< T, N, MP, U >::double_list_iterator ( iterator_pointer const node )

explicitconstexpr

Definition at line 878 of file lists.h.

        : node_{ node }
    {
    }

◆ double_list_iterator() [3/3]

template<typename T , typename N , T *N::* MP, typename U >

constexpr os::utils::double_list_iterator< T, N, MP, U >::double_list_iterator ( reference element )

explicitconstexpr

Definition at line 885 of file lists.h.

        : node_{ &(element.*MP) }
    {
      static_assert (std::is_convertible<U, T>::value == true,
                     "U must be implicitly convertible to T!");
    }

Member Function Documentation

◆ get_iterator_pointer()

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U >::iterator_pointer os::utils::double_list_iterator< T, N, MP, U >::get_iterator_pointer

inline

Definition at line 967 of file lists.h.

    {
      return node_;
    }

◆ get_pointer()

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U >::pointer os::utils::double_list_iterator< T, N, MP, U >::get_pointer ( void ) const

inline

Returns: Pointer to object node.

Definition at line 960 of file lists.h.

    {
      return (node_->*MP);
    }

◆ operator!=()

template<typename T , typename N , T *N::* MP, typename U >

bool os::utils::double_list_iterator< T, N, MP, U >::operator!= ( const double_list_iterator< T, N, MP, U > & other ) const

inline

Definition at line 951 of file lists.h.

    {
      return node_ != other.node_;
    }

References os::utils::double_list_iterator< T, N, MP, U >::node_.

◆ operator*()

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U >::reference os::utils::double_list_iterator< T, N, MP, U >::operator*

inline

Definition at line 902 of file lists.h.

    {
      return *get_pointer ();
    }

◆ operator++() [1/2]

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U > & os::utils::double_list_iterator< T, N, MP, U >::operator++

inline

Definition at line 909 of file lists.h.

    {
      node_ = static_cast<N*> (node_->next ());
      return *this;
    }

◆ operator++() [2/2]

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U > os::utils::double_list_iterator< T, N, MP, U >::operator++ ( int )

inline

Definition at line 917 of file lists.h.

    {
      const auto tmp = *this;
      node_ = static_cast<iterator_pointer> (node_->next);
      return tmp;
    }

◆ operator--() [1/2]

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U > & os::utils::double_list_iterator< T, N, MP, U >::operator--

inline

Definition at line 926 of file lists.h.

    {
      node_ = static_cast<iterator_pointer> (node_->prev);
      return *this;
    }

◆ operator--() [2/2]

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U > os::utils::double_list_iterator< T, N, MP, U >::operator-- ( int )

Definition at line 934 of file lists.h.

    {
      const auto tmp = *this;
      node_ = static_cast<iterator_pointer> (node_->prev);
      return tmp;
    }

◆ operator->()

template<typename T , typename N , T *N::* MP, typename U >

double_list_iterator< T, N, MP, U >::pointer os::utils::double_list_iterator< T, N, MP, U >::operator->

inline

Definition at line 895 of file lists.h.

    {
      return get_pointer ();
    }

◆ operator==()

template<typename T , typename N , T *N::* MP, typename U >

bool os::utils::double_list_iterator< T, N, MP, U >::operator== ( const double_list_iterator< T, N, MP, U > & other ) const

inline

Definition at line 943 of file lists.h.

    {
      return node_ == other.node_;
    }

References os::utils::double_list_iterator< T, N, MP, U >::node_.

Member Data Documentation

◆ node_

template<typename T , typename N , T *N::* MP, typename U = T>

iterator_pointer os::utils::double_list_iterator< T, N, MP, U >::node_

protected

Definition at line 327 of file lists.h.

Referenced by os::utils::double_list_iterator< T, N, MP, U >::operator!=(), and os::utils::double_list_iterator< T, N, MP, U >::operator==().

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

lists.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ iterator_pointer

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ double_list_iterator() [1/3]

◆ double_list_iterator() [2/3]

◆ double_list_iterator() [3/3]

Member Function Documentation

◆ get_iterator_pointer()

◆ get_pointer()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator->()

◆ operator==()

Member Data Documentation

◆ node_