Public Types | Public Member Functions | Protected Attributes

internal::HessenbergDecompositionMatrixHReturnType< MatrixType > Struct Template Reference

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

#include <HessenbergDecomposition.h>

Inheritance diagram for internal::HessenbergDecompositionMatrixHReturnType< MatrixType >:
ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > > type

List of all members.

Public Types

typedef MatrixType::Index Index

Public Member Functions

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

Protected Attributes

const HessenbergDecomposition
< MatrixType > & 
m_hess

Detailed Description

template<typename MatrixType>
struct 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.


Member Typedef Documentation

template<typename MatrixType >
typedef MatrixType::Index internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::Index

Constructor & Destructor Documentation

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

Constructor.

Parameters:
[in] hess Hessenberg decomposition

Member Function Documentation

template<typename MatrixType >
Index internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::cols ( void   )  const [inline]
template<typename MatrixType >
template<typename ResultType >
void 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
template<typename MatrixType >
Index internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::rows ( void   )  const [inline]

Member Data Documentation

template<typename MatrixType >
const HessenbergDecomposition<MatrixType>& internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::m_hess [protected]

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