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

---

Detailed Description

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

Quaternion expression mapping a constant memory buffer.

Template 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

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

List of all members.

Public Types
typedef _Scalar	Scalar
Public Member Functions
const Coefficients &	coeffs () const
	Map (const Scalar *coeffs)

---

Member Typedef Documentation

template<typename _Scalar , int _Options>

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

the scalar type of the coefficients

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

---

Constructor & Destructor Documentation

template<typename _Scalar , int _Options>

Eigen::Map< const Quaternion< _Scalar >, _Options >::Map

(

const Scalar *

coeffs

)

[inline, explicit]

Constructs a Mapped Quaternion object from the pointer coeffs

The pointer coeffs must reference the four coefficients 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.

---

Member Function Documentation

template<typename _Scalar , int _Options>

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

(

)

const [inline]

Returns:

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

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

---

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

• Quaternion.h