roboptim::finiteDifferenceGradientPolicies::Simple< T > Class Template Reference

Fast finite difference gradient computation. More...

#include <roboptim/core/fwd.hh>

Inheritance diagram for roboptim::finiteDifferenceGradientPolicies::Simple< T >:

Public Types
typedef Policy< T >	policy_t

Public Member Functions
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericDifferentiableFunction< T >)
	Simple (const GenericFunction< T > &adaptee)
void	computeColumn (value_type epsilon, gradient_ref column, const_argument_ref argument, size_type colIdx, argument_ref xEps) const
void	computeGradient (value_type epsilon, gradient_ref gradient, const_argument_ref argument, size_type idFunction, argument_ref xEps) const
void	computeJacobian (value_type epsilon, jacobian_ref jacobian, const_argument_ref argument, argument_ref xEps) const
template<>
void	computeGradient (value_type epsilon, gradient_ref gradient, const_argument_ref argument, size_type idFunction, argument_ref xEps) const
template<>
void	computeColumn (value_type epsilon, gradient_ref column, const_argument_ref argument, size_type colIdx, argument_ref xEps) const
Public Member Functions inherited from roboptim::finiteDifferenceGradientPolicies::Policy< T >
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericDifferentiableFunction< T >)
	Policy (const GenericFunction< T > &adaptee)
virtual	~Policy ()
	Virtual destructor. More...
value_type &	sparseEpsilon ()
	Get a reference to the epsilon used to converse dense to sparse matrices. More...

Additional Inherited Members
Protected Member Functions inherited from roboptim::finiteDifferenceGradientPolicies::Policy< T >
template<>
void	computeJacobian (value_type epsilon, jacobian_ref jacobian, const_argument_ref argument, argument_ref xEps) const
Protected Attributes inherited from roboptim::finiteDifferenceGradientPolicies::Policy< T >
const GenericFunction< T > &	adaptee_
	Wrapped function. More...
vector_t	column_
	Vector storing temporary Jacobian column. More...
gradient_t	gradient_
	Vector storing temporary Jacobian row. More...
value_type	sparseEps_
	Threshold used for the conversion from dense to sparse matrix. More...

Detailed Description

template<typename T>
class roboptim::finiteDifferenceGradientPolicies::Simple< T >

Fast finite difference gradient computation.

Finite difference is computed using forward difference.

Member Typedef Documentation

template<typename T >

typedef Policy<T> roboptim::finiteDifferenceGradientPolicies::Simple< T >::policy_t

Constructor & Destructor Documentation

template<typename T >

roboptim::finiteDifferenceGradientPolicies::Simple< T >::Simple ( const GenericFunction< T > &  adaptee )

inlineexplicit

Member Function Documentation

template<typename T >

void roboptim::finiteDifferenceGradientPolicies::Simple< T >::computeColumn ( value_type  epsilon, gradient_ref  column, const_argument_ref  argument, size_type  colIdx, argument_ref  xEps  ) const

virtual

Implements roboptim::finiteDifferenceGradientPolicies::Policy< T >.

References result_.

template<>

void roboptim::finiteDifferenceGradientPolicies::Simple< EigenMatrixSparse >::computeColumn ( value_type  epsilon, gradient_ref  column, const_argument_ref  argument, size_type  colIdx, argument_ref  xEps  ) const

inlinevirtual

Implements roboptim::finiteDifferenceGradientPolicies::Policy< T >.

References result_.

template<typename T >

void roboptim::finiteDifferenceGradientPolicies::Simple< T >::computeGradient ( value_type  epsilon, gradient_ref  gradient, const_argument_ref  argument, size_type  idFunction, argument_ref  xEps  ) const

virtual

Implements roboptim::finiteDifferenceGradientPolicies::Policy< T >.

References roboptim::GenericFunction< T >::inputSize(), and result_.

template<>

void roboptim::finiteDifferenceGradientPolicies::Simple< EigenMatrixSparse >::computeGradient ( value_type  epsilon, gradient_ref  gradient, const_argument_ref  argument, size_type  idFunction, argument_ref  xEps  ) const

inlinevirtual

Implements roboptim::finiteDifferenceGradientPolicies::Policy< T >.

References roboptim::GenericFunction< T >::inputSize(), and result_.

template<typename T >

void roboptim::finiteDifferenceGradientPolicies::Simple< T >::computeJacobian ( value_type  epsilon, jacobian_ref  jacobian, const_argument_ref  argument, argument_ref  xEps  ) const

virtual

Reimplemented from roboptim::finiteDifferenceGradientPolicies::Policy< T >.

References result_.

template<typename T >

roboptim::finiteDifferenceGradientPolicies::Simple< T >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_

(

GenericDifferentiableFunction< T >

)