quaternion_functions.h File Reference

Functions on quaternions. More...

#include <cml/mathlib/checking.h>
#include <cml/mathlib/epsilon.h>
#include <cml/util.h>

Include dependency graph for quaternion_functions.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	cml
Functions
template<class QuatT >
QuatT::temporary_type	cml::exp (const QuatT &q, typename QuatT::value_type tolerance=epsilon< typename QuatT::value_type >::placeholder())
	Exponential function of a quaternion or quaternion expression.
template<typename E , class AT , class OT , class CT >
quaternion< E, AT, OT, CT >	cml::identity (const quaternion< E, AT, OT, CT > &arg)
	Set a quaternion to the multiplicative identity.
template<typename XprT >
et::QuaternionXpr< XprT > ::imaginary_type	cml::imaginary (const et::QuaternionXpr< XprT > &e)
	Returns the imaginary (vector) part of the QuaternionXpr.
template<typename E , class AT , class OT , class CT >
quaternion< E, AT, OT, CT > ::imaginary_type	cml::imaginary (const quaternion< E, AT, OT, CT > &q)
	Returns the imaginary (vector) part of the quaternion.
template<typename XprT >
XprT::value_type	cml::length (QUATXPR_ARG_TYPE arg)
	Length of a quaternion expr.
template<typename E , class AT , class OT , class CT >
quaternion< E, AT, OT, CT > ::value_type	cml::length (const quaternion< E, AT, OT, CT > &arg)
	Length of a quaternion.
template<typename XprT >
XprT::value_type	cml::length_squared (QUATXPR_ARG_TYPE arg)
	Squared length of a quaternion expr.
template<typename E , class AT , class OT , class CT >
quaternion< E, AT, OT, CT > ::value_type	cml::length_squared (const quaternion< E, AT, OT, CT > &arg)
	Squared length of a quaternion.
template<class QuatT >
QuatT::temporary_type	cml::log (const QuatT &q, typename QuatT::value_type tolerance=epsilon< typename QuatT::value_type >::placeholder())
	Log of a quaternion or quaternion expression.
template<typename XprT >
XprT::value_type	cml::norm (QUATXPR_ARG_TYPE arg)
	Cayley norm of a QuaternionXpr.
template<typename E , class AT , class OT , class CT >
quaternion< E, AT, OT, CT > ::value_type	cml::norm (const quaternion< E, AT, OT, CT > &arg)
	Cayley norm of a quaternion.
template<typename XprT >
XprT::temporary_type	cml::normalize (QUATXPR_ARG_TYPE arg)
	Normalize a quaternion expr.
template<typename E , class AT , class OT , class CT >
quaternion< E, AT, OT, CT >	cml::normalize (const quaternion< E, AT, OT, CT > &arg)
	Normalize a quaternion.
template<typename XprT >
et::QuaternionXpr< XprT > ::value_type	cml::real (const et::QuaternionXpr< XprT > &e)
	Returns the real (scalar) part of the QuaternionXpr.
template<typename E , class AT , class OT , class CT >
quaternion< E, AT, OT, CT > ::value_type	cml::real (const quaternion< E, AT, OT, CT > &q)
	Returns the real part of the quaternion.

---

Detailed Description

Functions on quaternions.

Todo:

The functions that return quaternions and vectors should be changed to return quaternion expression nodes, as should the corresponding class methods.

Definition in file quaternion_functions.h.