#include <ProxyContainer.h>

Inheritance diagram for Utils::ProxyIterator< Container, T_Derived, ElementProxy >:

Collaboration diagram for Utils::ProxyIterator< Container, T_Derived, ElementProxy >:

Classes
struct	diff_type_helper

Public Types
using	BASE = ProxyIteratorBase<Container,T_Derived, ElementProxy>
using	value_type = decltype( std::declval<BASE>().operator *())
using	difference_type
using	element_index_t = typename ElementProxy::index_t
using	index_t
using	ContainerNonConst
using	ContainerPtr

Public Member Functions
	ProxyIterator ()
ProxyIterator &	operator++ ()
ProxyIterator &	operator+= (std::size_t offset)
ProxyIterator	operator++ (int)
template<class OtherContainer> requires (std::is_same_v<typename BASE::ContainerNonConst, typename ProxyIteratorBase<OtherContainer, T_Derived, ElementProxy>::ContainerNonConst>)
bool	operator!= (const ProxyIteratorBase< OtherContainer, T_Derived, ElementProxy > &other) const
auto	operator* ()
template<class OtherContainer> requires (std::is_same_v<typename BASE::ContainerNonConst, typename ProxyIteratorBase<OtherContainer, T_Derived, ElementProxy>::ContainerNonConst>)
bool	operator== (const ProxyIteratorBase< OtherContainer, T_Derived, ElementProxy > &other) const
index_t	index () const
const ContainerNonConst &	container () const

Static Public Member Functions
static auto	createElementProxy (const BASE::ContainerNonConst *ptr, element_index_t &&element_index)
	Create a proxy for one element of the "container" this proxy represents (read-only access).
static auto	createElementProxy (const BASE::ContainerNonConst *ptr, element_index_t &&element_index)
	Create a proxy for one element of the "container" this proxy represents (read-only access).
static auto	createElementProxy (BASE::ContainerNonConst *ptr, element_index_t &&element_index)
	Create a proxy for one element of the "container" this proxy represents (read-write access).

Static Public Attributes
static constexpr bool	isConst

Protected Member Functions
const ContainerNonConst *	cptr () const

Protected Attributes
ContainerPtr	m_container
index_t	m_index

Detailed Description

template<class Container, class T_Derived, class ElementProxy>
struct Utils::ProxyIterator< Container, T_Derived, ElementProxy >

Definition at line 290 of file ProxyContainer.h.

Member Typedef Documentation

◆ BASE

template<class Container, class T_Derived, class ElementProxy>

using Utils::ProxyIterator< Container, T_Derived, ElementProxy >::BASE = ProxyIteratorBase<Container,T_Derived, ElementProxy>

Definition at line 292 of file ProxyContainer.h.

◆ ContainerNonConst

using Utils::ElementProxyBase< Container, ElementProxy::index_t >::ContainerNonConst

inherited

Definition at line 116 of file ProxyContainer.h.

◆ ContainerPtr

using Utils::ElementProxyBase< Container, ElementProxy::index_t >::ContainerPtr

inherited

Definition at line 117 of file ProxyContainer.h.

◆ difference_type

template<class Container, class T_Derived, class ElementProxy>

using Utils::ProxyIterator< Container, T_Derived, ElementProxy >::difference_type

Initial value:

decltype( diff_type_helper<typename BASE::element_index_t>::diff(std::declval<typename BASE::element_index_t>(),

std::declval<typename BASE::element_index_t>()) )

Utils::ProxyIterator::diff_type_helper::diff

static std::int64_t diff(const T &a, const T &b)

Definition ProxyContainer.h:329

Definition at line 344 of file ProxyContainer.h.

◆ element_index_t

template<class Container, class T_Derived, class ElementProxy>

using Utils::ProxyIteratorBase< Container, T_Derived, ElementProxy >::element_index_t = typename ElementProxy::index_t

inherited

Definition at line 213 of file ProxyContainer.h.

◆ index_t

using Utils::ElementProxyBase< Container, ElementProxy::index_t >::index_t

inherited

Definition at line 115 of file ProxyContainer.h.

◆ value_type

template<class Container, class T_Derived, class ElementProxy>

using Utils::ProxyIterator< Container, T_Derived, ElementProxy >::value_type = decltype( std::declval<BASE>().operator *())

Definition at line 322 of file ProxyContainer.h.

Constructor & Destructor Documentation

◆ ProxyIterator()

template<class Container, class T_Derived, class ElementProxy>

Utils::ProxyIterator< Container, T_Derived, ElementProxy >::ProxyIterator ( )

inline

Definition at line 296 of file ProxyContainer.h.

296: BASE(nullptr,typename BASE::element_index_t{}) {}

Utils::ProxyIterator

Definition ProxyContainer.h:290

Utils::ProxyIterator::BASE

ProxyIteratorBase< Container, T_Derived, ElementProxy > BASE

Definition ProxyContainer.h:292

Member Function Documentation

◆ container()

const ContainerNonConst & Utils::ElementProxyBase< Container, ElementProxy::index_t >::container ( ) const

inlineinherited

Returns: A const pointer of the container which contains the elements this proxy refers to. The value returned by index identifies the element within this container.

Definition at line 152 of file ProxyContainer.h.

153 { assert( m_container != nullptr); return *m_container; }

Utils::ElementProxyBase

Definition ProxyContainer.h:113

◆ cptr()

const ContainerNonConst * Utils::ElementProxyBase< Container, ElementProxy::index_t >::cptr ( ) const

inlineprotectedinherited

Definition at line 159 of file ProxyContainer.h.

                                         {
      return &container();
   }

◆ createElementProxy() [1/3]

template<class Container, class T_Derived, class ElementProxy>

auto Utils::ProxyIteratorBase< Container, T_Derived, ElementProxy >::createElementProxy	(	BASE::ContainerNonConst *	ptr,
		element_index_t &&	element_index )

inlinestaticinherited

Create a proxy for one element of the "container" this proxy represents (read-write access).

Parameters

ptr	A pointer to the container which contains the element data
element_index	An index which identifies the element in the given container.

Returns: A new proxy which represents the specified element.

Definition at line 274 of file ProxyContainer.h.

                              {
      if constexpr(hasCreateProxy<ElementProxy, decltype(ptr), element_index_t> ) {
         return ElementProxy::create(ptr, std::move(element_index));
      }
      else {
         return ElementProxy(ptr, std::move(element_index));
      }
   }

◆ createElementProxy() [2/3]

template<class Container, class T_Derived, class ElementProxy>

auto Utils::ProxyIteratorBase< Container, T_Derived, ElementProxy >::createElementProxy	(	const BASE::ContainerNonConst *	ptr,
		element_index_t &&	element_index )

inlinestaticinherited

Create a proxy for one element of the "container" this proxy represents (read-only access).

Parameters

ptr	A pointer to the container which contains the element data
element_index	An index which identifies the element in the given container.

Returns: A new proxy which represents the specified element. This method will be called if the element proxy provides a create method.

Note: to create a const element proxy from a non-const element proxy requires that the element proxy provides a create method which takes a const contaner as argument.

Definition at line 252 of file ProxyContainer.h.

   {
      return ElementProxy::create(ptr,std::move(element_index));
   }

◆ createElementProxy() [3/3]

template<class Container, class T_Derived, class ElementProxy>

auto Utils::ProxyIteratorBase< Container, T_Derived, ElementProxy >::createElementProxy	(	const BASE::ContainerNonConst *	ptr,
		element_index_t &&	element_index )

inlinestaticinherited

Create a proxy for one element of the "container" this proxy represents (read-only access).

Parameters

ptr	A pointer to the container which contains the element data
element_index	An index which identifies the element in the given container.

Returns: A new proxy which represents the specified element. This method will be called if the element proxy does not provide a create method. In this case the const-ness of the element proxy will be inherited from the parent proxy.

Definition at line 264 of file ProxyContainer.h.

   {
      return ElementProxy(ptr,std::move(element_index));
   }

◆ index()

index_t Utils::ElementProxyBase< Container, ElementProxy::index_t >::index ( ) const

inlineinherited

Parameters

Return the "index" which identifies the element this proxy refers to within the container returned by container. This may or may not be the index which was used to create this proxy from the parent proxy i.e. in auto child_proxy=parent_proxy[index] it may be that child_proxy.index() != index. To recover "index" use auto index_recover = ParentProxy::getOriginalElementIndex(child_proxy);

Definition at line 148 of file ProxyContainer.h.

148{ return m_index; }

◆ operator!=()

template<class Container, class T_Derived, class ElementProxy>

template<class OtherContainer>
requires (std::is_same_v<typename BASE::ContainerNonConst, typename ProxyIteratorBase<OtherContainer, T_Derived, ElementProxy>::ContainerNonConst>)

bool Utils::ProxyIterator< Container, T_Derived, ElementProxy >::operator!= ( const ProxyIteratorBase< OtherContainer, T_Derived, ElementProxy > & other ) const

inline

Definition at line 315 of file ProxyContainer.h.

   {
      return !(this->operator==(other));
   }

◆ operator*()

template<class Container, class T_Derived, class ElementProxy>

auto Utils::ProxyIteratorBase< Container, T_Derived, ElementProxy >::operator* ( )

inlineinherited

Definition at line 228 of file ProxyContainer.h.

   {
      return this->createElementProxy(this->m_container,
                                      typename BASE::index_t(this->m_index));
   }

◆ operator++() [1/2]

template<class Container, class T_Derived, class ElementProxy>

ProxyIterator & Utils::ProxyIterator< Container, T_Derived, ElementProxy >::operator++ ( )

inline

Definition at line 298 of file ProxyContainer.h.

                               {
      (void) BASE::operator++();
      return *this;
   }

◆ operator++() [2/2]

template<class Container, class T_Derived, class ElementProxy>

ProxyIterator Utils::ProxyIterator< Container, T_Derived, ElementProxy >::operator++ ( int )

inline

Definition at line 308 of file ProxyContainer.h.

                                 {
      ProxyIterator clone(*this);
      this->m_index = T_Derived::nextElementIndex(this->cptr(), std::move(this->m_index));
      return clone;
   }

◆ operator+=()

template<class Container, class T_Derived, class ElementProxy>

ProxyIterator & Utils::ProxyIterator< Container, T_Derived, ElementProxy >::operator+= ( std::size_t offset )

inline

Definition at line 302 of file ProxyContainer.h.

                                                                                                   {
      (void) BASE::operator+=(offset);
      return *this;
   }

◆ operator==()

template<class Container, class T_Derived, class ElementProxy>

template<class OtherContainer>
requires (std::is_same_v<typename BASE::ContainerNonConst, typename ProxyIteratorBase<OtherContainer, T_Derived, ElementProxy>::ContainerNonConst>)

bool Utils::ProxyIteratorBase< Container, T_Derived, ElementProxy >::operator== ( const ProxyIteratorBase< OtherContainer, T_Derived, ElementProxy > & other ) const

inlineinherited

Definition at line 237 of file ProxyContainer.h.

   {
      assert ( this->m_container == other.m_container);
      return this->m_index == other.m_index;
   }

Member Data Documentation

◆ isConst

bool Utils::ElementProxyBase< Container, ElementProxy::index_t >::isConst

staticconstexprinherited

Definition at line 114 of file ProxyContainer.h.

◆ m_container

ContainerPtr Utils::ElementProxyBase< Container, ElementProxy::index_t >::m_container

protectedinherited

Definition at line 162 of file ProxyContainer.h.

◆ m_index

index_t Utils::ElementProxyBase< Container, ElementProxy::index_t >::m_index

protectedinherited

Definition at line 163 of file ProxyContainer.h.

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

ProxyContainer.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BASE

◆ ContainerNonConst

◆ ContainerPtr

◆ difference_type

◆ element_index_t

◆ index_t

◆ value_type

Constructor & Destructor Documentation

◆ ProxyIterator()

Member Function Documentation

◆ container()

◆ cptr()

◆ createElementProxy() [1/3]

◆ createElementProxy() [2/3]

◆ createElementProxy() [3/3]

◆ index()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator==()

Member Data Documentation

◆ isConst

◆ m_container

◆ m_index