GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-08-03 18:50:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Some minor documentation fixes in Quaternion

Browse Source 
(transplanted from fb89b662290857ab2133613cd9a84cc532720da4
)
This commit is contained in:
Gael Guennebaud 2013-01-20 10:20:39 +01:00
parent 27f6fd3a50
commit 41070aad7b
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Eigen/src/Geometry/Quaternion.h
View File

@ -200,7 +200,8 @@ public:
* *
* \brief The quaternion class used to represent 3D orientations and rotations * \brief The quaternion class used to represent 3D orientations and rotations
* *
* \param _Scalar the scalar type, i.e., the type of the coefficients * \tparam _Scalar the scalar type, i.e., the type of the coefficients
* \tparam _Options controls the memory alignement of the coeffecients. Can be \# AutoAlign or \# DontAlign. Default is AutoAlign.
* *
* This class represents a quaternion \f$ w+xi+yj+zk \f$ that is a convenient representation of * This class represents a quaternion \f$ w+xi+yj+zk \f$ that is a convenient representation of
* orientations and rotations of objects in three dimensions. Compared to other representations * orientations and rotations of objects in three dimensions. Compared to other representations
@ -308,8 +309,7 @@ typedef Quaternion<double> Quaterniond;
namespace internal { namespace internal {
template<typename _Scalar, int _Options> template<typename _Scalar, int _Options>
struct traits<Map<Quaternion<_Scalar>, _Options> >: struct traits<Map<Quaternion<_Scalar>, _Options> > : traits<Quaternion<_Scalar, _Options> >
traits<Quaternion<_Scalar, _Options> >
{ {
typedef _Scalar Scalar; typedef _Scalar Scalar;
typedef Map<Matrix<_Scalar,4,1>, _Options> Coefficients; typedef Map<Matrix<_Scalar,4,1>, _Options> Coefficients;
@ -317,7 +317,6 @@ namespace internal {
typedef traits<Quaternion<_Scalar, _Options> > TraitsBase; typedef traits<Quaternion<_Scalar, _Options> > TraitsBase;
enum { enum {
IsAligned = TraitsBase::IsAligned, IsAligned = TraitsBase::IsAligned,
Flags = TraitsBase::Flags Flags = TraitsBase::Flags
}; };
}; };
@ -325,8 +324,7 @@ namespace internal {
namespace internal { namespace internal {
template<typename _Scalar, int _Options> template<typename _Scalar, int _Options>
struct traits<Map<const Quaternion<_Scalar>, _Options> >: struct traits<Map<const Quaternion<_Scalar>, _Options> > : traits<Quaternion<_Scalar> >
traits<Quaternion<_Scalar> >
{ {
typedef _Scalar Scalar; typedef _Scalar Scalar;
typedef Map<const Matrix<_Scalar,4,1>, _Options> Coefficients; typedef Map<const Matrix<_Scalar,4,1>, _Options> Coefficients;
@ -339,10 +337,11 @@ namespace internal {
}; };
} }
/** \brief Quaternion expression mapping a constant memory buffer /** \ingroup Geometry_Module
* \brief Quaternion expression mapping a constant memory buffer
* *
* \param _Scalar the type of the Quaternion coefficients * \tparam _Scalar the type of the Quaternion coefficients
* \param _Options see class Map * \tparam _Options see class Map
* *
* This is a specialization of class Map for Quaternion. This class allows to view * This is a specialization of class Map for Quaternion. This class allows to view
* a 4 scalar memory buffer as an Eigen's Quaternion object. * a 4 scalar memory buffer as an Eigen's Quaternion object.
@ -375,10 +374,11 @@ class Map<const Quaternion<_Scalar>, _Options >
const Coefficients m_coeffs; const Coefficients m_coeffs;
}; };
/** \brief Expression of a quaternion from a memory buffer /** \ingroup Geometry_Module
* \brief Expression of a quaternion from a memory buffer
* *
* \param _Scalar the type of the Quaternion coefficients * \tparam _Scalar the type of the Quaternion coefficients
* \param _Options see class Map * \tparam _Options see class Map
* *
* This is a specialization of class Map for Quaternion. This class allows to view * This is a specialization of class Map for Quaternion. This class allows to view
* a 4 scalar memory buffer as an Eigen's Quaternion object. * a 4 scalar memory buffer as an Eigen's Quaternion object.