roboptim::DummySolverTd Class Reference

Dummy solver which always fails. More...

#include <roboptim/core/plugin/dummy-td.hh>

Inheritance diagram for roboptim::DummySolverTd:
roboptim::Solver< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > > roboptim::GenericSolver

Public Types

typedef Solver< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > > parent_t
 Define parent's type. More...
 
- Public Types inherited from roboptim::Solver< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > >
typedef Problem< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > > problem_t
 Solver problem type. More...
 
typedef TwiceDifferentiableFunction::vector_t vector_t
 Import vector type from cost function. More...
 
typedef std::map< std::string, Parameterparameters_t
 Map of parameters. More...
 
typedef SolverState< problem_tsolverState_t
 State of the solver. More...
 
typedef boost::function< void(const problem_t &problem, solverState_t &state)> callback_t
 Per-iteration callback type. More...
 
- Public Types inherited from roboptim::GenericSolver
enum  solutions {
  SOLVER_NO_SOLUTION,
  SOLVER_VALUE,
  SOLVER_VALUE_WARNINGS,
  SOLVER_ERROR
}
 Define the kind of solution which has been found. More...
 
typedef boost::variant< NoSolution, Result, ResultWithWarnings, SolverErrorresult_t
 Result type. More...
 

Public Member Functions

 DummySolverTd (const problem_t &problem)
 Build a solver from a problem. More...
 
virtual ~DummySolverTd ()
 
virtual void solve ()
 Implement the solve algorithm. More...
 
- Public Member Functions inherited from roboptim::Solver< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > >
 Solver (const problem_t &problem)
 Instantiate a solver from a problem. More...
 
 Solver (const Problem< F_, C_ > &problem)
 Instantiate a solver from a problem in a different problem class. More...
 
virtual ~Solver ()
 
const problem_tproblem () const
 Retrieve the problem. More...
 
virtual void setIterationCallback (callback_t)
 Set the per-iteration callback. More...
 
virtual std::ostream & print (std::ostream &) const
 Display the solver on the specified output stream. More...
 
const parameters_tparameters () const
 
parameters_tparameters ()
 
const T & getParameter (const std::string &key) const
 
const std::string & pluginName () const
 
std::string & pluginName ()
 
- Public Member Functions inherited from roboptim::GenericSolver
void reset ()
 Force to restart the optimization. More...
 
const result_tminimum ()
 Returns the function minimum This solves the problem automatically, if it has not yet been solved. More...
 
solutions minimumType ()
 Determine real minimum type. More...
 
template<typename T >
const T & getMinimum ()
 Get real result. More...
 
 GenericSolver ()
 
 GenericSolver (const GenericSolver &)
 
virtual ~GenericSolver ()
 

Additional Inherited Members

- Protected Attributes inherited from roboptim::Solver< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > >
const problem_t problem_
 Problem that will be solved. More...
 
parameters_t parameters_
 Solver parameters (run-time configuration). More...
 
std::string plugin_name_
 Plugin name. More...
 
- Protected Attributes inherited from roboptim::GenericSolver
result_t result_
 Optimization result. More...
 
- Static Protected Attributes inherited from roboptim::Solver< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > >
static log4cxx::LoggerPtr logger
 Pointer to function logger (see log4cxx documentation). More...
 
- Static Protected Attributes inherited from roboptim::GenericSolver
static log4cxx::LoggerPtr logger
 Pointer to function logger (see log4cxx documentation). More...
 

Detailed Description

Dummy solver which always fails.

This solver always fails but is always available as it does not rely on the plug-in mechanism.

It is also a good starting point for users that want to develop their own solver.

Member Typedef Documentation

Constructor & Destructor Documentation

roboptim::DummySolverTd::DummySolverTd ( const problem_t problem)
explicit

Build a solver from a problem.

Parameters
problemproblem that will be solved

References roboptim::Solver< TwiceDifferentiableFunction, boost::mpl::vector< TwiceDifferentiableFunction > >::parameters_.

roboptim::DummySolverTd::~DummySolverTd ( )
virtual

Member Function Documentation

void roboptim::DummySolverTd::solve ( )
virtual

Implement the solve algorithm.

Implement the solve method as required by the GenericSolver class.

Implements roboptim::GenericSolver.

References roboptim::GenericSolver::result_.