aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/QuickStartGuide.dox
diff options
context:
space:
mode:
authorGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2008-11-03 19:14:17 +0000
committerGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2008-11-03 19:14:17 +0000
commit3d90c139706daccce577f5f2960ceb98a42871a3 (patch)
treef3c8c501a9d66e183a297b94a5b2362511e14161 /doc/QuickStartGuide.dox
parent3f580e240e2a3018c7e040e4c4cfc9541c84166d (diff)
norm2() renamed to squaredNorm(), kept as deprecated for now.
Diffstat (limited to 'doc/QuickStartGuide.dox')
-rw-r--r--doc/QuickStartGuide.dox6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/QuickStartGuide.dox b/doc/QuickStartGuide.dox
index 1d2f623b3..c46698dbf 100644
--- a/doc/QuickStartGuide.dox
+++ b/doc/QuickStartGuide.dox
@@ -352,7 +352,7 @@ vec3 = vec1.cross(vec2);\endcode</td></tr>
Eigen provides several reduction methods such as:
\link MatrixBase::minCoeff() minCoeff() \endlink, \link MatrixBase::maxCoeff() maxCoeff() \endlink,
\link MatrixBase::sum() sum() \endlink, \link MatrixBase::trace() trace() \endlink,
-\link MatrixBase::norm() norm() \endlink, \link MatrixBase::norm2() norm2() \endlink,
+\link MatrixBase::norm() norm() \endlink, \link MatrixBase::squaredNorm() squaredNorm() \endlink,
\link MatrixBase::all() all() \endlink,and \link MatrixBase::any() any() \endlink.
All reduction operations can be done matrix-wise,
\link MatrixBase::colwise() column-wise \endlink or
@@ -473,8 +473,8 @@ mat3 = mat1.adjoint() * mat2;
</td></tr>
<tr><td>
\link MatrixBase::norm() norm \endlink of a vector \n
-\link MatrixBase::norm2() squared norm \endlink of a vector
-</td><td>\code vec.norm(); \endcode \n \code vec.norm2() \endcode
+\link MatrixBase::squaredNorm() squared norm \endlink of a vector
+</td><td>\code vec.norm(); \endcode \n \code vec.squaredNorm() \endcode
</td></tr>
<tr><td>
returns a \link MatrixBase::normalized() normalized \endlink vector \n