roboptim::Parameter Struct Reference

Solver parameter type. More...

#include <roboptim/core/solver.hh>

List of all members.

Public Types
typedef Function::value_type	value_type
typedef Function::vector_t	vector_t
typedef boost::variant < value_type, vector_t, int, std::string, bool >	parameterValues_t
	Allowed types for solver parameters:
Public Member Functions
ROBOPTIM_DLLAPI	Parameter ()
	Default constructor.
Public Attributes
std::string	description
	Parameter description (for humans).
parameterValues_t	value
	Value.

---

Detailed Description

Solver parameter type.

---

Member Typedef Documentation

typedef boost::variant<value_type, vector_t, int, std::string, bool> roboptim::Parameter::parameterValues_t

Allowed types for solver parameters:

• value (double)
• vector (of double)
• integer
• string
• bool

typedef Function::value_type roboptim::Parameter::value_type

typedef Function::vector_t roboptim::Parameter::vector_t

---

Constructor & Destructor Documentation

roboptim::Parameter::Parameter

(

)

Default constructor.

---

Member Data Documentation

std::string roboptim::Parameter::description

Parameter description (for humans).

Referenced by roboptim::operator<<().

parameterValues_t roboptim::Parameter::value

Value.

Referenced by roboptim::operator<<().