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 @@ -271,6 +271,8 @@ MatrixBase::dot(const MatrixBase& 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 * @@ -282,7 +284,7 @@ inline typename NumTraits::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 *