Drake
MathematicalProgramSolverInterface Class Referenceabstract

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

#include <drake/solvers/mathematical_program_solver_interface.h>

Inheritance diagram for MathematicalProgramSolverInterface:
[legend]

Public Member Functions

 MathematicalProgramSolverInterface ()=default
 
virtual ~MathematicalProgramSolverInterface ()=default
 
virtual bool available () const =0
 Returns true iff this solver was enabled at compile-time. More...
 
virtual SolutionResult Solve (MathematicalProgram &prog) const =0
 Sets values for the decision variables on the given MathematicalProgram prog, or: More...
 
virtual SolverId solver_id () const =0
 Returns the identifier of this solver. More...
 
Does not allow copy, move, or assignment
 MathematicalProgramSolverInterface (const MathematicalProgramSolverInterface &)=delete
 
MathematicalProgramSolverInterfaceoperator= (const MathematicalProgramSolverInterface &)=delete
 
 MathematicalProgramSolverInterface (MathematicalProgramSolverInterface &&)=delete
 
MathematicalProgramSolverInterfaceoperator= (MathematicalProgramSolverInterface &&)=delete
 

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< T >, MobyLCPSolver< double >, MosekSolver, GurobiSolver, DrealSolver, IpoptSolver, NloptSolver, SnoptSolver, EqualityConstrainedQPSolver, LinearSystemSolver, and ScsSolver.

Here is the caller graph for this function:

virtual SolutionResult Solve ( MathematicalProgram prog) const
pure virtual

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

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

Implemented in MobyLCPSolver< T >, MobyLCPSolver< double >, MobyLCPSolver< T >, GurobiSolver, EqualityConstrainedQPSolver, MosekSolver, DrealSolver, IpoptSolver, NloptSolver, SnoptSolver, LinearSystemSolver, and ScsSolver.

Here is the caller graph for this function:

virtual SolverId solver_id ( ) const
pure virtual

Returns the identifier of this solver.

Implemented in MobyLCPSolver< T >, MobyLCPSolver< double >, GurobiSolver, EqualityConstrainedQPSolver, MosekSolver, DrealSolver, IpoptSolver, NloptSolver, SnoptSolver, LinearSystemSolver, and ScsSolver.

Here is the caller graph for this function:


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