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

List of all members.

Public Types
typedef MatrixType::Index	Index
Public Member Functions
Index	cols () const
template<typename ResultType >
void	evalTo (ResultType &result) const
	Hessenberg matrix in decomposition.
	HessenbergDecompositionMatrixHReturnType (const HessenbergDecomposition< MatrixType > &hess)
	Constructor.
Index	rows () const
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 337 of file HessenbergDecomposition.h.

---

Member Typedef Documentation

template<typename MatrixType >

typedef MatrixType::Index Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::Index

Definition at line 340 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.

---

Member Function Documentation

template<typename MatrixType >

Index Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::cols

(

void

)

const [inline]

Reimplemented from Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >.

Definition at line 363 of file HessenbergDecomposition.h.

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.

template<typename MatrixType >

Index Eigen::internal::HessenbergDecompositionMatrixHReturnType< MatrixType >::rows

(

void

)

const [inline]

Reimplemented from Eigen::ReturnByValue< HessenbergDecompositionMatrixHReturnType< MatrixType > >.

Definition at line 362 of file HessenbergDecomposition.h.

---

Member Data Documentation

template<typename MatrixType >

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

Definition at line 366 of file HessenbergDecomposition.h.

---

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

• HessenbergDecomposition.h