DenseRandomIterator allows to loop over the elements of containers Array. More...

#include <STK_DenseRandomIterator.h>

Inheritance diagram for STK::DenseRandomIterator< Array_ >:

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

typedef DenseIteratorBase< DenseRandomIterator >	Base

typedef hidden::IteratorTraits< DenseRandomIterator >::Index	Index

typedef hidden::IteratorTraits< DenseRandomIterator >::Type	Type

typedef hidden::IteratorTraits< DenseRandomIterator >::TypeConst	TypeConst

typedef hidden::IteratorTraits< DenseRandomIterator >::RowRange	RowRange

typedef hidden::IteratorTraits< DenseRandomIterator >::ColRange	ColRange

typedef hidden::IteratorTraits< DenseRandomIterator >::iterator_category	iterator_category

typedef hidden::IteratorTraits< DenseRandomIterator >::value_type	value_type

typedef hidden::IteratorTraits< DenseRandomIterator >::reference	reference

typedef hidden::IteratorTraits< DenseRandomIterator >::pointer	pointer

typedef hidden::IteratorTraits< DenseRandomIterator >::difference_type	difference_type

Public Types inherited from STK::DenseIteratorBase< DenseRandomIterator< Array_ > >
typedef hidden::IteratorTraits< DenseRandomIterator< Array_ > >::Index	Index

typedef hidden::IteratorTraits< DenseRandomIterator< Array_ > >::iterator_category	iterator_category

typedef hidden::IteratorTraits< DenseRandomIterator< Array_ > >::value_type	value_type

typedef hidden::IteratorTraits< DenseRandomIterator< Array_ > >::reference	reference

typedef hidden::IteratorTraits< DenseRandomIterator< Array_ > >::pointer	pointer

typedef hidden::IteratorTraits< DenseRandomIterator< Array_ > >::difference_type	difference_type

Public Member Functions
	DenseRandomIterator ()
	Default constructor.

	DenseRandomIterator (Array_ &array, int pos)
	Constructor with array and position given.

	DenseRandomIterator (DenseRandomIterator const &it)
	copy constructor

	~DenseRandomIterator ()

DenseRandomIterator &	operator= (DenseRandomIterator const &it)
	assignment operator

bool	operator== (DenseRandomIterator const &rhs)
	comparing two iterators (only position is compared !)

bool	operator!= (DenseRandomIterator const &rhs)
	comparing two iterators (only position is compared !)

reference	operator* ()

pointer	operator-> ()

reference	operator[] (Index pos)

Public Member Functions inherited from STK::DenseIteratorBase< DenseRandomIterator< Array_ > >
Index	pos () const

DenseRandomIterator< Array_ > &	operator++ ()
	next position

DenseRandomIterator< Array_ > &	operator++ (int junk)
	next position

DenseRandomIterator< Array_ > &	operator-- ()
	previous position

DenseRandomIterator< Array_ > &	operator-- (int)
	previous position

DenseRandomIterator< Array_ > &	operator+= (Index n)
	add n positions to current position

DenseRandomIterator< 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_ *	p_array_

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

Additional Inherited Members
Protected Member Functions inherited from STK::DenseIteratorBase< DenseRandomIterator< 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< DenseRandomIterator< Array_ > >
Index	pos_
	Current position.

Detailed Description

template<class Array_>
struct STK::DenseRandomIterator< Array_ >

DenseRandomIterator allows to loop over the elements of containers Array.

Definition at line 122 of file STK_DenseRandomIterator.h.

Member Typedef Documentation

◆ Base

template<class Array_ >

typedef DenseIteratorBase< DenseRandomIterator > STK::DenseRandomIterator< Array_ >::Base

Definition at line 126 of file STK_DenseRandomIterator.h.

◆ ColRange

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::ColRange STK::DenseRandomIterator< Array_ >::ColRange

Definition at line 143 of file STK_DenseRandomIterator.h.

◆ difference_type

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::difference_type STK::DenseRandomIterator< Array_ >::difference_type

Definition at line 149 of file STK_DenseRandomIterator.h.

◆ Index

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::Index STK::DenseRandomIterator< Array_ >::Index

Definition at line 127 of file STK_DenseRandomIterator.h.

◆ iterator_category

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::iterator_category STK::DenseRandomIterator< Array_ >::iterator_category

Definition at line 145 of file STK_DenseRandomIterator.h.

◆ pointer

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::pointer STK::DenseRandomIterator< Array_ >::pointer

Definition at line 148 of file STK_DenseRandomIterator.h.

◆ reference

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::reference STK::DenseRandomIterator< Array_ >::reference

Definition at line 147 of file STK_DenseRandomIterator.h.

◆ RowRange

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::RowRange STK::DenseRandomIterator< Array_ >::RowRange

Definition at line 142 of file STK_DenseRandomIterator.h.

◆ Type

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::Type STK::DenseRandomIterator< Array_ >::Type

Definition at line 139 of file STK_DenseRandomIterator.h.

◆ TypeConst

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::TypeConst STK::DenseRandomIterator< Array_ >::TypeConst

Definition at line 140 of file STK_DenseRandomIterator.h.

◆ value_type

template<class Array_ >

typedef hidden::IteratorTraits<DenseRandomIterator>::value_type STK::DenseRandomIterator< Array_ >::value_type

Definition at line 146 of file STK_DenseRandomIterator.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Array_ >

anonymous enum

Enumerator
structure_
orient_
sizeCols_
sizeRows_
size_
storage_

Definition at line 129 of file STK_DenseRandomIterator.h.

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

Constructor & Destructor Documentation

◆ DenseRandomIterator() [1/3]

template<class Array_ >

STK::DenseRandomIterator< Array_ >::DenseRandomIterator ( )

inline

Default constructor.

Definition at line 154 of file STK_DenseRandomIterator.h.

154: Base(), RowRange(), p_array_(0) {}

STK::DenseRandomIterator::RowRange

hidden::IteratorTraits< DenseRandomIterator >::RowRange RowRange

Definition STK_DenseRandomIterator.h:142

STK::DenseRandomIterator::Base

DenseIteratorBase< DenseRandomIterator > Base

Definition STK_DenseRandomIterator.h:126

STK::DenseRandomIterator::p_array_

Array_ * p_array_

Definition STK_DenseRandomIterator.h:196

◆ DenseRandomIterator() [2/3]

template<class Array_ >

STK::DenseRandomIterator< Array_ >::DenseRandomIterator	(	Array_ &	array,
		int	pos
	)

inline

Constructor with array and position given.

Definition at line 156 of file STK_DenseRandomIterator.h.

                       : Base(pos)
                       , RowRange(array.range())
                       , p_array_(&array)
    {}

◆ DenseRandomIterator() [3/3]

template<class Array_ >

STK::DenseRandomIterator< Array_ >::DenseRandomIterator ( DenseRandomIterator< Array_ > const & it )

inline

copy constructor

Definition at line 162 of file STK_DenseRandomIterator.h.

                       : Base(it)
                       , RowRange(it)
                       , p_array_(it.p_array_)
    {}

◆ ~DenseRandomIterator()

template<class Array_ >

STK::DenseRandomIterator< Array_ >::~DenseRandomIterator ( )

inline

Definition at line 167 of file STK_DenseRandomIterator.h.

167{}

Member Function Documentation

◆ operator!=()

template<class Array_ >

bool STK::DenseRandomIterator< Array_ >::operator!= ( DenseRandomIterator< Array_ > const & rhs )

inline

comparing two iterators (only position is compared !)

Definition at line 181 of file STK_DenseRandomIterator.h.

181{ return(pos_!=rhs.pos_); }

STK::DenseRandomIterator::pos_

Index pos_

Current position.

Definition STK_DenseIteratorBase.h:157

References STK::DenseRandomIterator< Array_ >::pos_.

◆ operator*()

template<class Array_ >

reference STK::DenseRandomIterator< Array_ >::operator* ( )

inline

Definition at line 184 of file STK_DenseRandomIterator.h.

184{ return p_array_->elt(pos_); }

References STK::DenseRandomIterator< Array_ >::p_array_, and STK::DenseRandomIterator< Array_ >::pos_.

◆ operator->()

template<class Array_ >

pointer STK::DenseRandomIterator< Array_ >::operator-> ( )

inline

Definition at line 185 of file STK_DenseRandomIterator.h.

185{ return &(p_array_->elt(pos_)); }

References STK::DenseRandomIterator< Array_ >::p_array_, and STK::DenseRandomIterator< Array_ >::pos_.

◆ operator=()

template<class Array_ >

DenseRandomIterator & STK::DenseRandomIterator< Array_ >::operator= ( DenseRandomIterator< Array_ > const & it )

inline

assignment operator

Definition at line 169 of file STK_DenseRandomIterator.h.

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

References STK::DenseRandomIterator< Array_ >::p_array_.

◆ operator==()

template<class Array_ >

bool STK::DenseRandomIterator< Array_ >::operator== ( DenseRandomIterator< Array_ > const & rhs )

inline

comparing two iterators (only position is compared !)

Definition at line 179 of file STK_DenseRandomIterator.h.

179{ return(pos_==rhs.pos_); }

References STK::DenseRandomIterator< Array_ >::pos_.

◆ operator[]()

template<class Array_ >

reference STK::DenseRandomIterator< Array_ >::operator[] ( Index pos )

inline

Definition at line 186 of file STK_DenseRandomIterator.h.

186{ return p_array_->elt(pos); }

References STK::DenseRandomIterator< Array_ >::p_array_, and STK::DenseIteratorBase< DenseRandomIterator< Array_ > >::pos().

Friends And Related Symbol Documentation

◆ swap

template<class Array_ >

void swap	(	DenseRandomIterator< Array_ > &	lhs,
		DenseRandomIterator< Array_ > &	rhs
	)

friend

Definition at line 189 of file STK_DenseRandomIterator.h.

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

Member Data Documentation

◆ p_array_

template<class Array_ >

Array_* STK::DenseRandomIterator< Array_ >::p_array_

private

Definition at line 196 of file STK_DenseRandomIterator.h.

Referenced by STK::DenseRandomIterator< Array_ >::operator*(), STK::DenseRandomIterator< Array_ >::operator->(), STK::DenseRandomIterator< Array_ >::operator=(), and STK::DenseRandomIterator< 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::DenseRandomIterator< Array_ >::operator!=(), STK::DenseRandomIterator< Array_ >::operator*(), STK::DenseRandomIterator< Array_ >::operator->(), and STK::DenseRandomIterator< Array_ >::operator==().

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

STK_DenseRandomIterator.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

◆ DenseRandomIterator() [1/3]

◆ DenseRandomIterator() [2/3]

◆ DenseRandomIterator() [3/3]

◆ ~DenseRandomIterator()

Member Function Documentation

◆ operator!=()

◆ operator*()

◆ operator->()

◆ operator=()

◆ operator==()

◆ operator[]()

Friends And Related Symbol Documentation

◆ swap

Member Data Documentation

◆ p_array_

◆ pos_