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

Detailed Description

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

Expression of a quaternion from a memory buffer.

Template Parameters:
_Scalarthe type of the Quaternion coefficients
_Optionssee 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< Quaternion< _Scalar >, _Options >:

List of all members.

Public Types

typedef _Scalar Scalar

Public Member Functions

Coefficients & coeffs ()
const Coefficients & coeffs () const
 Map (Scalar *coeffs)

Member Typedef Documentation

template<typename _Scalar , int _Options>
typedef _Scalar Eigen::Map< Quaternion< _Scalar >, _Options >::Scalar

the scalar type of the coefficients

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


Constructor & Destructor Documentation

template<typename _Scalar , int _Options>
Eigen::Map< Quaternion< _Scalar >, _Options >::Map ( 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>
Coefficients& Eigen::Map< Quaternion< _Scalar >, _Options >::coeffs ( ) [inline]
Returns:
a vector expression of the coefficients (x,y,z,w)

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

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

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


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends