CallbackAbstractTpl< _Scalar > Class Template Reference

Abstract class for solver callbacks. More...

#include <solver-base.hpp>

Inheritance diagram for CallbackAbstractTpl< _Scalar >:

Public Types
typedef SolverAbstractTpl< Scalar >	SolverAbstract

Public Member Functions
	CallbackAbstractTpl ()
	Initialize the callback function.
virtual void	operator() (SolverAbstract &solver)=0
	Run the callback function given a solver.

Public Attributes
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar	Scalar

Detailed Description

template<typename _Scalar>
class crocoddyl::CallbackAbstractTpl< _Scalar >

Abstract class for solver callbacks.

A callback is used to diagnostic the behaviour of our solver in each iteration of it. For instance, it can be used to print values, record data or display motions.

Definition at line 793 of file solver-base.hpp.

Member Typedef Documentation

SolverAbstract

template<typename _Scalar>

typedef SolverAbstractTpl<Scalar> SolverAbstract

Definition at line 798 of file solver-base.hpp.

Constructor & Destructor Documentation

CallbackAbstractTpl()

template<typename _Scalar>

CallbackAbstractTpl ( )

inline

Initialize the callback function.

Definition at line 803 of file solver-base.hpp.

Member Function Documentation

operator()()

template<typename _Scalar>

virtual void operator() ( SolverAbstract & solver )

pure virtual

Run the callback function given a solver.

Parameters

[in]

solver

solver to be diagnostic

Implemented in CallbackVerboseTpl< _Scalar >, and CallbackVerboseTpl< double >.

Member Data Documentation

Scalar

template<typename _Scalar>

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar

Definition at line 797 of file solver-base.hpp.

---

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

• /build/source/include/crocoddyl/core/fwd.hpp
• /build/source/include/crocoddyl/core/solver-base.hpp