The routine GetIntervals() returns an instance of this class, which gives the information of a polynomial filter. More...

#include <polyfilt.h>

Public Member Functions
	PolynomialFilterInfo ()
	A default constructor to initialze all zero.

Public Attributes
Vector	intervals
	The partition of the range of spectrum which decides the base filter and the polynomial filter.

int	filterType
	1 means a high-pass filter (or low-pass filter with conversion); 2 means a mid-pass filter.

int	filterOK
	0 means no acceptable is found; 1 means an OK filter is found; 2 means an optimal filter is found.

Real	filterQualityIndex
	Between 0.0 and 1.0; the higher the better quality of the filter.

mkIndex	numIter
	Number of iterations to get the (transition) intervals.

mkIndex	totalNumIter
	Total number of iterations performed. More...

Real	yLimit
	The lowest polynomial value P(z) for z in the interval [a1,b1] of desired eigenvalues.

Real	ySummit
	The height of (highest, if more than one) summit in the interval [a1,b1] of desired eigenvalues.

mkIndex	numLeftSteps
	Number of steps moving leftward.

Real	yLeftSummit
	The height of highest summit in the left-hand side of the interval of desired eigenvalues.

Real	yLeftBottom
	The height of lowest bottom in the left-hand side of the interval of desired eigenvalues.

Real	yLimitGap
	In general, it is \|p(a1)-p(b1)\|, where [a1,b1] is the interval of desired eigenvalues.

mkIndex	numRightSteps
	Number of steps moving rightward.

Real	yRightSummit
	The height of highest summit in the right-hand side of the interval of desired eigenvalues.

Real	yRightBottom
	The height of lowest bottom in the right-hand side of the interval of desired eigenvalues.

Detailed Description

The routine GetIntervals() returns an instance of this class, which gives the information of a polynomial filter.

Member Data Documentation

mkIndex PolynomialFilterInfo::totalNumIter

Total number of iterations performed.

This may include a few extra iterations without improving the (transition) intervals, compared to PolynomialFilterInfo::numIter.

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