roboptim::StateParameter< F > Struct Template Reference

Solver state parameters type. More...

#include <roboptim/core/solver-state.hh>

Public Types
typedef F::value_type	value_type
typedef F::vector_t	vector_t
typedef boost::variant < value_type, vector_t, int, std::string, bool >	stateParameterValues_t
	Allowed types for parameters: More...

Public Member Functions
virtual std::ostream &	print (std::ostream &) const
	Display the solver parameter on the specified output stream. More...
virtual	~StateParameter ()
	Virtual destructor. More...

Public Attributes
std::string	description
	Parameter description (for humans). More...
stateParameterValues_t	value
	Value. More...

Detailed Description

template<typename F>
struct roboptim::StateParameter< F >

Solver state parameters type.

Template Parameters

F	function type.

Member Typedef Documentation

template<typename F>

typedef boost::variant<value_type, vector_t, int, std::string, bool> roboptim::StateParameter< F >::stateParameterValues_t

Allowed types for parameters:

• value (e.g. constraint violation)
• vector (e.g. current x)
• integer (e.g. current iteration)
• string (e.g. warning message from the solver)
• bool (e.g. whether to stop the optimization)

template<typename F>

typedef F::value_type roboptim::StateParameter< F >::value_type

template<typename F>

typedef F::vector_t roboptim::StateParameter< F >::vector_t

Constructor & Destructor Documentation

template<typename F>

virtual roboptim::StateParameter< F >::~StateParameter ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

template<typename F >

std::ostream & roboptim::StateParameter< F >::print ( std::ostream &  o ) const

virtual

Display the solver parameter on the specified output stream.

Parameters

o	output stream used for display

Returns

output stream

Member Data Documentation

template<typename F>

std::string roboptim::StateParameter< F >::description

Parameter description (for humans).

template<typename F>

stateParameterValues_t roboptim::StateParameter< F >::value

Value.