Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Attributes | Private Types

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


Detailed Description

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

Quaternion expression mapping a constant memory buffer.

Parameters:
_Scalarthe type of the Quaternion coefficients
PacketAccesssee 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

Definition at line 312 of file Quaternion.h.

#include <src/Geometry/Quaternion.h>

Inheritance diagram for Map< const Quaternion< _Scalar >, PacketAccess >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef _Scalar Scalar
 the scalar type of the coefficients
typedef internal::traits< Map >
::Coefficients 
Coefficients

Public Member Functions

EIGEN_STRONG_INLINE Map (const Scalar *coeffs)
 Constructs a Mapped Quaternion object from the pointer coeffs.
const Coefficientscoeffs () const

Protected Attributes

const Coefficients m_coeffs

Private Types

typedef QuaternionBase< Map
< Quaternion< _Scalar >
, PacketAccess > > 
Base

Member Typedef Documentation

template<typename _Scalar , int PacketAccess>
typedef QuaternionBase<Map<Quaternion<_Scalar>, PacketAccess> > Map< const Quaternion< _Scalar >, PacketAccess >::Base [private]
template<typename _Scalar , int PacketAccess>
typedef internal::traits<Map>::Coefficients Map< const Quaternion< _Scalar >, PacketAccess >::Coefficients
template<typename _Scalar , int PacketAccess>
typedef _Scalar Map< const Quaternion< _Scalar >, PacketAccess >::Scalar

the scalar type of the coefficients

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

Definition at line 318 of file Quaternion.h.


Constructor & Destructor Documentation

template<typename _Scalar , int PacketAccess>
EIGEN_STRONG_INLINE Map< const Quaternion< _Scalar >, PacketAccess >::Map ( const 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.

Definition at line 329 of file Quaternion.h.


Member Function Documentation

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

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

Definition at line 331 of file Quaternion.h.


Member Data Documentation

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

Definition at line 334 of file Quaternion.h.




Page generated by Doxygen 1.7.2 for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011