roboptim::DummySolver Class Reference

Dummy solver which always fails. More...

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

+ Inheritance diagram for roboptim::DummySolver:

List of all members.

Public Types

typedef Solver< Function,
boost::mpl::vector< Function > > 
parent_t
 Define parent's type.
- Public Types inherited from roboptim::Solver< Function, boost::mpl::vector< Function > >
typedef Problem< Function,
boost::mpl::vector< Function > > 
problem_t
 Solver problem type.
- 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 Function::vector_t vector_t
 Vector type imported from function class.
typedef boost::variant
< NoSolution, Result,
ResultWithWarnings,
SolverError
result_t
 Result type.

Public Member Functions

 DummySolver (const problem_t &problem) throw ()
 Build a solver from a problem.
virtual ~DummySolver () throw ()
virtual void solve () throw ()
 Implement the solve algorithm.
- Public Member Functions inherited from roboptim::Solver< Function, boost::mpl::vector< Function > >
 Solver (const problem_t &problem) throw ()
 Instantiate a solver from a problem.
 Solver (const Problem< F_, C_ > &problem) throw ()
 Instantiate a solver from a problem in a different problem class.
virtual ~Solver () throw ()
const problem_tproblem () const throw ()
 Retrieve the problem.
virtual std::ostream & print (std::ostream &) const throw ()
 Display the solver on the specified output stream.
- Public Member Functions inherited from roboptim::GenericSolver
void reset () throw ()
 Force to restart the optimization. Reset the internal mechanism to force the solution to be re-computed next time getMinimum is called.
const result_tminimum () throw ()
 Returns the function minimum This solves the problem automatically, if it has not yet been solved.
solutions minimumType () throw ()
 Determine real minimum type.
template<typename T >
const T & getMinimum () throw (boost::bad_get)
 Get real result.
 GenericSolver () throw ()
 GenericSolver (const GenericSolver &) throw ()
virtual ~GenericSolver () throw ()

Additional Inherited Members

- Protected Attributes inherited from roboptim::Solver< Function, boost::mpl::vector< Function > >
const problem_t problem_
 Problem that will be solved.
- Protected Attributes inherited from roboptim::GenericSolver
result_t result_
 /brief Optimization result.

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.

Examples:
numeric-linear-function.cc, and numeric-quadratic-function.cc.

Member Typedef Documentation

typedef Solver<Function, boost::mpl::vector<Function> > roboptim::DummySolver::parent_t

Define parent's type.


Constructor & Destructor Documentation

roboptim::DummySolver::DummySolver ( const problem_t problem) throw ()
explicit

Build a solver from a problem.

Parameters:
problemproblem that will be solved
roboptim::DummySolver::~DummySolver ( ) throw ()
virtual

Member Function Documentation

void roboptim::DummySolver::solve ( ) throw ()
virtual

Implement the solve algorithm.

Implement the solve method as required by the GenericSolver class.

Implements roboptim::GenericSolver.

References roboptim::GenericSolver::result_.