From e80d6a95d94916a4ea4a40dd2bf2aeda9103fb0d Mon Sep 17 00:00:00 2001
From: Scott Wheeler <wheeler@kde.org>
Date: Sat, 11 Oct 2008 21:01:59 +0000
Subject: note that norm2() is *not* an l2 norm as it is in other APIs

---
 Eigen/src/Core/Dot.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

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<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
   *
@@ -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
   *
-- 
cgit v1.2.3