All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
roboptim::GenericDummySolver< T > Class Template Reference

Dummy solver which always fails. More...

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

Inheritance diagram for roboptim::GenericDummySolver< T >:
roboptim::Solver< T > roboptim::GenericSolver

Public Types

typedef Solver< T > parent_t
 Define parent's type. More...
 
typedef parent_t::problem_t problem_t
 Problem type. More...
 
- Public Types inherited from roboptim::Solver< T >
typedef Problem< T > problem_t
 Solver problem type. More...
 
typedef GenericFunction< T >
::vector_t 
vector_t
 Import vector type from cost function. More...
 
typedef std::map< std::string,
Parameter
parameters_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_ERROR,
  SOLVER_VALUE_WARNINGS
}
 Define the kind of solution which has been found. More...
 

Public Member Functions

 GenericDummySolver (const problem_t &problem)
 Build a solver from a problem. More...
 
virtual ~GenericDummySolver ()
 
virtual void solve ()
 Implement the solve algorithm. More...
 
- Public Member Functions inherited from roboptim::Solver< T >
 Solver (const problem_t &problem)
 Instantiate a solver from a problem. 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 ()
 
template<typename U >
const U & 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. 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

- Public Attributes inherited from roboptim::GenericSolver
ROBOPTIM_ALLOW_DEPRECATED_ON
typedef boost::variant
< NoSolution, Result,
SolverError,
ResultWithWarnings
result_t
 Result type. More...
 
- Protected Attributes inherited from roboptim::Solver< T >
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...
 

Detailed Description

template<typename T>
class roboptim::GenericDummySolver< T >

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.

Template Parameters
Tmatrix traits.
Examples:
numeric-linear-function.cc, and numeric-quadratic-function.cc.

Member Typedef Documentation

template<typename T >
typedef Solver<T> roboptim::GenericDummySolver< T >::parent_t

Define parent's type.

template<typename T >
typedef parent_t::problem_t roboptim::GenericDummySolver< T >::problem_t

Problem type.

Constructor & Destructor Documentation

template<typename T >
roboptim::GenericDummySolver< T >::GenericDummySolver ( const problem_t problem)
explicit

Build a solver from a problem.

Parameters
problemproblem that will be solved

References roboptim::Solver< T >::parameters_.

template<typename T >
roboptim::GenericDummySolver< T >::~GenericDummySolver ( )
virtual

Member Function Documentation

template<typename T >
void roboptim::GenericDummySolver< T >::solve ( )
virtual

Implement the solve algorithm.

Implement the solve method as required by the GenericSolver class.

Implements roboptim::GenericSolver.

References result_.