diff options
Diffstat (limited to 'Eigen/src/Core')
| -rw-r--r-- | Eigen/src/Core/Dot.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Eigen/src/Core/Dot.h b/Eigen/src/Core/Dot.h index 4a729aaea..eda266021 100644 --- a/Eigen/src/Core/Dot.h +++ b/Eigen/src/Core/Dot.h @@ -272,6 +272,8 @@ MatrixBase<Derived>::dot(const MatrixBase<OtherDerived>& other) const /** \returns the squared norm of *this, i.e. the dot product of *this with itself. * + * \note This is \em not the \em l2 norm. + * * \only_for_vectors * * \sa dot(), norm() @@ -282,7 +284,7 @@ inline typename NumTraits<typename ei_traits<Derived>::Scalar>::Real MatrixBase< return ei_real(dot(*this)); } -/** \returns the norm of *this, i.e. the square root of the dot product of *this with itself. +/** \returns the \em l2 norm of *this, i.e. the square root of the dot product of *this with itself. * * \only_for_vectors * |