From 046a84c0efa2d7e32ceba4ea90127a5b188f9de4 Mon Sep 17 00:00:00 2001 From: Benoit Jacob Date: Tue, 27 Jan 2009 14:05:20 +0000 Subject: [PATCH] fix doc for norm() and squaredNorm(): these are not only for vectors --- Eigen/src/Core/Dot.h | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/Eigen/src/Core/Dot.h b/Eigen/src/Core/Dot.h index 4263a27c5..5838af70d 100644 --- a/Eigen/src/Core/Dot.h +++ b/Eigen/src/Core/Dot.h @@ -269,9 +269,7 @@ MatrixBase::dot(const MatrixBase& other) const return ei_dot_impl::run(derived(), other.derived()); } -/** \returns the squared norm of *this, i.e. the dot product of *this with itself. - * - * \only_for_vectors +/** \returns the squared \em l2 norm of *this, i.e., for vectors, the dot product of *this with itself. * * \sa dot(), norm() */ @@ -281,9 +279,7 @@ inline typename NumTraits::Scalar>::Real MatrixBase< return ei_real((*this).cwise().abs2().sum()); } -/** \returns the \em l2 norm of *this, i.e. the square root of the dot product of *this with itself. - * - * \only_for_vectors +/** \returns the \em l2 norm of *this, i.e., for vectors, the square root of the dot product of *this with itself. * * \sa dot(), squaredNorm() */