Dummy solver which always fails, but returns the last state of the solver. More...

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

Inheritance diagram for roboptim::DummySolverLastState:

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.
typedef std::map< std::string, Parameter >	parameters_t
	Map of parameters.
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
	DummySolverLastState (const problem_t &problem) throw ()
	Build a solver from a problem.
virtual	~DummySolverLastState () 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_t &	problem () const throw ()
	Retrieve the problem.
virtual std::ostream &	print (std::ostream &) const throw ()
	Display the solver on the specified output stream.
const parameters_t &	parameters () const throw ()
parameters_t &	parameters () throw ()
const T &	getParameter (const std::string &key) const
Public Member Functions inherited from roboptim::GenericSolver
void	reset () throw ()
	Force to restart the optimization.
const result_t &	minimum () 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.
parameters_t	parameters_
	Solver parameters (run-time configuration).
Static Protected Attributes inherited from roboptim::Solver< Function, boost::mpl::vector< Function > >
static log4cxx::LoggerPtr	logger
	Pointer to function logger (see log4cxx documentation).

Detailed Description

Dummy solver which always fails, but returns the last state of the solver.

The SolverError generated contains a dummy state of the solver (x, constraints etc.). These values can be obtained thanks to SolverError::lastState.

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

Define parent's type.

roboptim::DummySolverLastState::DummySolverLastState ( const problem_t & problem ) throw ()

explicit

Build a solver from a problem.

Parameters

problem problem that will be solved

roboptim::DummySolverLastState::~DummySolverLastState ( ) throw ()

virtual

void roboptim::DummySolverLastState::solve ( ) throw ()

virtual

Implement the solve algorithm.

Implement the solve method as required by the GenericSolver class.