diff options
author | Gael Guennebaud <g.gael@free.fr> | 2011-06-18 08:30:34 +0200 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2011-06-18 08:30:34 +0200 |
commit | a55c27a15f8a34a6479f0032ae1fa72b1207a065 (patch) | |
tree | bbfba4780ed034d6b8c6e8e0c44ea77b32d2650a /Eigen/src/Core/Dot.h | |
parent | 642d452921c618a2905db5879c6cb0eba8a3cbf4 (diff) |
fix documentation of norm
Diffstat (limited to 'Eigen/src/Core/Dot.h')
-rw-r--r-- | Eigen/src/Core/Dot.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Eigen/src/Core/Dot.h b/Eigen/src/Core/Dot.h index 6e83191c5..42da78498 100644 --- a/Eigen/src/Core/Dot.h +++ b/Eigen/src/Core/Dot.h @@ -116,7 +116,9 @@ MatrixBase<Derived>::eigen2_dot(const MatrixBase<OtherDerived>& other) const //---------- implementation of L2 norm and related functions ---------- -/** \returns the squared \em l2 norm of *this, i.e., for vectors, the dot product of *this with itself. +/** \returns, for vectors, the squared \em l2 norm of \c *this, and for matrices the Frobenius norm. + * In both cases, it consists in the sum of the square of all the matrix entries. + * For vectors, this is also equals to the dot product of \c *this with itself. * * \sa dot(), norm() */ @@ -126,7 +128,9 @@ EIGEN_STRONG_INLINE typename NumTraits<typename internal::traits<Derived>::Scala return internal::real((*this).cwiseAbs2().sum()); } -/** \returns the \em l2 norm of *this, i.e., for vectors, the square root of the dot product of *this with itself. +/** \returns, for vectors, the \em l2 norm of \c *this, and for matrices the Frobenius norm. + * In both cases, it consists in the square root of the sum of the square of all the matrix entries. + * For vectors, this is also equals to the square root of the dot product of \c *this with itself. * * \sa dot(), squaredNorm() */ |