Eigen  3.4.90 (git rev 9589cc4e7fd8e4538bedef80dd36c7738977a8be)
 
Loading...
Searching...
No Matches
Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType > Struct Template Reference

#include <Eigen/src/Eigenvalues/HessenbergDecomposition.h>

Detailed Description

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

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

This is defined in the Eigenvalues module.

#include <Eigen/Eigenvalues>
Template Parameters
MatrixTypetype 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.

Public Member Functions

template<typename ResultType>
void evalTo (ResultType &result) const
 Hessenberg matrix in decomposition.
 
 HessenbergDecompositionMatrixHReturnType (const HessenbergDecomposition< MatrixType > &hess)
 Constructor.
 

Constructor & Destructor Documentation

◆ HessenbergDecompositionMatrixHReturnType()

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

Constructor.

Parameters
[in]hessHessenberg decomposition

Member Function Documentation

◆ evalTo()

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

Hessenberg matrix in decomposition.

Parameters
[out]resultHessenberg matrix in decomposition hess which was passed to the constructor

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