Eigen::PolynomialSolverBase< Scalar_, Deg_ > Class Template Reference

Detailed Description

template<typename Scalar_, int Deg_>
class Eigen::PolynomialSolverBase< Scalar_, Deg_ >

Defined to be inherited by polynomial solvers: it provides convenient methods such as.

• real roots,
• greatest, smallest complex roots,
• real roots with greatest, smallest absolute real value,
• greatest, smallest real roots.

It stores the set of roots as a vector of complexes.

Inheritance diagram for Eigen::PolynomialSolverBase< Scalar_, Deg_ >:

Public Member Functions
const RealScalar &	absGreatestRealRoot (bool &hasArealRoot, const RealScalar &absImaginaryThreshold=NumTraits< Scalar >::dummy_precision()) const
const RealScalar &	absSmallestRealRoot (bool &hasArealRoot, const RealScalar &absImaginaryThreshold=NumTraits< Scalar >::dummy_precision()) const
const RealScalar &	greatestRealRoot (bool &hasArealRoot, const RealScalar &absImaginaryThreshold=NumTraits< Scalar >::dummy_precision()) const
const RootType &	greatestRoot () const
template<typename Stl_back_insertion_sequence >
void	realRoots (Stl_back_insertion_sequence &bi_seq, const RealScalar &absImaginaryThreshold=NumTraits< Scalar >::dummy_precision()) const
const RootsType &	roots () const
const RealScalar &	smallestRealRoot (bool &hasArealRoot, const RealScalar &absImaginaryThreshold=NumTraits< Scalar >::dummy_precision()) const
const RootType &	smallestRoot () const

Member Function Documentation

absGreatestRealRoot()

template<typename Scalar_ , int Deg_>

const RealScalar& Eigen::PolynomialSolverBase< Scalar_, Deg_ >::absGreatestRealRoot ( bool &  hasArealRoot, const RealScalar &  absImaginaryThreshold = NumTraits<Scalar>::dummy_precision()  ) const

inline

Returns

a real root with greatest absolute magnitude. A real root is defined as the real part of a complex root with absolute imaginary part smallest than absImaginaryThreshold. absImaginaryThreshold takes the dummy_precision associated with the Scalar_ template parameter of the PolynomialSolver class as the default value. If no real root is found the boolean hasArealRoot is set to false and the real part of the root with smallest absolute imaginary part is returned instead.

Parameters

[out]	hasArealRoot	: boolean true if a real root is found according to the absImaginaryThreshold criterion, false otherwise.
[in]	absImaginaryThreshold	: threshold on the absolute imaginary part to decide whether or not a root is real.

absSmallestRealRoot()

template<typename Scalar_ , int Deg_>

const RealScalar& Eigen::PolynomialSolverBase< Scalar_, Deg_ >::absSmallestRealRoot ( bool &  hasArealRoot, const RealScalar &  absImaginaryThreshold = NumTraits<Scalar>::dummy_precision()  ) const

inline

Returns

a real root with smallest absolute magnitude. A real root is defined as the real part of a complex root with absolute imaginary part smallest than absImaginaryThreshold. absImaginaryThreshold takes the dummy_precision associated with the Scalar_ template parameter of the PolynomialSolver class as the default value. If no real root is found the boolean hasArealRoot is set to false and the real part of the root with smallest absolute imaginary part is returned instead.

Parameters

[out]	hasArealRoot	: boolean true if a real root is found according to the absImaginaryThreshold criterion, false otherwise.
[in]	absImaginaryThreshold	: threshold on the absolute imaginary part to decide whether or not a root is real.

greatestRealRoot()

template<typename Scalar_ , int Deg_>

const RealScalar& Eigen::PolynomialSolverBase< Scalar_, Deg_ >::greatestRealRoot ( bool &  hasArealRoot, const RealScalar &  absImaginaryThreshold = NumTraits<Scalar>::dummy_precision()  ) const

inline

Returns

the real root with greatest value. A real root is defined as the real part of a complex root with absolute imaginary part smallest than absImaginaryThreshold. absImaginaryThreshold takes the dummy_precision associated with the Scalar_ template parameter of the PolynomialSolver class as the default value. If no real root is found the boolean hasArealRoot is set to false and the real part of the root with smallest absolute imaginary part is returned instead.

Parameters

[out]	hasArealRoot	: boolean true if a real root is found according to the absImaginaryThreshold criterion, false otherwise.
[in]	absImaginaryThreshold	: threshold on the absolute imaginary part to decide whether or not a root is real.

greatestRoot()

template<typename Scalar_ , int Deg_>

const RootType& Eigen::PolynomialSolverBase< Scalar_, Deg_ >::greatestRoot ( ) const

inline

Returns

the complex root with greatest norm.

realRoots()

template<typename Scalar_ , int Deg_>

template<typename Stl_back_insertion_sequence >

void Eigen::PolynomialSolverBase< Scalar_, Deg_ >::realRoots ( Stl_back_insertion_sequence &  bi_seq, const RealScalar &  absImaginaryThreshold = NumTraits<Scalar>::dummy_precision()  ) const

inline

Clear and fills the back insertion sequence with the real roots of the polynomial i.e. the real part of the complex roots that have an imaginary part which absolute value is smaller than absImaginaryThreshold. absImaginaryThreshold takes the dummy_precision associated with the Scalar_ template parameter of the PolynomialSolver class as the default value.

Parameters

[out]	bi_seq	: the back insertion sequence (stl concept)
[in]	absImaginaryThreshold	: the maximum bound of the imaginary part of a complex number that is considered as real.

roots()

template<typename Scalar_ , int Deg_>

const RootsType& Eigen::PolynomialSolverBase< Scalar_, Deg_ >::roots ( ) const

inline

Returns

the complex roots of the polynomial

smallestRealRoot()

template<typename Scalar_ , int Deg_>

const RealScalar& Eigen::PolynomialSolverBase< Scalar_, Deg_ >::smallestRealRoot ( bool &  hasArealRoot, const RealScalar &  absImaginaryThreshold = NumTraits<Scalar>::dummy_precision()  ) const

inline

Returns

the real root with smallest value. A real root is defined as the real part of a complex root with absolute imaginary part smallest than absImaginaryThreshold. absImaginaryThreshold takes the dummy_precision associated with the Scalar_ template parameter of the PolynomialSolver class as the default value. If no real root is found the boolean hasArealRoot is set to false and the real part of the root with smallest absolute imaginary part is returned instead.

Parameters

[out]	hasArealRoot	: boolean true if a real root is found according to the absImaginaryThreshold criterion, false otherwise.
[in]	absImaginaryThreshold	: threshold on the absolute imaginary part to decide whether or not a root is real.

smallestRoot()

template<typename Scalar_ , int Deg_>

const RootType& Eigen::PolynomialSolverBase< Scalar_, Deg_ >::smallestRoot ( ) const

inline

Returns

the complex root with smallest norm.

---

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

• PolynomialSolver.h