FrequencyIterator Struct Reference

Frequency iterator. More...

#include <FrequencyDiscretization.hpp>

Public Member Functions
	FrequencyIterator (float *p)
	Construct a new FrequencyIterator object, and initialize to a specific frequency value. More...
float	operator* () const
	Dereference operator. More...
bool	operator== (const FrequencyIterator &rhs) const
	Iterator comparison. More...
bool	operator!= (const FrequencyIterator &rhs) const
	Negative iterator comparison. More...
FrequencyIterator &	operator++ ()
	Prefix increment operator. More...
FrequencyIterator &	operator-- ()
	Prefix decrement operator. More...
FrequencyIterator	operator+ (const int rhs) const
	Iterator addition operator. More...
FrequencyIterator	operator- (const int rhs) const
	Iterator subtraction operator. More...
bool	operator> (const FrequencyIterator &rhs) const
	Greater comparison operator. More...
bool	operator>= (const FrequencyIterator &rhs) const
	Greater or equal comparison operator. More...
bool	operator< (const FrequencyIterator &rhs) const
	Lesser comparison operator. More...
bool	operator<= (const FrequencyIterator &rhs) const
	Lesser or equal comparison operator. More...

Public Attributes
float *	_pointer
	Pointer which the iterator currently points to.

Detailed Description

Frequency iterator.

Constructor & Destructor Documentation

FrequencyIterator()

FrequencyIterator::FrequencyIterator ( float *  p )

inline

Construct a new FrequencyIterator object, and initialize to a specific frequency value.

Parameters

p	Pointer to the initial value.

Member Function Documentation

operator!=()

bool FrequencyIterator::operator!= ( const FrequencyIterator &  rhs ) const

inline

Negative iterator comparison.

Parameters

rhs	Right hand side operand.

Returns

bool Returns false if the iterators point to the same frequency value, otherwise returns true.

operator*()

float FrequencyIterator::operator* ( ) const

inline

Dereference operator.

Returns

float Value of the frequency which the iterator points to.

operator+()

FrequencyIterator FrequencyIterator::operator+ ( const int  rhs ) const

inline

Iterator addition operator.

Parameters

rhs	Number of steps to increment iterator.

Returns

FrequencyIterator Iterator incremented by the specified number of steps.

operator++()

FrequencyIterator& FrequencyIterator::operator++ ( )

inline

Prefix increment operator.

Returns

FrequencyIterator& Reference to self.

operator-()

FrequencyIterator FrequencyIterator::operator- ( const int  rhs ) const

inline

Iterator subtraction operator.

Parameters

rhs	Number of steps to decrement iterator.

Returns

FrequencyIterator Iterator decremented by the specified number of steps.

operator--()

FrequencyIterator& FrequencyIterator::operator-- ( )

inline

Prefix decrement operator.

Returns

FrequencyIterator& Reference to self.

operator<()

bool FrequencyIterator::operator< ( const FrequencyIterator &  rhs ) const

inline

Lesser comparison operator.

Parameters

rhs	Right hand side operand.

Returns

bool Return true if the iterator is lesser than the specified value, otherwise return false.

operator<=()

bool FrequencyIterator::operator<= ( const FrequencyIterator &  rhs ) const

inline

Lesser or equal comparison operator.

Parameters

rhs	Right hand side operand.

Returns

bool Return true if the iterator is lesser or equal than the specified value.

operator==()

bool FrequencyIterator::operator== ( const FrequencyIterator &  rhs ) const

inline

Iterator comparison.

Parameters

rhs	Right hand side operand.

Returns

bool Returns true if the iterators point to the same frequency value, otherwise returns false.

operator>()

bool FrequencyIterator::operator> ( const FrequencyIterator &  rhs ) const

inline

Greater comparison operator.

Parameters

rhs	Right hand side operand.

Returns

bool Return true if the iterator is greater than the specified value, otherwise return false.

operator>=()

bool FrequencyIterator::operator>= ( const FrequencyIterator &  rhs ) const

inline

Greater or equal comparison operator.

Parameters

rhs	Right hand side operand.

Returns

bool Return true if the iterator is greater or equal than the specified value, otherwise return false.

---

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

• /home/runner/work/SpinParser/SpinParser/src/FrequencyDiscretization.hpp