Orocos KDL
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
KDL::Rall1d< T, V, S > Class Template Reference

#include <rall1d.h>

Public Types

typedef T valuetype
typedef V gradienttype
typedef S scalartype

Public Member Functions

INLINE Rall1d ()
T value () const
V deriv () const
INLINE Rall1d (typename TI< T >::Arg c)
INLINE Rall1d (typename TI< T >::Arg tn, typename TI< V >::Arg afg)
INLINE Rall1d (const Rall1d< T, V, S > &r)
INLINE T & Value ()
INLINE V & Gradient ()
INLINE Rall1d< T, V, S > & operator= (S c)
INLINE Rall1d< T, V, S > & operator= (const Rall1d< T, V, S > &r)
INLINE Rall1d< T, V, S > & operator/= (const Rall1d< T, V, S > &rhs)
INLINE Rall1d< T, V, S > & operator*= (const Rall1d< T, V, S > &rhs)
INLINE Rall1d< T, V, S > & operator+= (const Rall1d< T, V, S > &rhs)
INLINE Rall1d< T, V, S > & operator-= (const Rall1d< T, V, S > &rhs)
INLINE Rall1d< T, V, S > & operator/= (S rhs)
INLINE Rall1d< T, V, S > & operator*= (S rhs)
INLINE Rall1d< T, V, S > & operator+= (S rhs)
INLINE Rall1d< T, V, S > & operator-= (S rhs)

Static Public Member Functions

static INLINE Rall1d< T, V, S > Zero ()
static INLINE Rall1d< T, V, S > Identity ()

Public Attributes

T t
 value
V grad
 gradient

Detailed Description

template<typename T, typename V = T, typename S = T>
class KDL::Rall1d< T, V, S >

Rall1d contains a value, and its gradient, and defines an algebraic structure on this pair. This template class has 3 template parameters :

  • T contains the type of the value.
  • V contains the type of the gradient (can be a vector-like type).
  • S defines a scalar type that can operate on Rall1d. This is the type that is used to give back values of Norm() etc.

S is useful when you recurse a Rall1d object into itself to create a 2nd, 3rd, 4th,.. derivatives. (e.g. Rall1d< Rall1d<double>, Rall1d<double>, double> ).

S is always passed by value.

Class Type
Concrete implementation

Member Typedef Documentation

◆ gradienttype

template<typename T, typename V = T, typename S = T>
typedef V KDL::Rall1d< T, V, S >::gradienttype

◆ scalartype

template<typename T, typename V = T, typename S = T>
typedef S KDL::Rall1d< T, V, S >::scalartype

◆ valuetype

template<typename T, typename V = T, typename S = T>
typedef T KDL::Rall1d< T, V, S >::valuetype

Constructor & Destructor Documentation

◆ Rall1d() [1/4]

template<typename T, typename V = T, typename S = T>
INLINE KDL::Rall1d< T, V, S >::Rall1d ( )
inline

◆ Rall1d() [2/4]

template<typename T, typename V = T, typename S = T>
INLINE KDL::Rall1d< T, V, S >::Rall1d ( typename TI< T >::Arg c)
inlineexplicit

◆ Rall1d() [3/4]

template<typename T, typename V = T, typename S = T>
INLINE KDL::Rall1d< T, V, S >::Rall1d ( typename TI< T >::Arg tn,
typename TI< V >::Arg afg )
inline

◆ Rall1d() [4/4]

template<typename T, typename V = T, typename S = T>
INLINE KDL::Rall1d< T, V, S >::Rall1d ( const Rall1d< T, V, S > & r)
inline

Member Function Documentation

◆ deriv()

template<typename T, typename V = T, typename S = T>
V KDL::Rall1d< T, V, S >::deriv ( ) const
inline

◆ Gradient()

template<typename T, typename V = T, typename S = T>
INLINE V & KDL::Rall1d< T, V, S >::Gradient ( )
inline

◆ Identity()

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > KDL::Rall1d< T, V, S >::Identity ( )
inlinestatic

◆ operator*=() [1/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator*= ( const Rall1d< T, V, S > & rhs)
inline

◆ operator*=() [2/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator*= ( S rhs)
inline

◆ operator+=() [1/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator+= ( const Rall1d< T, V, S > & rhs)
inline

◆ operator+=() [2/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator+= ( S rhs)
inline

◆ operator-=() [1/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator-= ( const Rall1d< T, V, S > & rhs)
inline

◆ operator-=() [2/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator-= ( S rhs)
inline

◆ operator/=() [1/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator/= ( const Rall1d< T, V, S > & rhs)
inline

◆ operator/=() [2/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator/= ( S rhs)
inline

◆ operator=() [1/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator= ( const Rall1d< T, V, S > & r)
inline

◆ operator=() [2/2]

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > & KDL::Rall1d< T, V, S >::operator= ( S c)
inline

◆ Value()

template<typename T, typename V = T, typename S = T>
INLINE T & KDL::Rall1d< T, V, S >::Value ( )
inline

◆ value()

template<typename T, typename V = T, typename S = T>
T KDL::Rall1d< T, V, S >::value ( ) const
inline

◆ Zero()

template<typename T, typename V = T, typename S = T>
INLINE Rall1d< T, V, S > KDL::Rall1d< T, V, S >::Zero ( )
inlinestatic

Member Data Documentation

◆ grad

template<typename T, typename V = T, typename S = T>
V KDL::Rall1d< T, V, S >::grad

gradient

◆ t

template<typename T, typename V = T, typename S = T>
T KDL::Rall1d< T, V, S >::t

value

The documentation for this class was generated from the following file:
Generated by doxygen 1.16.1