aligator::autodiff::FiniteDifferenceHelper< _Scalar > Struct Template Reference

Approximate the derivatives of a given function using finite differences, to downcast the function to a StageFunctionTpl. More...

#include <aligator/modelling/autodiff/finite-difference.hpp>

Inheritance diagram for aligator::autodiff::FiniteDifferenceHelper< _Scalar >:

Collaboration diagram for aligator::autodiff::FiniteDifferenceHelper< _Scalar >:

Public Types
using	Scalar = _Scalar
using	StageFunction = StageFunctionTpl<Scalar>
using	Manifold = ManifoldAbstractTpl<Scalar>
using	Base = internal::finite_difference_impl<Scalar, StageFunctionTpl>

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (_Scalar)
	FiniteDifferenceHelper (shared_ptr< Manifold > space, shared_ptr< StageFunction > func, const Scalar fd_eps)

Detailed Description

template<typename _Scalar>
struct aligator::autodiff::FiniteDifferenceHelper< _Scalar >

Approximate the derivatives of a given function using finite differences, to downcast the function to a StageFunctionTpl.

Definition at line 122 of file finite-difference.hpp.

Member Typedef Documentation

Scalar

template<typename _Scalar >

using aligator::autodiff::FiniteDifferenceHelper< _Scalar >::Scalar = _Scalar

Definition at line 124 of file finite-difference.hpp.

StageFunction

template<typename _Scalar >

using aligator::autodiff::FiniteDifferenceHelper< _Scalar >::StageFunction = StageFunctionTpl<Scalar>

Definition at line 126 of file finite-difference.hpp.

Manifold

template<typename _Scalar >

using aligator::autodiff::FiniteDifferenceHelper< _Scalar >::Manifold = ManifoldAbstractTpl<Scalar>

Definition at line 127 of file finite-difference.hpp.

Base

template<typename _Scalar >

using aligator::autodiff::FiniteDifferenceHelper< _Scalar >::Base = internal::finite_difference_impl<Scalar, StageFunctionTpl>

Definition at line 128 of file finite-difference.hpp.

Constructor & Destructor Documentation

FiniteDifferenceHelper()

template<typename _Scalar >

aligator::autodiff::FiniteDifferenceHelper< _Scalar >::FiniteDifferenceHelper ( shared_ptr< Manifold > space, shared_ptr< StageFunction > func, const Scalar fd_eps )

inline

Definition at line 135 of file finite-difference.hpp.

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename _Scalar >

aligator::autodiff::FiniteDifferenceHelper< _Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

_Scalar

)

---

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

• include/aligator/modelling/autodiff/finite-difference.hpp