HessenbergDecompositionMatrixHReturnType< MatrixType > Struct Template Reference
[Eigenvalues module]

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

Inherits Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >, Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >, Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >, Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >, and Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >.

List of all members.

Public Member Functions

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

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:
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.


Constructor & Destructor Documentation

HessenbergDecompositionMatrixHReturnType ( const HessenbergDecomposition< MatrixType > &  hess  )  [inline]

Constructor.

Parameters:
[in] hess Hessenberg decomposition
HessenbergDecompositionMatrixHReturnType ( const HessenbergDecomposition< MatrixType > &  hess  )  [inline]

Constructor.

Parameters:
[in] hess Hessenberg decomposition
HessenbergDecompositionMatrixHReturnType ( const HessenbergDecomposition< MatrixType > &  hess  )  [inline]

Constructor.

Parameters:
[in] hess Hessenberg decomposition
HessenbergDecompositionMatrixHReturnType ( const HessenbergDecomposition< MatrixType > &  hess  )  [inline]

Constructor.

Parameters:
[in] hess Hessenberg decomposition
HessenbergDecompositionMatrixHReturnType ( const HessenbergDecomposition< MatrixType > &  hess  )  [inline]

Constructor.

Parameters:
[in] hess Hessenberg decomposition

Member Function Documentation

void evalTo ( ResultType &  result  )  const [inline]

Hessenberg matrix in decomposition.

Parameters:
[out] result Hessenberg matrix in decomposition hess which was passed to the constructor
void evalTo ( ResultType &  result  )  const [inline]

Hessenberg matrix in decomposition.

Parameters:
[out] result Hessenberg matrix in decomposition hess which was passed to the constructor
void evalTo ( ResultType &  result  )  const [inline]

Hessenberg matrix in decomposition.

Parameters:
[out] result Hessenberg matrix in decomposition hess which was passed to the constructor
void evalTo ( ResultType &  result  )  const [inline]

Hessenberg matrix in decomposition.

Parameters:
[out] result Hessenberg matrix in decomposition hess which was passed to the constructor
void evalTo ( ResultType &  result  )  const [inline]

Hessenberg matrix in decomposition.

Parameters:
[out] result Hessenberg matrix in decomposition hess which was passed to the constructor

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

Generated on 15 Aug 2012 for Eigen by  doxygen 1.6.1