FrequencyDiscretization Struct Reference

Discretization of Matsubara frequency space. More...

#include <FrequencyDiscretization.hpp>

Public Member Functions
	FrequencyDiscretization (const std::vector< float > &values)
	Construct a frequency discretization based on a list of specified mesh points. The list of specified mesh points must be in ascending order and positive definite. The symmetry-related negative values are automatically generated. More...
	~FrequencyDiscretization ()
	Destroy the FrequencyDiscretization object.
FrequencyIterator	begin () const
	Retrieve iterator to the first positive mesh point; This is the positive value with the smallest absolute value. More...
FrequencyIterator	beginNegative () const
	Retrieve iterator to the first negative mesh point; This is the negative value with the largest absolute value. More...
FrequencyIterator	last () const
	Retrieve iterator to the last mesh point; This is the positive value with the largest absolute value. More...
FrequencyIterator	end () const
	Retrieve iterator to the last+1 mesh point. More...
FrequencyIterator	lesser (const float w) const
	Retrieve an iterator to the closest mesh point that is lesser than the specified frequency value. If no lesser mesh point exists, returns an iterator to the closest mesh point. More...
FrequencyIterator	greater (const float w) const
	Retrieve an iterator to the closest mesh point that is greater than the specified frequency value. If no greater mesh point exists, returns an iterator to the closest mesh point. More...
int	offset (const float w) const
	Return the number of iterator increments of a mesh point associated with a given frequency value, relative to the first positive mesh point. The value of the specified frequency must be positive. If no mesh point with that value exists, returns the index of the last mesh point. More...
void	interpolateOffset (const float w, int &lowerOffset, int &upperOffset, float &bias) const
	Perform an interpolation between mesh points for an arbitrary positive frequency. More...

Public Attributes
int	size
	Number of positive mesh points.
float *	_data
	Pointer to the first positive mesh point. Stored contiuously after FrequencyDiscretization::_dataNegative.
float *	_dataNegative
	Pointer to the first negative mesh point.

Detailed Description

Discretization of Matsubara frequency space.

This structure represents a discretization of Matsubara frequency space base on a list of specified mesh points. It provides methods to iterate the frequency mesh, to find closest mesh points, and to linearly interpolate arbitrary values inbetween the mesh points. The mesh is mirror symmetric around the origin.

Constructor & Destructor Documentation

FrequencyDiscretization()

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

inline

Construct a frequency discretization based on a list of specified mesh points. The list of specified mesh points must be in ascending order and positive definite. The symmetry-related negative values are automatically generated.

Parameters

values

List of mesh points.

Member Function Documentation

begin()

FrequencyIterator FrequencyDiscretization::begin ( ) const

inline

Retrieve iterator to the first positive mesh point; This is the positive value with the smallest absolute value.

Returns

FrequencyIterator Iterator to the first positive mesh point.

beginNegative()

FrequencyIterator FrequencyDiscretization::beginNegative ( ) const

inline

Retrieve iterator to the first negative mesh point; This is the negative value with the largest absolute value.

Returns

FrequencyIterator Iterator to the first negative mesh point.

end()

FrequencyIterator FrequencyDiscretization::end ( ) const

inline

Retrieve iterator to the last+1 mesh point.

Returns

FrequencyIterator Iterator to the last+1 mesh point.

greater()

FrequencyIterator FrequencyDiscretization::greater ( const float  w ) const

inline

Retrieve an iterator to the closest mesh point that is greater than the specified frequency value. If no greater mesh point exists, returns an iterator to the closest mesh point.

Parameters

w	Designated upper frequency bound.

Returns

FrequencyIterator Iterator to the closest mesh point.

interpolateOffset()

void FrequencyDiscretization::interpolateOffset ( const float  w, int &  lowerOffset, int &  upperOffset, float &  bias  ) const

inline

Perform an interpolation between mesh points for an arbitrary positive frequency.

Parameters

[in]	w	Frequency value to interpolate to. Must be positive.
[out]	lowerOffset	Number of iterator increments of the lesser mesh point, relative to the first positive mesh point.
[out]	upperOffset	Number of iterator increments of the greater mesh point, relative to the first positive mesh point.
[out]	bias	Linear interpolation weight. Zero, if w matches the mesh point at lowerOffset. One. if w matches the mesh point at upperOffset.

last()

FrequencyIterator FrequencyDiscretization::last ( ) const

inline

Retrieve iterator to the last mesh point; This is the positive value with the largest absolute value.

Returns

FrequencyIterator Iterator to the last mesh point.

lesser()

FrequencyIterator FrequencyDiscretization::lesser ( const float  w ) const

inline

Retrieve an iterator to the closest mesh point that is lesser than the specified frequency value. If no lesser mesh point exists, returns an iterator to the closest mesh point.

Parameters

w	Designated upper frequency bound.

Returns

FrequencyIterator Iterator to the closest mesh point.

offset()

int FrequencyDiscretization::offset ( const float  w ) const

inline

Return the number of iterator increments of a mesh point associated with a given frequency value, relative to the first positive mesh point. The value of the specified frequency must be positive. If no mesh point with that value exists, returns the index of the last mesh point.

Parameters

w	Frequency value. Must be positive.

Returns

int Index of the mesh point.

---

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

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