Add cholesky's members to MatrixBase

Various documentation improvements including new snippets (AngleAxis and Cholesky)
This commit is contained in:
Gael Guennebaud
2008-07-19 22:59:05 +00:00
parent 6e2c53e056
commit 269f683902
11 changed files with 58 additions and 7 deletions

View File

@@ -29,7 +29,7 @@
*
* \class AngleAxis
*
* \brief Represents a 3D rotation as a rotation angle around an arbitray 3D axis
* \brief Represents a 3D rotation as a rotation angle around an arbitrary 3D axis
*
* \param _Scalar the scalar type, i.e., the type of the coefficients.
*
@@ -37,7 +37,14 @@
* \li \c AngleAxisf for \c float
* \li \c AngleAxisd for \c double
*
* \sa class Quaternion, class Transform
* \addexample AngleAxisForEuler \label How to define a rotation from Euler-angles
*
* Combined with MatrixBase::Unit{X,Y,Z}, AngleAxis can be used to easily
* mimic Euler-angles. Here is an example:
* \include AngleAxis_mimic_euler.cpp
* Output: \verbinclude AngleAxis_mimic_euler.out
*
* \sa class Quaternion, class Transform, MatrixBase::UnitX()
*/
template<typename _Scalar>
class AngleAxis