cml::et::ConjugateOp< ExprT > Class Template Reference

An expression node for conjugating a quaternion. More...

#include <conjugate.h>

Collaboration diagram for cml::et::ConjugateOp< ExprT >:

Collaboration graph
[legend]

List of all members.

Public Types

enum  { array_size = ExprT::array_size }
 Record result size as an enum. More...
enum  { W = order_type::W, X = order_type::X, Y = order_type::Y, Z = order_type::Z }
 Localize the ordering as an enum. More...
typedef cml::et::not_assignable_tag assignable_tag
typedef unary_expression expr_ary
typedef expr_type expr_const_reference
typedef
expr_traits::const_reference 
expr_reference
typedef ExprTraits< ExprT > expr_traits
typedef ConjugateOp< ExprT > expr_type
typedef vector_type::subvector_type imaginary_type
typedef result_type::order_type order_type
typedef quaternion_result_tag result_tag
typedef expr_traits::result_type result_type
typedef ExprT::size_tag size_tag
typedef result_type::temporary_type temporary_type
typedef ExprT::value_type value_type
typedef result_type::vector_type vector_type

Public Member Functions

 ConjugateOp (const expr_type &e)
 Copy constructor.
 ConjugateOp (expr_reference expr)
 Construct from the subexpression.
expr_reference expression () const
 Return reference to contained expression.
imaginary_type imaginary () const
 Return the vector part of the expression.
value_type length () const
 Return the quaternion length.
value_type length_squared () const
 Return square of the quaternion length.
value_type norm () const
 Return the Cayley norm of the expression.
temporary_type normalize () const
 Return the result as a normalized quaternion.
value_type operator[] (size_t i) const
 Compute conjugated result at index i.
value_type real () const
 Return the real part of the expression.
size_t size () const
 Return size of this expression (same as argument's size).

Protected Attributes

expr_reference m_expr

Private Member Functions

expr_typeoperator= (const expr_type &)


Detailed Description

template<class ExprT>
class cml::et::ConjugateOp< ExprT >

An expression node for conjugating a quaternion.

Definition at line 23 of file conjugate.h.


Member Typedef Documentation

template<class ExprT >
typedef cml::et::not_assignable_tag cml::et::ConjugateOp< ExprT >::assignable_tag

Definition at line 49 of file conjugate.h.

template<class ExprT >
typedef unary_expression cml::et::ConjugateOp< ExprT >::expr_ary

Definition at line 30 of file conjugate.h.

template<class ExprT >
typedef expr_type cml::et::ConjugateOp< ExprT >::expr_const_reference

Definition at line 33 of file conjugate.h.

template<class ExprT >
typedef expr_traits::const_reference cml::et::ConjugateOp< ExprT >::expr_reference

Definition at line 43 of file conjugate.h.

template<class ExprT >
typedef ExprTraits<ExprT> cml::et::ConjugateOp< ExprT >::expr_traits

Definition at line 40 of file conjugate.h.

template<class ExprT >
typedef ConjugateOp<ExprT> cml::et::ConjugateOp< ExprT >::expr_type

Definition at line 27 of file conjugate.h.

template<class ExprT >
typedef vector_type::subvector_type cml::et::ConjugateOp< ExprT >::imaginary_type

Definition at line 58 of file conjugate.h.

template<class ExprT >
typedef result_type::order_type cml::et::ConjugateOp< ExprT >::order_type

Definition at line 61 of file conjugate.h.

template<class ExprT >
typedef quaternion_result_tag cml::et::ConjugateOp< ExprT >::result_tag

Definition at line 36 of file conjugate.h.

template<class ExprT >
typedef expr_traits::result_type cml::et::ConjugateOp< ExprT >::result_type

Definition at line 46 of file conjugate.h.

template<class ExprT >
typedef ExprT::size_tag cml::et::ConjugateOp< ExprT >::size_tag

Definition at line 37 of file conjugate.h.

template<class ExprT >
typedef result_type::temporary_type cml::et::ConjugateOp< ExprT >::temporary_type

Definition at line 52 of file conjugate.h.

template<class ExprT >
typedef ExprT::value_type cml::et::ConjugateOp< ExprT >::value_type

Definition at line 35 of file conjugate.h.

template<class ExprT >
typedef result_type::vector_type cml::et::ConjugateOp< ExprT >::vector_type

Definition at line 55 of file conjugate.h.


Member Enumeration Documentation

template<class ExprT >
anonymous enum

Record result size as an enum.

Enumerator:
array_size 

Definition at line 67 of file conjugate.h.

template<class ExprT >
anonymous enum

Localize the ordering as an enum.

Enumerator:
W 
X 
Y 
Z 

Definition at line 70 of file conjugate.h.


Constructor & Destructor Documentation

template<class ExprT >
cml::et::ConjugateOp< ExprT >::ConjugateOp ( expr_reference  expr  )  [inline, explicit]

Construct from the subexpression.

Definition at line 136 of file conjugate.h.

template<class ExprT >
cml::et::ConjugateOp< ExprT >::ConjugateOp ( const expr_type e  )  [inline]

Copy constructor.

Definition at line 139 of file conjugate.h.


Member Function Documentation

template<class ExprT >
expr_reference cml::et::ConjugateOp< ExprT >::expression (  )  const [inline]

Return reference to contained expression.

Definition at line 130 of file conjugate.h.

References cml::et::ConjugateOp< ExprT >::m_expr.

template<class ExprT >
imaginary_type cml::et::ConjugateOp< ExprT >::imaginary (  )  const [inline]

Return the vector part of the expression.

Definition at line 86 of file conjugate.h.

References cml::et::ConjugateOp< ExprT >::m_expr.

Referenced by cml::et::QuaternionInverseOp< ExprT >::imaginary().

Here is the caller graph for this function:

template<class ExprT >
value_type cml::et::ConjugateOp< ExprT >::length (  )  const [inline]

Return the quaternion length.

Definition at line 103 of file conjugate.h.

References cml::et::ConjugateOp< ExprT >::length_squared().

Here is the call graph for this function:

template<class ExprT >
value_type cml::et::ConjugateOp< ExprT >::length_squared (  )  const [inline]

Return square of the quaternion length.

Definition at line 96 of file conjugate.h.

References cml::dot().

Referenced by cml::et::ConjugateOp< ExprT >::length(), and cml::et::ConjugateOp< ExprT >::norm().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class ExprT >
value_type cml::et::ConjugateOp< ExprT >::norm (  )  const [inline]

Return the Cayley norm of the expression.

Definition at line 91 of file conjugate.h.

References cml::et::ConjugateOp< ExprT >::length_squared().

Here is the call graph for this function:

template<class ExprT >
temporary_type cml::et::ConjugateOp< ExprT >::normalize (  )  const [inline]

Return the result as a normalized quaternion.

Definition at line 108 of file conjugate.h.

template<class ExprT >
expr_type& cml::et::ConjugateOp< ExprT >::operator= ( const expr_type  )  [private]

template<class ExprT >
value_type cml::et::ConjugateOp< ExprT >::operator[] ( size_t  i  )  const [inline]

Compute conjugated result at index i.

The conjugate of quaternion s + v is s - v.

Definition at line 117 of file conjugate.h.

References cml::et::ConjugateOp< ExprT >::m_expr, and cml::et::ConjugateOp< ExprT >::W.

template<class ExprT >
value_type cml::et::ConjugateOp< ExprT >::real (  )  const [inline]

Return the real part of the expression.

Definition at line 81 of file conjugate.h.

References cml::et::ConjugateOp< ExprT >::m_expr.

Referenced by cml::et::QuaternionInverseOp< ExprT >::real().

Here is the caller graph for this function:

template<class ExprT >
size_t cml::et::ConjugateOp< ExprT >::size (  )  const [inline]

Return size of this expression (same as argument's size).

Definition at line 125 of file conjugate.h.

References cml::et::ConjugateOp< ExprT >::m_expr.

Referenced by cml::et::QuaternionInverseOp< ExprT >::size().

Here is the caller graph for this function:


Member Data Documentation

template<class ExprT >
expr_reference cml::et::ConjugateOp< ExprT >::m_expr [protected]


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

Generated on Sat Jul 18 19:35:39 2009 for CML 1.0 by  doxygen 1.5.9