All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
roboptim::Parameter Struct Reference

Solver parameter type. More...

#include <roboptim/core/solver.hh>

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: More...
 

Public Member Functions

ROBOPTIM_CORE_DLLAPI Parameter ()
 Default constructor. More...
 

Public Attributes

std::string description
 Parameter description (for humans). More...
 
parameterValues_t value
 Value. More...
 

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::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<<().