diff --git a/Eigen/src/Core/Array.h b/Eigen/src/Core/Array.h index 61e1950eb..e099647df 100644 --- a/Eigen/src/Core/Array.h +++ b/Eigen/src/Core/Array.h @@ -266,7 +266,7 @@ class Array #define EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, Size, SizeSuffix) \ /** \ingroup arraytypedefs */ \ typedef Array Array##SizeSuffix##SizeSuffix##TypeSuffix; \ -/** \ingroup matrixtypedefs */ \ +/** \ingroup arraytypedefs */ \ typedef Array Array##SizeSuffix##TypeSuffix; #define EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, Size) \ diff --git a/Eigen/src/Core/CwiseNullaryOp.h b/Eigen/src/Core/CwiseNullaryOp.h index 97331fa26..a7e6b1b6d 100644 --- a/Eigen/src/Core/CwiseNullaryOp.h +++ b/Eigen/src/Core/CwiseNullaryOp.h @@ -251,7 +251,7 @@ DenseBase::LinSpaced(Sequential_t, Index size, const Scalar& low, const } /** - * \copydoc DenseBase::LinSpaced(Sequential_t, Index, const Scalar&, const Scalar&) + * \copydoc DenseBase::LinSpaced(Sequential_t, Index, const Scalar&, const Scalar&) * Special version for fixed size types which does not require the size parameter. */ template @@ -284,7 +284,7 @@ DenseBase::LinSpaced(Index size, const Scalar& low, const Scalar& high) } /** - * \copydoc DenseBase::LinSpaced(Index, const Scalar&, const Scalar&) + * \copydoc DenseBase::LinSpaced(Index, const Scalar&, const Scalar&) * Special version for fixed size types which does not require the size parameter. */ template @@ -359,6 +359,7 @@ DenseStorageBase::setConstant(Index size, const Scalar& value) * * \param rows the new number of rows * \param cols the new number of columns + * \param value the value to which all coefficients are set * * Example: \include Matrix_setConstant_int_int.cpp * Output: \verbinclude Matrix_setConstant_int_int.out diff --git a/Eigen/src/Core/DenseBase.h b/Eigen/src/Core/DenseBase.h index d4dfb0e49..a00b791cd 100644 --- a/Eigen/src/Core/DenseBase.h +++ b/Eigen/src/Core/DenseBase.h @@ -45,14 +45,13 @@ template class DenseBase #endif // not EIGEN_PARSED_BY_DOXYGEN { public: -#ifndef EIGEN_PARSED_BY_DOXYGEN using ei_special_scalar_op_base::Scalar, typename NumTraits::Scalar>::Real>::operator*; class InnerIterator; typedef typename ei_traits::StorageKind StorageKind; - typedef typename ei_traits::Index Index; + typedef typename ei_traits::Index Index; /**< The type of indices */ typedef typename ei_traits::Scalar Scalar; typedef typename ei_packet_traits::type PacketScalar; typedef typename NumTraits::Real RealScalar; @@ -90,8 +89,6 @@ template class DenseBase using Base::colStride; using typename Base::CoeffReturnType; -#endif // not EIGEN_PARSED_BY_DOXYGEN - enum { RowsAtCompileTime = ei_traits::RowsAtCompileTime, diff --git a/Eigen/src/Core/SelfAdjointView.h b/Eigen/src/Core/SelfAdjointView.h index bb8ab168d..d72a94e15 100644 --- a/Eigen/src/Core/SelfAdjointView.h +++ b/Eigen/src/Core/SelfAdjointView.h @@ -65,7 +65,10 @@ template class SelfAdjointView public: typedef TriangularBase Base; - typedef typename ei_traits::Scalar Scalar; + + /** \brief The type of coefficients in this matrix */ + typedef typename ei_traits::Scalar Scalar; + typedef typename MatrixType::Index Index; enum { diff --git a/Eigen/src/Geometry/Homogeneous.h b/Eigen/src/Geometry/Homogeneous.h index 73266320e..5c10e9bcf 100644 --- a/Eigen/src/Geometry/Homogeneous.h +++ b/Eigen/src/Geometry/Homogeneous.h @@ -135,7 +135,7 @@ template class Homogeneous * * \return an expression of the equivalent homogeneous vector * - * \vectoronly + * \only_for_vectors * * Example: \include MatrixBase_homogeneous.cpp * Output: \verbinclude MatrixBase_homogeneous.out diff --git a/Eigen/src/Geometry/Quaternion.h b/Eigen/src/Geometry/Quaternion.h index 355b12ce8..78365cd38 100644 --- a/Eigen/src/Geometry/Quaternion.h +++ b/Eigen/src/Geometry/Quaternion.h @@ -277,19 +277,6 @@ typedef Quaternion Quaterniond; * Specialization of Map> ***************************************************************************/ -/** \class Map - * - * - * \brief Expression of a quaternion from a memory buffer - * - * \param _Scalar the type of the Quaternion coefficients - * \param PacketAccess see class Map - * - * This is a specialization of class Map for Quaternion. This class allows to view - * a 4 scalar memory buffer as an Eigen's Quaternion object. - * - * \sa class Map, class Quaternion, class QuaternionBase - */ template struct ei_traits, _PacketAccess> >: ei_traits > @@ -301,6 +288,16 @@ ei_traits > }; }; +/** \brief Expression of a quaternion from a memory buffer + * + * \param _Scalar the type of the Quaternion coefficients + * \param PacketAccess see class Map + * + * This is a specialization of class Map for Quaternion. This class allows to view + * a 4 scalar memory buffer as an Eigen's Quaternion object. + * + * \sa class Map, class Quaternion, class QuaternionBase + */ template class Map, PacketAccess > : public QuaternionBase, PacketAccess> > diff --git a/Eigen/src/Geometry/Transform.h b/Eigen/src/Geometry/Transform.h index bc9ccb3e6..70d172c10 100644 --- a/Eigen/src/Geometry/Transform.h +++ b/Eigen/src/Geometry/Transform.h @@ -914,7 +914,7 @@ struct ei_projective_transform_inverse * \returns the inverse transformation according to some given knowledge * on \c *this. * - * \param traits allows to optimize the inversion process when the transformation + * \param hint allows to optimize the inversion process when the transformation * is known to be not a general transformation. The possible values are: * - Projective if the transformation is not necessarily affine, i.e., if the * last row is not guaranteed to be [0 ... 0 1] diff --git a/doc/C05_TutorialAdvancedInitialization.dox b/doc/C05_TutorialAdvancedInitialization.dox index 96105f6a6..db84f94a7 100644 --- a/doc/C05_TutorialAdvancedInitialization.dox +++ b/doc/C05_TutorialAdvancedInitialization.dox @@ -87,7 +87,7 @@ Output: \verbinclude Tutorial_AdvancedInitialization_LinSpaced.out This example shows that objects like the ones returned by LinSpaced() can be assigned to variables (and expressions). Eigen defines utility functions like \link DenseBase::setZero() setZero()\endlink, -\link MatrixBase::setIdentity() \endlink and \link DenseBase:setLinSpaced() \endlink to do this +\link MatrixBase::setIdentity() \endlink and \link DenseBase::setLinSpaced() \endlink to do this conveniently. The following example contrasts three ways to construct the matrix \f$ J = \bigl[ \begin{smallmatrix} O & I \\ I & O \end{smallmatrix} \bigr] \f$: using static methods and assignment, using static methods and the comma-initializer, or using the setXxx() methods. diff --git a/doc/C07_TutorialReductionsVisitorsBroadcasting.dox b/doc/C07_TutorialReductionsVisitorsBroadcasting.dox index c26cd90ef..80b95a63b 100644 --- a/doc/C07_TutorialReductionsVisitorsBroadcasting.dox +++ b/doc/C07_TutorialReductionsVisitorsBroadcasting.dox @@ -37,7 +37,7 @@ The \em trace of a matrix, as returned by the function \c trace(), is the sum of \subsection TutorialReductionsVisitorsBroadcastingReductionsNorm Norm reductions -Eigen also provides reductions to obtain the Euclidean norm or squared norm of a vector with \link MatrixBase::norm() norm() \endlink and \link Matrix::squaredNorm() squaredNorm() \endlink respectively. +Eigen also provides reductions to obtain the Euclidean norm or squared norm of a vector with \link MatrixBase::norm() norm() \endlink and \link MatrixBase::squaredNorm() squaredNorm() \endlink respectively. These operations can also operate on matrices; in that case, they use the Frobenius norm. The following example shows these methods. + \link DenseBase::block(Index,Index,Index,Index) (more) \endlink + \link DenseBase::block(Index,Index) (more) \endlink - +
@@ -190,7 +190,7 @@ reductions and partial reductions. Now that broadcasting, reductions and partial reductions have been introduced, we can dive into a more advanced example that finds the nearest neighbour of a vector v within the columns of matrix m. The Euclidean distance will be used in this example, -computing the squared Euclidean distance with the partial reduction named \link DenseBase::squaredNorm() squaredNorm() \endlink: +computing the squared Euclidean distance with the partial reduction named \link MatrixBase::squaredNorm() squaredNorm() \endlink:
Example: \include Tutorial_ReductionsVisitorsBroadcasting_broadcast_1nn.cpp diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index 0f6886f75..73873da1a 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -457,7 +457,7 @@ mat = 2 7 8 \endcode
-Special versions of \link DenseBase::minCoeff(int*,int*) minCoeff \endlink and \link DenseBase::maxCoeff(int*,int*) maxCoeff \endlink: +Special versions of \link DenseBase::minCoeff(Index*,Index*) minCoeff \endlink and \link DenseBase::maxCoeff(Index*,Index*) maxCoeff \endlink:
\code int i, j; @@ -476,8 +476,8 @@ if((array1 < array2).any()) ... // if there exist a pair i,j such that array1(i, top\section QuickRef_Blocks Sub-matrices -Read-write access to a \link DenseBase::col(int) column \endlink -or a \link DenseBase::row(int) row \endlink of a matrix (or array): +Read-write access to a \link DenseBase::col(Index) column \endlink +or a \link DenseBase::row(Index) row \endlink of a matrix (or array):
\code mat1.row(i) = mat2.col(j); @@ -501,9 +501,9 @@ Read-write access to sub-vectors: Read-write access to sub-matrices:
\code mat1.block(i,j,rows,cols)\endcode - \link DenseBase::block(int,int,int,int) (more) \endlink \code mat1.block(i,j)\endcode - \link DenseBase::block(int,int) (more) \endlink the \c rows x \c cols sub-matrix \n starting from position (\c i,\c j)
\code mat1.topLeftCorner(rows,cols) @@ -547,7 +547,7 @@ Declare a diagonal matrix\code DiagonalMatrix diag1(size); diag1.diagonal() = vector;\endcode
Access the \link MatrixBase::diagonal() diagonal \endlink and \link MatrixBase::diagonal(int) super/sub diagonals \endlink of a matrix as a vector (read/write)
Access the \link MatrixBase::diagonal() diagonal \endlink and \link MatrixBase::diagonal(Index) super/sub diagonals \endlink of a matrix as a vector (read/write) \code vec1 = mat1.diagonal(); mat1.diagonal() = vec1; // main diagonal vec1 = mat1.diagonal(+n); mat1.diagonal(+n) = vec1; // n-th super diagonal