NiHu::fmm::field_center_iterator< It > Class Template Reference

iterate through field centers More...

#include <elem_center_iterator.hpp>

Public Member Functions
	field_center_iterator (It it=It())
	conversion constructor More...
const It &	base () const
	helper function to reach the field iterator interface More...
It &	base ()
	helper function to reach the field iterator interface More...
ptrdiff_t	operator- (field_center_iterator const &other) const
	difference of two iterators More...
field_center_iterator	operator- (ptrdiff_t diff) const
	iterator arithmetics More...
field_center_iterator	operator+ (ptrdiff_t diff) const
	iterator arithmetics More...
field_center_iterator &	operator++ ()
	preincrenet operator More...
field_center_iterator	operator++ (int)
	postincrenet operator More...
const x_t &	operator* () const
	dereference operator More...
const x_t &	operator[] (size_t idx) const
	index operator More...
bool	operator!= (field_center_iterator const &other) const
	non-equality operator More...
bool	operator== (field_center_iterator const &other) const
	equality operator More...

Detailed Description

template<class It>
class NiHu::fmm::field_center_iterator< It >

iterate through field centers

Template Parameters

It	the iterator iterating through fields

Definition at line 130 of file elem_center_iterator.hpp.

Constructor & Destructor Documentation

field_center_iterator()

template<class It >

NiHu::fmm::field_center_iterator< It >::field_center_iterator ( It  it = It() )

inline

conversion constructor

Parameters

[in]

it

the element iterator

Definition at line 141 of file elem_center_iterator.hpp.

Member Function Documentation

base() [1/2]

template<class It >

It& NiHu::fmm::field_center_iterator< It >::base ( )

inline

helper function to reach the field iterator interface

Returns

the object as an field iterator

Definition at line 155 of file elem_center_iterator.hpp.

base() [2/2]

template<class It >

const It& NiHu::fmm::field_center_iterator< It >::base ( ) const

inline

helper function to reach the field iterator interface

Returns

the object as an field iterator

Definition at line 148 of file elem_center_iterator.hpp.

operator!=()

template<class It >

bool NiHu::fmm::field_center_iterator< It >::operator!= ( field_center_iterator< It > const &  other ) const

inline

non-equality operator

Returns

true if two iterators are different

Definition at line 214 of file elem_center_iterator.hpp.

operator*()

template<class It >

const x_t& NiHu::fmm::field_center_iterator< It >::operator* ( ) const

inline

dereference operator

Returns

the element center

Definition at line 200 of file elem_center_iterator.hpp.

operator+()

template<class It >

field_center_iterator NiHu::fmm::field_center_iterator< It >::operator+ ( ptrdiff_t  diff ) const

inline

iterator arithmetics

Parameters

[in]

diff

the offset

Returns

the offseted iterator

Definition at line 179 of file elem_center_iterator.hpp.

operator++() [1/2]

template<class It >

field_center_iterator& NiHu::fmm::field_center_iterator< It >::operator++ ( )

inline

preincrenet operator

Returns

the incremented instance

Definition at line 186 of file elem_center_iterator.hpp.

operator++() [2/2]

template<class It >

field_center_iterator NiHu::fmm::field_center_iterator< It >::operator++ ( int  )

inline

postincrenet operator

Returns

the original instance

Definition at line 193 of file elem_center_iterator.hpp.

operator-() [1/2]

template<class It >

ptrdiff_t NiHu::fmm::field_center_iterator< It >::operator- ( field_center_iterator< It > const &  other ) const

inline

difference of two iterators

Parameters

[in]

other

the other iterator

Returns

the iterator difference

Definition at line 163 of file elem_center_iterator.hpp.

operator-() [2/2]

template<class It >

field_center_iterator NiHu::fmm::field_center_iterator< It >::operator- ( ptrdiff_t  diff ) const

inline

iterator arithmetics

Parameters

[in]

diff

the offset

Returns

the offseted iterator

Definition at line 171 of file elem_center_iterator.hpp.

operator==()

template<class It >

bool NiHu::fmm::field_center_iterator< It >::operator== ( field_center_iterator< It > const &  other ) const

inline

equality operator

Returns

true if two iterators are different

Definition at line 221 of file elem_center_iterator.hpp.

operator[]()

template<class It >

const x_t& NiHu::fmm::field_center_iterator< It >::operator[] ( size_t  idx ) const

inline

index operator

Returns

the element center of the offseted iterator

Definition at line 207 of file elem_center_iterator.hpp.

---

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

• src/fmm/elem_center_iterator.hpp