roboptim::callback::Wrapper< S > Class Template Reference

Raw callback wrapper. More...

#include <roboptim/core/callback/wrapper.hh>

Inheritance diagram for roboptim::callback::Wrapper< S >:

List of all members.

Public Types
typedef SolverCallback< S >	parent_t
	Parent type.
typedef S	solver_t
	Type of the solver.
typedef solver_t::callback_t	callback_t
	Callback function type.
typedef solver_t::problem_t	problem_t
	Problem type.
typedef SolverState< problem_t >	solverState_t
	Type of the state of the solver.
Public Member Functions
	Wrapper (callback_t c, const std::string &name="wrapped callback")
	Default constructor.
virtual	~Wrapper ()
	Virtual destructor.
Protected Member Functions
virtual void	perIterationCallbackUnsafe (const problem_t &pb, solverState_t &state)
	Meta-callback calling multiple callbacks.

---

Detailed Description

template<typename S>
class roboptim::callback::Wrapper< S >

Raw callback wrapper.

Template Parameters:

S	solver type.

---

Member Typedef Documentation

template<typename S >

typedef solver_t::callback_t roboptim::callback::Wrapper< S >::callback_t

Callback function type.

Reimplemented from roboptim::SolverCallback< S >.

template<typename S >

typedef SolverCallback<S> roboptim::callback::Wrapper< S >::parent_t

Parent type.

template<typename S >

typedef solver_t::problem_t roboptim::callback::Wrapper< S >::problem_t

Problem type.

Reimplemented from roboptim::SolverCallback< S >.

template<typename S >

typedef S roboptim::callback::Wrapper< S >::solver_t

Type of the solver.

Reimplemented from roboptim::SolverCallback< S >.

template<typename S >

typedef SolverState<problem_t> roboptim::callback::Wrapper< S >::solverState_t

Type of the state of the solver.

Reimplemented from roboptim::SolverCallback< S >.

---

Constructor & Destructor Documentation

template<typename S >

roboptim::callback::Wrapper< S >::Wrapper	(	callback_t	c,
		const std::string &	name = "wrapped callback"
	)

Default constructor.

Parameters:

c	raw callback function.
name	optional name.

template<typename S >

roboptim::callback::Wrapper< S >::~Wrapper

(

)

[virtual]

Virtual destructor.

---

Member Function Documentation

template<typename S >

void roboptim::callback::Wrapper< S >::perIterationCallbackUnsafe	(	const problem_t &	pb,
		solverState_t &	state
	)		[protected, virtual]

Meta-callback calling multiple callbacks.

Unsafe version that can throw exceptions.

Parameters:

pb	problem.
state	solver state.