MBSim

Project Page
Public Member Functions | Protected Attributes
MBSim::DifferentiableFunction1< Ret > Class Template Reference

template class for differentiable functions with one scalar parameter More...

#include <function.h>

Inheritance diagram for MBSim::DifferentiableFunction1< Ret >:
MBSim::Function1< Ret, double > MBSim::Function MBSim::SinusFunction1_VS< fmatvec::Ref > MBSim::PositiveSinusFunction1_VS

List of all members.

Public Member Functions

 DifferentiableFunction1 ()
 constructor
virtual ~DifferentiableFunction1 ()
 destructor
virtual Ret operator() (const double &x, const void *=NULL)
const Function1< Ret, double > & getDerivative (int degree) const
Function1< Ret, double > & getDerivative (int degree)
void addDerivative (Function1< Ret, double > *diff)
void setDerivative (Function1< Ret, double > *diff, size_t degree)
void setOrderOfDerivative (int i)
virtual void initializeUsingXML (MBXMLUtils::TiXmlElement *element)
 initialize function with XML code
MBXMLUtils::TiXmlElement * writeXMLFile (MBXMLUtils::TiXmlNode *parent)
std::string getType () const

Protected Attributes

std::vector< Function1< Ret,
double > * > 
derivatives
 vector of derivatives
int order

Detailed Description

template<class Ret>
class MBSim::DifferentiableFunction1< Ret >

template class for differentiable functions with one scalar parameter

Author:
Thorsten Schindler
Date:
2009-08-31 some comments (Thorsten Schindler)
2010-03-10 small correction: setDerivative(...,int) -> setDerivative(...,size_t) (Roland Zander)

Member Function Documentation

template<class Ret>
void MBSim::DifferentiableFunction1< Ret >::addDerivative ( Function1< Ret, double > *  diff) [inline]
Parameters:
highestderivative to add
template<class Ret>
const Function1<Ret,double>& MBSim::DifferentiableFunction1< Ret >::getDerivative ( int  degree) const [inline]
Returns:
derivative
Parameters:
degreeof derivative
template<class Ret>
Function1<Ret,double>& MBSim::DifferentiableFunction1< Ret >::getDerivative ( int  degree) [inline]
Returns:
derivative
Parameters:
degreeof derivative
template<class Ret>
std::string MBSim::DifferentiableFunction1< Ret >::getType ( ) const [inline, virtual]
Returns:
std::string representation

Reimplemented from MBSim::Function1< Ret, double >.

Reimplemented in MBSim::SinusFunction1_VS< Col >, and MBSim::SinusFunction1_VS< fmatvec::Ref >.

template<class Ret>
virtual void MBSim::DifferentiableFunction1< Ret >::initializeUsingXML ( MBXMLUtils::TiXmlElement *  element) [inline, virtual]
template<class Ret>
virtual Ret MBSim::DifferentiableFunction1< Ret >::operator() ( const double &  x,
const void *  = NULL 
) [inline, virtual]
Returns:
return value of function
Parameters:
argumentof function
optionalparameter class

Implements MBSim::Function1< Ret, double >.

Reimplemented in MBSim::PositiveSinusFunction1_VS.

template<class Ret>
void MBSim::DifferentiableFunction1< Ret >::setDerivative ( Function1< Ret, double > *  diff,
size_t  degree 
) [inline]
Parameters:
derivativeto add
degreeof the derivative
template<class Ret>
void MBSim::DifferentiableFunction1< Ret >::setOrderOfDerivative ( int  i) [inline]
Parameters:
orderOfDerivative

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