diff options
| author |  Hauke Heibel <hauke.heibel@gmail.com> | 2010-01-14 10:10:07 +0100 |
|---|---|---|
| committer | Hauke Heibel <hauke.heibel@gmail.com> | 2010-01-14 10:10:07 +0100 |
| commit | 814659c201b260a920e4b213b676b81af4c1e43a (patch) | |
| tree | 8afcf168f4fba42e9470eff61131469478cb384d /Eigen/src/Core/MatrixBase.h | |
| parent | 624902f559b36a0e1cef05126282dec1c848a8df (diff) | |
Changed parts of the documentation.
The param keyword is now tparam (in Matrix).
Made PlainMatrixType non-internal (currently MatrixBase only); I think this is an important typedef in particular when writing your own template methods.
Diffstat (limited to 'Eigen/src/Core/MatrixBase.h')
| -rw-r--r-- | Eigen/src/Core/MatrixBase.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/Eigen/src/Core/MatrixBase.h b/Eigen/src/Core/MatrixBase.h index 7569dab58..41c3581b6 100644 --- a/Eigen/src/Core/MatrixBase.h +++ b/Eigen/src/Core/MatrixBase.h @@ -117,13 +117,12 @@ template<typename Derived> class MatrixBase * \sa rows(), cols(), SizeAtCompileTime. */ inline int diagonalSize() const { return std::min(rows(),cols()); } -#ifndef EIGEN_PARSED_BY_DOXYGEN - /** \internal the plain matrix type corresponding to this expression. Note that is not necessarily - * exactly the return type of eval(): in the case of plain matrices, the return type of eval() is a const - * reference to a matrix, not a matrix! It is however guaranteed that the return type of eval() is either - * PlainMatrixType or const PlainMatrixType&. + /** \brief The plain matrix type corresponding to this expression. + * + * This is not necessarily exactly the return type of eval(). In the case of plain matrices, + * the return type of eval() is a const reference to a matrix, not a matrix! It is however guaranteed + * that the return type of eval() is either PlainMatrixType or const PlainMatrixType&. */ -// typedef typename ei_plain_matrix_type<Derived>::type PlainMatrixType; typedef Matrix<typename ei_traits<Derived>::Scalar, ei_traits<Derived>::RowsAtCompileTime, ei_traits<Derived>::ColsAtCompileTime, @@ -131,7 +130,9 @@ template<typename Derived> class MatrixBase ei_traits<Derived>::MaxRowsAtCompileTime, ei_traits<Derived>::MaxColsAtCompileTime > PlainMatrixType; + // typedef typename ei_plain_matrix_type<Derived>::type PlainMatrixType; +#ifndef EIGEN_PARSED_BY_DOXYGEN /** \internal Represents a matrix with all coefficients equal to one another*/ typedef CwiseNullaryOp<ei_scalar_constant_op<Scalar>,Derived> ConstantReturnType; /** \internal the return type of MatrixBase::adjoint() */ |