note that norm2() is *not* an l2 norm as it is in other APIs

This commit is contained in:
Scott Wheeler 2008-10-11 21:01:59 +00:00
parent 8466244faa
commit e80d6a95d9

View File

@ -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
*