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

Quaternion expression mapping a constant memory buffer. More...

#include <Quaternion.h>

Inheritance diagram for Map< const Quaternion< _Scalar >, _Options >:

List of all members.

Public Types
typedef internal::traits< Map > ::Coefficients	Coefficients
typedef _Scalar	Scalar
Public Member Functions
const Coefficients &	coeffs () const
EIGEN_STRONG_INLINE	Map (const Scalar *coeffs)
Protected Attributes
const Coefficients	m_coeffs
Private Types
typedef QuaternionBase< Map < const Quaternion< _Scalar > , _Options > >	Base

---

Detailed Description

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

Quaternion expression mapping a constant memory buffer.

Parameters:

_Scalar	the type of the Quaternion coefficients
_Options	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

Definition at line 344 of file Geometry/Quaternion.h.

---

Member Typedef Documentation

template<typename _Scalar , int _Options>

typedef QuaternionBase<Map<const Quaternion<_Scalar>, _Options> > Map< const Quaternion< _Scalar >, _Options >::Base [private]

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

Definition at line 347 of file Geometry/Quaternion.h.

template<typename _Scalar , int _Options>

typedef internal::traits<Map>::Coefficients Map< const Quaternion< _Scalar >, _Options >::Coefficients

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

Definition at line 351 of file Geometry/Quaternion.h.

template<typename _Scalar , int _Options>

typedef _Scalar Map< const Quaternion< _Scalar >, _Options >::Scalar

the scalar type of the coefficients

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

Definition at line 350 of file Geometry/Quaternion.h.

---

Constructor & Destructor Documentation

template<typename _Scalar , int _Options>

EIGEN_STRONG_INLINE Map< const Quaternion< _Scalar >, _Options >::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 _Options is set to Aligned, then the pointer coeffs must be aligned.

Definition at line 361 of file Geometry/Quaternion.h.

---

Member Function Documentation

template<typename _Scalar , int _Options>

const Coefficients& Map< const Quaternion< _Scalar >, _Options >::coeffs

(

)

const [inline]

Returns:

a read-only vector expression of the coefficients (x,y,z,w)

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

Definition at line 363 of file Geometry/Quaternion.h.

---

Member Data Documentation

template<typename _Scalar , int _Options>

const Coefficients Map< const Quaternion< _Scalar >, _Options >::m_coeffs [protected]

Definition at line 366 of file Geometry/Quaternion.h.

---

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

• Geometry/Quaternion.h