Public Types | Public Member Functions | Protected Attributes

Map< Quaternion< _Scalar >, PacketAccess > Class Template Reference

Expression of a quaternion from a memory buffer. More...

#include <Quaternion.h>

Inheritance diagram for Map< Quaternion< _Scalar >, PacketAccess >:
QuaternionBase< Map< Quaternion< _Scalar >, PacketAccess > > RotationBase< Map< Quaternion< _Scalar >, PacketAccess >, 3 >

List of all members.

Public Types

typedef _Scalar Scalar
typedef internal::traits< Map >
::Coefficients 
Coefficients

Public Member Functions

EIGEN_STRONG_INLINE Map (Scalar *coeffs)
Coefficientscoeffs ()
const Coefficientscoeffs () const

Protected Attributes

Coefficients m_coeffs

Detailed Description

template<typename _Scalar, int PacketAccess>
class Map< Quaternion< _Scalar >, PacketAccess >

Expression of a quaternion from a memory buffer.

Parameters:
_Scalar the type of the Quaternion coefficients
PacketAccess see class Map

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.

See also:
class Map, class Quaternion, class QuaternionBase

Member Typedef Documentation

template<typename _Scalar , int PacketAccess>
typedef internal::traits<Map>::Coefficients Map< Quaternion< _Scalar >, PacketAccess >::Coefficients
template<typename _Scalar , int PacketAccess>
typedef _Scalar Map< Quaternion< _Scalar >, PacketAccess >::Scalar

the scalar type of the coefficients

Reimplemented from QuaternionBase< Map< Quaternion< _Scalar >, PacketAccess > >.


Constructor & Destructor Documentation

template<typename _Scalar , int PacketAccess>
EIGEN_STRONG_INLINE Map< Quaternion< _Scalar >, PacketAccess >::Map ( Scalar coeffs  )  [inline]

Constructs a Mapped Quaternion object from the pointer coeffs

The pointer coeffs must reference the four coeffecients of Quaternion in the following order:

 *coeffs == {x, y, z, w} 

If the template parameter PacketAccess is set to Aligned, then the pointer coeffs must be aligned.


Member Function Documentation

template<typename _Scalar , int PacketAccess>
Coefficients& Map< Quaternion< _Scalar >, PacketAccess >::coeffs (  )  [inline]
Returns:
a vector expression of the coefficients (x,y,z,w)

Reimplemented from QuaternionBase< Map< Quaternion< _Scalar >, PacketAccess > >.

template<typename _Scalar , int PacketAccess>
const Coefficients& Map< Quaternion< _Scalar >, PacketAccess >::coeffs (  )  const [inline]
Returns:
a read-only vector expression of the coefficients (x,y,z,w)

Reimplemented from QuaternionBase< Map< Quaternion< _Scalar >, PacketAccess > >.


Member Data Documentation

template<typename _Scalar , int PacketAccess>
Coefficients Map< Quaternion< _Scalar >, PacketAccess >::m_coeffs [protected]

The documentation for this class was generated from the following file: