ConstBiDirectionalIterator allows to loop over the element of one dimensional list containers. More...

#include <STK_BiDirectionalIterator.h>

Inheritance diagram for STK::ConstBiDirectionalIterator< Array >:

Public Types
enum	{ structure_ = hidden::IteratorTraits< ConstBiDirectionalIterator >::structure_ , orient_ = hidden::IteratorTraits< ConstBiDirectionalIterator >::orient_ , sizeCols_ = hidden::IteratorTraits< ConstBiDirectionalIterator >::sizeCols_ , sizeRows_ = hidden::IteratorTraits< ConstBiDirectionalIterator >::sizeRows_ , size_ = hidden::IteratorTraits< ConstBiDirectionalIterator >::size_ , storage_ = hidden::IteratorTraits< ConstBiDirectionalIterator >::storage_ }

typedef DenseIteratorBase< ConstBiDirectionalIterator >	Base

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::Index	Index

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::Type	Type

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::TypeConst	TypeConst

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::RowRange	RowRange

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::ColRange	ColRange

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::iterator_category	iterator_category

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::value_type	value_type

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::reference	reference

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::pointer	pointer

typedef hidden::IteratorTraits< ConstBiDirectionalIterator >::difference_type	difference_type

Public Types inherited from STK::DenseIteratorBase< ConstBiDirectionalIterator< Array > >
typedef hidden::IteratorTraits< ConstBiDirectionalIterator< Array > >::Index	Index

typedef hidden::IteratorTraits< ConstBiDirectionalIterator< Array > >::iterator_category	iterator_category

typedef hidden::IteratorTraits< ConstBiDirectionalIterator< Array > >::value_type	value_type

typedef hidden::IteratorTraits< ConstBiDirectionalIterator< Array > >::reference	reference

typedef hidden::IteratorTraits< ConstBiDirectionalIterator< Array > >::pointer	pointer

typedef hidden::IteratorTraits< ConstBiDirectionalIterator< Array > >::difference_type	difference_type

Public Member Functions
	ConstBiDirectionalIterator (Array const &list1D, int pos)

	ConstBiDirectionalIterator (ConstBiDirectionalIterator const &it)

	~ConstBiDirectionalIterator ()

ConstBiDirectionalIterator &	operator= (ConstBiDirectionalIterator const &it)

reference	operator* ()

pointer	operator-> ()

Public Member Functions inherited from STK::DenseIteratorBase< ConstBiDirectionalIterator< Array > >
Index	pos () const

ConstBiDirectionalIterator< Array > &	operator++ ()
	next position

ConstBiDirectionalIterator< Array > &	operator++ (int junk)
	next position

ConstBiDirectionalIterator< Array > &	operator-- ()
	previous position

ConstBiDirectionalIterator< Array > &	operator-- (int)
	previous position

ConstBiDirectionalIterator< Array > &	operator+= (Index n)
	add n positions to current position

ConstBiDirectionalIterator< Array > &	operator-= (Index n)
	Subtract n positions to current position.

Public Member Functions inherited from STK::IRecursiveTemplate< Derived >
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.

Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.

Derived *	asPtrDerived ()
	static cast : return a ptr on a `Derived` of this with a cast to the derived class.

Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant `Derived` of this with a cast to the derived class.

Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.

Derived *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.

Public Attributes
Index	pos_
	Current position.

Private Attributes
Array const &	list1D_

Friends
void	swap (ConstBiDirectionalIterator &lhs, ConstBiDirectionalIterator &rhs)

Additional Inherited Members
Protected Member Functions inherited from STK::DenseIteratorBase< ConstBiDirectionalIterator< Array > >
	DenseIteratorBase ()
	default constructor

	DenseIteratorBase (Index pos)
	constructor with specified position

	DenseIteratorBase (DenseIteratorBase const &it)
	copy constructor.

	~DenseIteratorBase ()
	destructor

Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.

	~IRecursiveTemplate ()
	destructor.

Protected Attributes inherited from STK::DenseIteratorBase< ConstBiDirectionalIterator< Array > >
Index	pos_
	Current position.

Detailed Description

template<class Array>
struct STK::ConstBiDirectionalIterator< Array >

ConstBiDirectionalIterator allows to loop over the element of one dimensional list containers.

See also: STK::List1D

Definition at line 193 of file STK_BiDirectionalIterator.h.

Member Typedef Documentation

◆ Base

template<class Array >

typedef DenseIteratorBase< ConstBiDirectionalIterator > STK::ConstBiDirectionalIterator< Array >::Base

Definition at line 197 of file STK_BiDirectionalIterator.h.

◆ ColRange

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::ColRange STK::ConstBiDirectionalIterator< Array >::ColRange

Definition at line 214 of file STK_BiDirectionalIterator.h.

◆ difference_type

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::difference_type STK::ConstBiDirectionalIterator< Array >::difference_type

Definition at line 220 of file STK_BiDirectionalIterator.h.

◆ Index

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::Index STK::ConstBiDirectionalIterator< Array >::Index

Definition at line 198 of file STK_BiDirectionalIterator.h.

◆ iterator_category

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::iterator_category STK::ConstBiDirectionalIterator< Array >::iterator_category

Definition at line 216 of file STK_BiDirectionalIterator.h.

◆ pointer

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::pointer STK::ConstBiDirectionalIterator< Array >::pointer

Definition at line 219 of file STK_BiDirectionalIterator.h.

◆ reference

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::reference STK::ConstBiDirectionalIterator< Array >::reference

Definition at line 218 of file STK_BiDirectionalIterator.h.

◆ RowRange

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::RowRange STK::ConstBiDirectionalIterator< Array >::RowRange

Definition at line 213 of file STK_BiDirectionalIterator.h.

◆ Type

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::Type STK::ConstBiDirectionalIterator< Array >::Type

Definition at line 210 of file STK_BiDirectionalIterator.h.

◆ TypeConst

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::TypeConst STK::ConstBiDirectionalIterator< Array >::TypeConst

Definition at line 211 of file STK_BiDirectionalIterator.h.

◆ value_type

template<class Array >

typedef hidden::IteratorTraits<ConstBiDirectionalIterator>::value_type STK::ConstBiDirectionalIterator< Array >::value_type

Definition at line 217 of file STK_BiDirectionalIterator.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Array >

anonymous enum

Enumerator
structure_
orient_
sizeCols_
sizeRows_
size_
storage_

Definition at line 200 of file STK_BiDirectionalIterator.h.

    {
      structure_ = hidden::IteratorTraits< ConstBiDirectionalIterator >::structure_,
      orient_    = hidden::IteratorTraits< ConstBiDirectionalIterator >::orient_,
      sizeCols_  = hidden::IteratorTraits< ConstBiDirectionalIterator >::sizeCols_,
      sizeRows_  = hidden::IteratorTraits< ConstBiDirectionalIterator >::sizeRows_,
      size_      = hidden::IteratorTraits< ConstBiDirectionalIterator >::size_,
      storage_   = hidden::IteratorTraits< ConstBiDirectionalIterator >::storage_
    };

Constructor & Destructor Documentation

◆ ConstBiDirectionalIterator() [1/2]

template<class Array >

STK::ConstBiDirectionalIterator< Array >::ConstBiDirectionalIterator	(	Array const &	list1D,
		int	pos
	)

inline

Definition at line 226 of file STK_BiDirectionalIterator.h.

                              : Base(pos)
                              , RowRange()
                              , list1D_(list1D)
    {}

◆ ConstBiDirectionalIterator() [2/2]

template<class Array >

STK::ConstBiDirectionalIterator< Array >::ConstBiDirectionalIterator ( ConstBiDirectionalIterator< Array > const & it )

inline

Definition at line 231 of file STK_BiDirectionalIterator.h.

232 : Base(it), RowRange(it), list1D_(it.list1D_)

233 {}

◆ ~ConstBiDirectionalIterator()

template<class Array >

STK::ConstBiDirectionalIterator< Array >::~ConstBiDirectionalIterator ( )

inline

Definition at line 234 of file STK_BiDirectionalIterator.h.

234{}

Member Function Documentation

◆ operator*()

template<class Array >

reference STK::ConstBiDirectionalIterator< Array >::operator* ( )

inline

Definition at line 243 of file STK_BiDirectionalIterator.h.

243{ return list1D_[pos_]; }

STK::ConstBiDirectionalIterator::pos_

Index pos_

Current position.

Definition STK_DenseIteratorBase.h:157

References STK::ConstBiDirectionalIterator< Array >::list1D_, and STK::ConstBiDirectionalIterator< Array >::pos_.

◆ operator->()

template<class Array >

pointer STK::ConstBiDirectionalIterator< Array >::operator-> ( )

inline

Definition at line 244 of file STK_BiDirectionalIterator.h.

244{ return &(list1D_[pos_]); }

References STK::ConstBiDirectionalIterator< Array >::list1D_, and STK::ConstBiDirectionalIterator< Array >::pos_.

◆ operator=()

template<class Array >

ConstBiDirectionalIterator & STK::ConstBiDirectionalIterator< Array >::operator= ( ConstBiDirectionalIterator< Array > const & it )

inline

Definition at line 235 of file STK_BiDirectionalIterator.h.

    {
      Base::operator=(it);
      RowRange::operator=(it);
      list1D_ = it.list1D_;
      return *this;
    }

References STK::ConstBiDirectionalIterator< Array >::list1D_.

Friends And Related Symbol Documentation

◆ swap

template<class Array >

void swap	(	ConstBiDirectionalIterator< Array > &	lhs,
		ConstBiDirectionalIterator< Array > &	rhs
	)

friend

Definition at line 246 of file STK_BiDirectionalIterator.h.

    {
      Base::swap(lhs, rhs);
      std::swap(lhs.list1D_, rhs.list1D_);
    }

Member Data Documentation

◆ list1D_

template<class Array >

Array const& STK::ConstBiDirectionalIterator< Array >::list1D_

private

Definition at line 253 of file STK_BiDirectionalIterator.h.

Referenced by STK::ConstBiDirectionalIterator< Array >::operator*(), STK::ConstBiDirectionalIterator< Array >::operator->(), and STK::ConstBiDirectionalIterator< Array >::operator=().

◆ pos_

template<class Array >

Index STK::DenseIteratorBase< Derived >::pos_

Current position.

Definition at line 157 of file STK_DenseIteratorBase.h.

Referenced by STK::ConstBiDirectionalIterator< Array >::operator*(), and STK::ConstBiDirectionalIterator< Array >::operator->().

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

STK_BiDirectionalIterator.h

Public Types

Public Member Functions

Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ ColRange

◆ difference_type

◆ Index

◆ iterator_category

◆ pointer

◆ reference

◆ RowRange

◆ Type

◆ TypeConst

◆ value_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ConstBiDirectionalIterator() [1/2]

◆ ConstBiDirectionalIterator() [2/2]

◆ ~ConstBiDirectionalIterator()

Member Function Documentation

◆ operator*()

◆ operator->()

◆ operator=()

Friends And Related Symbol Documentation

◆ swap

Member Data Documentation

◆ list1D_

◆ pos_