eFFT< N > Class Template Reference

Public Member Functions
	eFFT (const eFFT &)=delete
	eFFT (eFFT &&) noexcept=default
eFFT &	operator= (const eFFT &)=delete
eFFT &	operator= (eFFT &&) noexcept=default
constexpr unsigned int	framesize () const
	Get the frame size of the FFT.
void	initialize ()
	Initializes the FFT computation with zero matrix.
void	initialize (cfloatmat &x, const int offset=0)
	Initializes the FFT computation with the provided matrix.
bool	update (const Stimulus &p)
	Updates the FFT with a single stimulus.
bool	update (cfloatmat &x, const Stimulus &p, const unsigned int offset=0)
	Updates the FFT with a single stimulus in the specified matrix.
bool	update (Stimuli &pv)
	Updates the FFT with multiple stimuli.
bool	update (cfloatmat &x, Stimuli::iterator b0, Stimuli::iterator e0, const unsigned int offset=0)
	Updates the FFT with multiple stimuli in the specified matrix.
const cfloatmat &	getFFT () const
	Get the FFT result as an Eigen matrix of complex floats.
	eFFT (const eFFT &)=delete
	eFFT (eFFT &&) noexcept=default
eFFT &	operator= (const eFFT &)=delete
eFFT &	operator= (eFFT &&) noexcept=default
constexpr unsigned int	framesize () const
	Get the frame size of the FFT.
void	initialize ()
	Initializes the FFT computation with zero matrix.
void	initialize (cfloatmat &x, const int offset=0)
	Initializes the FFT computation with the provided matrix.
bool	update (const Stimulus &p)
	Updates the FFT with a single stimulus.
bool	update (cfloatmat &x, const Stimulus &p, const unsigned int offset=0)
	Updates the FFT with a single stimulus in the specified matrix.
bool	update (Stimuli &pv)
	Updates the FFT with multiple stimuli.
bool	update (cfloatmat &x, Stimuli::iterator b0, Stimuli::iterator e0, const unsigned int offset=0)
	Updates the FFT with multiple stimuli in the specified matrix.
const cfloatmat &	getFFT () const
	Get the FFT result as an Eigen matrix of complex floats.

Member Function Documentation

framesize() [1/2]

template<unsigned int N>

unsigned int eFFT< N >::framesize ( ) const

inlinenodiscardconstexpr

Get the frame size of the FFT.

Returns

The frame size as an unsigned integer.

framesize() [2/2]

template<unsigned int N>

unsigned int eFFT< N >::framesize ( ) const

inlinenodiscardconstexpr

Get the frame size of the FFT.

Returns

The frame size as an unsigned integer.

getFFT() [1/2]

template<unsigned int N>

const cfloatmat & eFFT< N >::getFFT ( ) const

inlinenodiscard

Get the FFT result as an Eigen matrix of complex floats.

Returns

The FFT result.

getFFT() [2/2]

template<unsigned int N>

const cfloatmat & eFFT< N >::getFFT ( ) const

inlinenodiscard

Get the FFT result as an Eigen matrix of complex floats.

Returns

The FFT result.

initialize() [1/2]

template<unsigned int N>

void eFFT< N >::initialize ( cfloatmat & x, const int offset = 0 )

inline

Initializes the FFT computation with the provided matrix.

Parameters

x	Input matrix.
offset	Offset for the tree structure.

initialize() [2/2]

template<unsigned int N>

void eFFT< N >::initialize ( cfloatmat & x, const int offset = 0 )

inline

Initializes the FFT computation with the provided matrix.

Parameters

x	Input matrix.
offset	Offset for the tree structure.

update() [1/8]

template<unsigned int N>

bool eFFT< N >::update ( cfloatmat & x, const Stimulus & p, const unsigned int offset = 0 )

inline

Updates the FFT with a single stimulus in the specified matrix.

Parameters

x	The matrix to update.
p	The stimulus to update.

Returns

True if the update changed the FFT state, false otherwise.

update() [2/8]

template<unsigned int N>

bool eFFT< N >::update ( cfloatmat & x, const Stimulus & p, const unsigned int offset = 0 )

inline

Updates the FFT with a single stimulus in the specified matrix.

Parameters

x	The matrix to update.
p	The stimulus to update.

Returns

True if the update changed the FFT state, false otherwise.

update() [3/8]

template<unsigned int N>

bool eFFT< N >::update ( cfloatmat & x, Stimuli::iterator b0, Stimuli::iterator e0, const unsigned int offset = 0 )

inline

Updates the FFT with multiple stimuli in the specified matrix.

Parameters

x	The matrix to update.
b0	Iterator pointing to the begining of the stimuli vector.
e0	Iterator pointing to the end of the stimuli vector.

Returns

True if the update changed the FFT state, false otherwise.

update() [4/8]

template<unsigned int N>

bool eFFT< N >::update ( cfloatmat & x, Stimuli::iterator b0, Stimuli::iterator e0, const unsigned int offset = 0 )

inline

Updates the FFT with multiple stimuli in the specified matrix.

Parameters

x	The matrix to update.
b0	Iterator pointing to the begining of the stimuli vector.
e0	Iterator pointing to the end of the stimuli vector.

Returns

True if the update changed the FFT state, false otherwise.

update() [5/8]

template<unsigned int N>

bool eFFT< N >::update ( const Stimulus & p )

inline

Updates the FFT with a single stimulus.

Parameters

p	The stimulus to update.

Returns

True if the update changed the FFT state, false otherwise.

update() [6/8]

template<unsigned int N>

bool eFFT< N >::update ( const Stimulus & p )

inline

Updates the FFT with a single stimulus.

Parameters

p	The stimulus to update.

Returns

True if the update changed the FFT state, false otherwise.

update() [7/8]

template<unsigned int N>

bool eFFT< N >::update ( Stimuli & pv )

inline

Updates the FFT with multiple stimuli.

Parameters

pv	The stimuli to update.

Returns

True if the update changed the FFT state, false otherwise.

update() [8/8]

template<unsigned int N>

bool eFFT< N >::update ( Stimuli & pv )

inline

Updates the FFT with multiple stimuli.

Parameters

pv	The stimuli to update.

Returns

True if the update changed the FFT state, false otherwise.

---

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

• include/efft.hpp
• python/include/efft.hpp