Dummy solver which always fails. More...

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

Inheritance diagram for roboptim::DummySolver:

[legend]

Collaboration diagram for roboptim::DummySolver:

[legend]

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 Function::vector_t	vector_t
	Import vector type from cost function.
typedef std::map< std::string, Parameter >	parameters_t
	Map of parameters.
typedef SolverState< problem_t >	solverState_t
	State of the solver.
typedef boost::function< void(const problem_t &problem, solverState_t &state)>	callback_t
	Per-iteration callback 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 boost::variant< NoSolution, Result, ResultWithWarnings, SolverError >	result_t
	Result type.

Public Member Functions
	DummySolver (const problem_t &problem)
	Build a solver from a problem.
virtual	~DummySolver ()
virtual void	solve ()
	Implement the solve algorithm.
Public Member Functions inherited from roboptim::Solver< Function, boost::mpl::vector< Function > >
	Solver (const problem_t &problem)
	Instantiate a solver from a problem.
	Solver (const Problem< F_, C_ > &problem)
	Instantiate a solver from a problem in a different problem class.
virtual	~Solver ()
const problem_t &	problem () const
	Retrieve the problem.
virtual void	setIterationCallback (callback_t)
	Set the per-iteration callback.
virtual std::ostream &	print (std::ostream &) const
	Display the solver on the specified output stream.
const parameters_t &	parameters () const
parameters_t &	parameters ()
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.
const result_t &	minimum ()
	Returns the function minimum This solves the problem automatically, if it has not yet been solved.
solutions	minimumType ()
	Determine real minimum type.
template<typename T>
const T &	getMinimum ()
	Get real result.
	GenericSolver ()
	GenericSolver (const GenericSolver &)
virtual	~GenericSolver ()

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).
std::string	plugin_name_
	Plugin name.
Protected Attributes inherited from roboptim::GenericSolver
result_t	result_
	Optimization result.
Static Protected Attributes inherited from roboptim::Solver< Function, boost::mpl::vector< Function > >
static log4cxx::LoggerPtr	logger
	Pointer to function logger (see log4cxx documentation).
Static Protected Attributes inherited from roboptim::GenericSolver
static log4cxx::LoggerPtr	logger
	Pointer to function logger (see log4cxx documentation).

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

Define parent's type.

roboptim::DummySolver::DummySolver ( const problem_t & problem )

explicit

Build a solver from a problem.

Parameters

problem problem that will be solved

roboptim::DummySolver::~DummySolver ( )

virtual

void roboptim::DummySolver::solve ( )

virtual

Implement the solve algorithm.

Implement the solve method as required by the GenericSolver class.