roboptim::Derivative< U > Class Template Reference

Return the derivative of a function w.r.t. More...

#include <roboptim/core/operator/derivative.hh>

Inheritance diagram for roboptim::Derivative< U >:

Public Types
typedef DerivativeParent< U > ::result_t	parentType_t
typedef std::pair< size_type, size_type >	jacobianSize_t
	Jacobian size type (pair of values). More...
typedef boost::shared_ptr < Derivative >	DerivativeShPtr_t

Public Member Functions
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericDifferentiableFunction< typename U::traits_t >)
	Derivative (boost::shared_ptr< U > origin, size_type variableId)
	Derivative operator constructor. More...
	~Derivative ()
const boost::shared_ptr< U > &	origin () const
boost::shared_ptr< U > &	origin ()

Protected Member Functions
void	impl_compute (result_ref result, const_argument_ref x) const
void	impl_gradient (gradient_ref gradient, const_argument_ref x, size_type functionId=0) const

Detailed Description

template<typename U>
class roboptim::Derivative< U >

Return the derivative of a function w.r.t.

one of the parameters.

Known issue: for now it returns a non-differentiable function.

Template Parameters

U	input function type.

Member Typedef Documentation

template<typename U >

typedef boost::shared_ptr<Derivative> roboptim::Derivative< U >::DerivativeShPtr_t

template<typename U >

typedef std::pair<size_type, size_type> roboptim::Derivative< U >::jacobianSize_t

Jacobian size type (pair of values).

template<typename U >

typedef DerivativeParent<U>::result_t roboptim::Derivative< U >::parentType_t

Constructor & Destructor Documentation

template<typename U >

roboptim::Derivative< U >::Derivative ( boost::shared_ptr< U >  origin, size_type  variableId  )

inlineexplicit

Derivative operator constructor.

Parameters

origin	input function.
variableId	parameter index.

template<typename U >

roboptim::Derivative< U >::~Derivative ( )

inline

Member Function Documentation

template<typename U >

void roboptim::Derivative< U >::impl_compute ( result_ref  result, const_argument_ref  x  ) const

inlineprotected

template<typename U >

void roboptim::Derivative< U >::impl_gradient ( gradient_ref  gradient, const_argument_ref  x, size_type  functionId = 0  ) const

inlineprotected

template<typename U >

const boost::shared_ptr<U>& roboptim::Derivative< U >::origin ( ) const

inline

template<typename U >

boost::shared_ptr<U>& roboptim::Derivative< U >::origin ( )

inline

template<typename U >

roboptim::Derivative< U >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_

(

GenericDifferentiableFunction< typename U::traits_t >

)