Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType > Struct Template Reference

Expression type for return value of HessenbergDecomposition::matrixH() More...

#include <HessenbergDecomposition.h>

Inheritance diagram for Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >:

Collaboration diagram for Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >:

Public Types
typedef MatrixType::Index	Index
Public Types inherited from Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >
typedef internal::traits< HessenbergDecompositionMatrixHReturnType< MatrixType > >::ReturnType	ReturnType
typedef internal::dense_xpr_base< ReturnByValue >::type	Base

Public Member Functions
	HessenbergDecompositionMatrixHReturnType (const HessenbergDecomposition< MatrixType > &hess)
	Constructor. More...
template<typename ResultType >
void	evalTo (ResultType &result) const
	Hessenberg matrix in decomposition. More...
Index	rows () const
Index	cols () const
Public Member Functions inherited from Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >
void	evalTo (Dest &dst) const
Index	rows () const
Index	cols () const
const Unusable &	coeff (Index) const
const Unusable &	coeff (Index, Index) const
Unusable &	coeffRef (Index)
Unusable &	coeffRef (Index, Index)

Protected Attributes
const HessenbergDecomposition< MatrixType > &	m_hess

Detailed Description

template<typename MatrixType>
struct Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >

Expression type for return value of HessenbergDecomposition::matrixH()

Template Parameters

MatrixType

type of matrix in the Hessenberg decomposition

Objects of this type represent the Hessenberg matrix in the Hessenberg decomposition of some matrix. The object holds a reference to the HessenbergDecomposition class until the it is assigned or evaluated for some other reason (the reference should remain valid during the life time of this object). This class is the return type of HessenbergDecomposition::matrixH(); there is probably no other use for this class.

Definition at line 18 of file HessenbergDecomposition.h.

Constructor & Destructor Documentation

template<typename MatrixType >

Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::HessenbergDecompositionMatrixHReturnType ( const HessenbergDecomposition< MatrixType > &  hess )

inline

Constructor.

Parameters

[in]

hess

Hessenberg decomposition

Definition at line 346 of file HessenbergDecomposition.h.

: m_hess(hess) { }

Member Function Documentation

template<typename MatrixType >

template<typename ResultType >

void Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::evalTo ( ResultType &  result ) const

inline

Hessenberg matrix in decomposition.

Parameters

[out]

result

Hessenberg matrix in decomposition hess which was passed to the constructor

Definition at line 354 of file HessenbergDecomposition.h.

    {
      result = m_hess.packedMatrix();
      Index n = result.rows();
      if (n>2)
        result.bottomLeftCorner(n-2, n-2).template triangularView<Lower>().setZero();
    }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/Eigenvalues/HessenbergDecomposition.h