NiHu  2.0
NiHu::dirac_field_type_accelerator_iterator Class Reference

an iterator class used for the dirac accelerators More...

#include <field_type_accelerator.hpp>

Public Member Functions

 dirac_field_type_accelerator_iterator (index_t const &idx)
 constructor More...
 
dirac_field_type_accelerator_iteratoroperator++ ()
 increment operator More...
 
bool operator!= (dirac_field_type_accelerator_iterator const &other) const
 check inequality More...
 
bool operator== (dirac_field_type_accelerator_iterator const &other) const
 check equality More...
 
const index_toperator* () const
 dereference operator More...
 
const index_toperator-> () const
 pointer dereference operator More...
 

Detailed Description

an iterator class used for the dirac accelerators

Definition at line 244 of file field_type_accelerator.hpp.

Constructor & Destructor Documentation

◆ dirac_field_type_accelerator_iterator()

NiHu::dirac_field_type_accelerator_iterator::dirac_field_type_accelerator_iterator ( index_t const &  idx)
inline

constructor

Parameters
[in]idxthe index

Definition at line 252 of file field_type_accelerator.hpp.

Member Function Documentation

◆ operator!=()

bool NiHu::dirac_field_type_accelerator_iterator::operator!= ( dirac_field_type_accelerator_iterator const &  other) const
inline

check inequality

Parameters
[in]otherthe other iterator
Returns
true if the two iterators are different

Definition at line 270 of file field_type_accelerator.hpp.

◆ operator*()

const index_t& NiHu::dirac_field_type_accelerator_iterator::operator* ( ) const
inline

dereference operator

Returns
the dereferred index

Definition at line 287 of file field_type_accelerator.hpp.

◆ operator++()

dirac_field_type_accelerator_iterator& NiHu::dirac_field_type_accelerator_iterator::operator++ ( )
inline

increment operator

Returns
the incremented iterator reference

Definition at line 260 of file field_type_accelerator.hpp.

◆ operator->()

const index_t* NiHu::dirac_field_type_accelerator_iterator::operator-> ( ) const
inline

pointer dereference operator

Returns
the address of the stored index

Definition at line 295 of file field_type_accelerator.hpp.

◆ operator==()

bool NiHu::dirac_field_type_accelerator_iterator::operator== ( dirac_field_type_accelerator_iterator const &  other) const
inline

check equality

Parameters
[in]otherthe other iterator
Returns
true if the two are equal

Definition at line 279 of file field_type_accelerator.hpp.


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