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

Fast finite difference gradient computation. More...

#include <roboptim/core/decorator/finite-difference-gradient.hh>

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

Collaboration 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
void	computeGradient (value_type epsilon, gradient_ref gradient, const_argument_ref argument, size_type idFunction, argument_ref xEps) const
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.
void	computeJacobian (value_type epsilon, jacobian_ref jacobian, const_argument_ref argument, argument_ref xEps) const

Additional Inherited Members
Protected Attributes inherited from roboptim::finiteDifferenceGradientPolicies::Policy< T >
const GenericFunction< T > &	adaptee_
	Wrapped function.
vector_t	column_
	Vector storing temporary Jacobian column.
gradient_t	gradient_
	Vector storing temporary Jacobian row.

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

policy_t

template<typename T>

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

Constructor & Destructor Documentation

Simple()

template<typename T>

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

inlineexplicit

References roboptim::finiteDifferenceGradientPolicies::Policy< T >::Policy().

Member Function Documentation

computeColumn() [1/2]

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 roboptim::finiteDifferenceGradientPolicies::Policy< T >::adaptee_.

computeColumn() [2/2]

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 roboptim::finiteDifferenceGradientPolicies::Policy< T >::adaptee_.

computeGradient() [1/2]

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::finiteDifferenceGradientPolicies::Policy< T >::adaptee_.

computeGradient() [2/2]

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::finiteDifferenceGradientPolicies::Policy< T >::adaptee_.

computeJacobian()

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 roboptim::finiteDifferenceGradientPolicies::Policy< T >::adaptee_, and roboptim::finiteDifferenceGradientPolicies::Policy< T >::computeJacobian().

ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_()

template<typename T>

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

(

GenericDifferentiableFunction< T >

)