Drake
MathematicalProgramSolverInterface Class Referenceabstract

Interface used by implementations of individual solvers. More...

#include <drake/solvers/MathematicalProgram.h>

Inheritance diagram for MathematicalProgramSolverInterface:

Public Member Functions

virtual ~MathematicalProgramSolverInterface ()=default
 
virtual bool available () const =0
 Returns true iff this solver was enabled at compile-time. More...
 
virtual SolutionResult Solve (OptimizationProblem &prog) const =0
 Sets values for the decision variables on the given OptimizationProblem prog, or: More...
 

Detailed Description

Interface used by implementations of individual solvers.

Constructor & Destructor Documentation

virtual ~MathematicalProgramSolverInterface ( )
virtualdefault

Member Function Documentation

virtual bool available ( ) const
pure virtual

Returns true iff this solver was enabled at compile-time.

Implemented in MobyLCPSolver, IpoptSolver, NloptSolver, SnoptSolver, EqualityConstrainedQPSolver, and LinearSystemSolver.

virtual SolutionResult Solve ( OptimizationProblem prog) const
pure virtual

Sets values for the decision variables on the given OptimizationProblem prog, or:

  • If no solver is available, throws std::runtime_error
  • If the solver returns an error, returns a nonzero SolutionResult.

Implemented in MobyLCPSolver, IpoptSolver, NloptSolver, SnoptSolver, EqualityConstrainedQPSolver, and LinearSystemSolver.


The documentation for this class was generated from the following file: