CutoffDiscretization Struct Reference

Representation of frequency axis cutoff discretization. More...

#include <CutoffDiscretization.hpp>

Public Member Functions
	CutoffDiscretization (const std::vector< float > &values)
	Construct a new CutoffDiscretization object from a list of cutoff values. More...
	~CutoffDiscretization ()
	Destroy the CutoffDiscretization object.
CutoffIterator	begin () const
	Retrieve iterator to first discretization value. More...
CutoffIterator	last () const
	Retrieve iterator to last discretization value. More...
CutoffIterator	end () const
	Retrieve iterator to last+1 discretization value. More...
CutoffIterator	find (const float cutoff) const
	Retrieve iterator pointing to a specific cutoff value. More...

Detailed Description

Representation of frequency axis cutoff discretization.

Constructor & Destructor Documentation

CutoffDiscretization()

CutoffDiscretization::CutoffDiscretization ( const std::vector< float > &  values )

inline

Construct a new CutoffDiscretization object from a list of cutoff values.

Parameters

values

List of cutoff values to use for discretization.

Member Function Documentation

begin()

CutoffIterator CutoffDiscretization::begin ( ) const

inline

Retrieve iterator to first discretization value.

Returns

CutoffIterator Iterator to first discretization value.

end()

CutoffIterator CutoffDiscretization::end ( ) const

inline

Retrieve iterator to last+1 discretization value.

Returns

CutoffIterator Iterator to last+1 discretization value.

find()

CutoffIterator CutoffDiscretization::find ( const float  cutoff ) const

inline

Retrieve iterator pointing to a specific cutoff value.

Parameters

cutoff

Cutoff search value.

Returns

CutoffIterator Iterator pointing to specified cutoff value it it exists; otherwise points to last+1.

last()

CutoffIterator CutoffDiscretization::last ( ) const

inline

Retrieve iterator to last discretization value.

Returns

CutoffIterator Iterator to last discretization value.

---

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

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