GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-09-25 15:53:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix doc for norm() and squaredNorm(): these are not only for vectors

Browse Source
This commit is contained in:
Benoit Jacob 2009-01-27 14:05:20 +00:00
parent d7f60257dd
commit 046a84c0ef
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Eigen/src/Core/Dot.h
View File

@ -269,9 +269,7 @@ MatrixBase<Derived>::dot(const MatrixBase<OtherDerived>& other) const
return ei_dot_impl<Derived, OtherDerived>::run(derived(), other.derived()); return ei_dot_impl<Derived, OtherDerived>::run(derived(), other.derived());
} }
/** \returns the squared norm of *this, i.e. the dot product of *this with itself. /** \returns the squared \em l2 norm of *this, i.e., for vectors, the dot product of *this with itself.
*
* \only_for_vectors
* *
* \sa dot(), norm() * \sa dot(), norm()
*/ */
@ -281,9 +279,7 @@ inline typename NumTraits<typename ei_traits<Derived>::Scalar>::Real MatrixBase<
return ei_real((*this).cwise().abs2().sum()); 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. /** \returns the \em l2 norm of *this, i.e., for vectors, the square root of the dot product of *this with itself.
*
* \only_for_vectors
* *
* \sa dot(), squaredNorm() * \sa dot(), squaredNorm()
*/ */