diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2017-01-04 22:01:50 +0100 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2017-01-04 22:01:50 +0100 |
| commit | 29a1a58113e3978ce12b8592b7f2f2184e20ec81 (patch) | |
| tree | 6e7a6fca831b3bd66ac12d7adfb7e8b6a34386f1 /Eigen/src/Core/SelfAdjointView.h | |
| parent | a5ebc92f8d6ec99c866626789de263e4b0d4c62b (diff) | |
Document selfadjointView
Diffstat (limited to 'Eigen/src/Core/SelfAdjointView.h')
| -rw-r--r-- | Eigen/src/Core/SelfAdjointView.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Eigen/src/Core/SelfAdjointView.h b/Eigen/src/Core/SelfAdjointView.h index 06484ab30..504c98f0e 100644 --- a/Eigen/src/Core/SelfAdjointView.h +++ b/Eigen/src/Core/SelfAdjointView.h @@ -319,6 +319,7 @@ public: * Implementation of MatrixBase methods ***************************************************************************/ +/** This is the const version of MatrixBase::selfadjointView() */ template<typename Derived> template<unsigned int UpLo> typename MatrixBase<Derived>::template ConstSelfAdjointViewReturnType<UpLo>::Type @@ -327,6 +328,15 @@ MatrixBase<Derived>::selfadjointView() const return typename ConstSelfAdjointViewReturnType<UpLo>::Type(derived()); } +/** \returns an expression of a symmetric/self-adjoint view extracted from the upper or lower triangular part of the current matrix + * + * The parameter \a UpLo can be either \c #Upper or \c #Lower + * + * Example: \include MatrixBase_selfadjointView.cpp + * Output: \verbinclude MatrixBase_selfadjointView.out + * + * \sa class SelfAdjointView + */ template<typename Derived> template<unsigned int UpLo> typename MatrixBase<Derived>::template SelfAdjointViewReturnType<UpLo>::Type |