diff options
author | Carlos Becker <carlosbecker@gmail.com> | 2010-06-28 18:38:28 +0100 |
---|---|---|
committer | Carlos Becker <carlosbecker@gmail.com> | 2010-06-28 18:38:28 +0100 |
commit | bdef7eb656f8bb5dcb2b6a81579552d673ce8caf (patch) | |
tree | 313f03db2e2541f9154e6e2ea5765b5bc33f7958 /Eigen/src/Core | |
parent | 086ad93295446d8bcb52d592d1053f1ecae8f995 (diff) |
Added doxygen info for .matrix() and .array()
Diffstat (limited to 'Eigen/src/Core')
-rw-r--r-- | Eigen/src/Core/ArrayBase.h | 2 | ||||
-rw-r--r-- | Eigen/src/Core/MatrixBase.h | 2 |
2 files changed, 4 insertions, 0 deletions
diff --git a/Eigen/src/Core/ArrayBase.h b/Eigen/src/Core/ArrayBase.h index 26d24a4f6..20782e2cf 100644 --- a/Eigen/src/Core/ArrayBase.h +++ b/Eigen/src/Core/ArrayBase.h @@ -151,6 +151,8 @@ template<typename Derived> class ArrayBase ArrayBase<Derived>& array() { return *this; } const ArrayBase<Derived>& array() const { return *this; } + /** \returns an \link MatrixBase Matrix \endlink expression of this array + * \sa MatrixBase::array() */ MatrixWrapper<Derived> matrix() { return derived(); } const MatrixWrapper<Derived> matrix() const { return derived(); } diff --git a/Eigen/src/Core/MatrixBase.h b/Eigen/src/Core/MatrixBase.h index 31199e7ac..94ddb8691 100644 --- a/Eigen/src/Core/MatrixBase.h +++ b/Eigen/src/Core/MatrixBase.h @@ -286,6 +286,8 @@ template<typename Derived> class MatrixBase MatrixBase<Derived>& matrix() { return *this; } const MatrixBase<Derived>& matrix() const { return *this; } + /** \returns an \link ArrayBase Array \endlink expression of this matrix + * \sa ArrayBase::matrix() */ ArrayWrapper<Derived> array() { return derived(); } const ArrayWrapper<Derived> array() const { return derived(); } |