pulp::signal::FirEquirippleResult Struct Reference

#include <fir_design.hpp>

Public Member Functions
	operator bool () const noexcept

Public Attributes
FirDesignStatus	status = FirDesignStatus::invalid_argument
std::vector< double >	coefficients
std::vector< double >	extremal_frequencies
	The final alternation set, ascending.
std::vector< double >	band_ripples
	Achieved max |A(w) - amplitude| per input band, unweighted.
double	minimax_error = 0.0
	The equalized weighted ripple, |delta|.
double	measured_weighted_error = 0.0
	Largest weighted error measured on the dense grid at the returned design.
std::size_t	iterations = 0

Member Function Documentation

operator bool()

pulp::signal::FirEquirippleResult::operator bool ( ) const

inlineexplicitnoexcept

Member Data Documentation

band_ripples

std::vector<double> pulp::signal::FirEquirippleResult::band_ripples

Achieved max |A(w) - amplitude| per input band, unweighted.

coefficients

std::vector<double> pulp::signal::FirEquirippleResult::coefficients

extremal_frequencies

std::vector<double> pulp::signal::FirEquirippleResult::extremal_frequencies

The final alternation set, ascending.

Size is the number of independent coefficients plus one when the alternation theorem is satisfied.

iterations

std::size_t pulp::signal::FirEquirippleResult::iterations = 0

measured_weighted_error

double pulp::signal::FirEquirippleResult::measured_weighted_error = 0.0

Largest weighted error measured on the dense grid at the returned design.

Converged designs have this within tolerance of minimax_error.

minimax_error

double pulp::signal::FirEquirippleResult::minimax_error = 0.0

The equalized weighted ripple, |delta|.

status

FirDesignStatus pulp::signal::FirEquirippleResult::status = FirDesignStatus::invalid_argument

---

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

• /home/runner/work/pulp/pulp/core/signal/include/pulp/signal/fir_design.hpp