model::MatrixCompanion< pOrder > Class Template Reference

#include <MatrixCompanion.h>

Collaboration diagram for model::MatrixCompanion< pOrder >:

Public Member Functions
	MatrixCompanion (const VectorNcoeff &coeffsIN)
EigenSolverType::ComplexScalar	root (const int &i) const

Static Public Member Functions
static Eigen::MatrixXd	getCM (const VectorNcoeff &coeffsIN)

Public Attributes
const VectorNcoeff	coeffs
const Eigen::MatrixXd	cM
const EigenSolverType	es
const size_t	rootSize

Detailed Description

template<int pOrder>
class model::MatrixCompanion< pOrder >

Definition at line 21 of file MatrixCompanion.h.

Constructor & Destructor Documentation

MatrixCompanion()

template<int pOrder>

model::MatrixCompanion< pOrder >::MatrixCompanion ( const VectorNcoeff & coeffsIN )

inline

Parameters

[in]

coeffsIN

the coefficients of the polynomial, from highest to lowest.

The constructor initializes the companion matrix cM, and the eigensolver es.

Definition at line 38 of file MatrixCompanion.h.

Member Function Documentation

getCM()

template<int pOrder>

Eigen::MatrixXd model::MatrixCompanion< pOrder >::getCM ( const VectorNcoeff & coeffsIN )

inlinestatic

Definition at line 61 of file MatrixCompanion.h.

root()

template<int pOrder>

EigenSolverType::ComplexScalar model::MatrixCompanion< pOrder >::root ( const int & i ) const

inline

Parameters

[in]

i

an integer in 0<i<=pOrder

Returns

the i-th root of the polynomial.

Definition at line 52 of file MatrixCompanion.h.

Member Data Documentation

cM

template<int pOrder>

const Eigen::MatrixXd model::MatrixCompanion< pOrder >::cM

Definition at line 33 of file MatrixCompanion.h.

coeffs

template<int pOrder>

const VectorNcoeff model::MatrixCompanion< pOrder >::coeffs

Definition at line 32 of file MatrixCompanion.h.

es

template<int pOrder>

const EigenSolverType model::MatrixCompanion< pOrder >::es

Definition at line 34 of file MatrixCompanion.h.

rootSize

template<int pOrder>

const size_t model::MatrixCompanion< pOrder >::rootSize

Definition at line 35 of file MatrixCompanion.h.

---

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

• MatrixCompanion.h