SpinParser  1.0
Public Member Functions | List of all members
CutoffIterator Struct Reference

Iterator over discrete cutoff values. More...

#include <CutoffDiscretization.hpp>

Public Member Functions

 CutoffIterator (float *p)
 Construct a new CutoffIterator object pointing to specific value. More...
 
float operator* () const
 Iterator dereference. More...
 
bool operator== (const CutoffIterator &rhs) const
 Iterator comparison. More...
 
bool operator!= (const CutoffIterator &rhs) const
 Negative iterator comparison. More...
 
CutoffIteratoroperator++ ()
 Prefix increment. More...
 

Detailed Description

Iterator over discrete cutoff values.

Constructor & Destructor Documentation

◆ CutoffIterator()

CutoffIterator::CutoffIterator ( float *  p)
inline

Construct a new CutoffIterator object pointing to specific value.

Parameters
pPointer to initial value.

Member Function Documentation

◆ operator!=()

bool CutoffIterator::operator!= ( const CutoffIterator rhs) const
inline

Negative iterator comparison.

Parameters
rhsRight hand side operand.
Returns
bool Returns true of iterators are unequal, returns false otherwise.

◆ operator*()

float CutoffIterator::operator* ( ) const
inline

Iterator dereference.

Returns
float Cutoff value.

◆ operator++()

CutoffIterator& CutoffIterator::operator++ ( )
inline

Prefix increment.

Returns
CutoffIterator& Reference to self.

◆ operator==()

bool CutoffIterator::operator== ( const CutoffIterator rhs) const
inline

Iterator comparison.

Parameters
rhsRight hand side operand.
Returns
bool Returns true of iterators are equal, returns false otherwise.

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