Drake
SnoptSolver Class Reference

#include <drake/solvers/snopt_solver.h>

Public Member Functions

 SnoptSolver ()=default
 
 ~SnoptSolver () override=default
 
bool available () const override
 Returns true iff this solver was enabled at compile-time. More...
 
SolutionResult Solve (MathematicalProgram &prog) const override
 Sets values for the decision variables on the given MathematicalProgram prog, or: More...
 
void Solve (const MathematicalProgram &, const optional< Eigen::VectorXd > &, const optional< SolverOptions > &, MathematicalProgramResult *) const override
 Solves an optimization program with optional initial guess and solver options. More...
 
SolverId solver_id () const override
 Returns the identifier of this solver. More...
 
bool AreProgramAttributesSatisfied (const MathematicalProgram &prog) const override
 Returns true if the program attributes are satisfied by the solver's capability. More...
 
Does not allow copy, move, or assignment
 SnoptSolver (const SnoptSolver &)=delete
 
SnoptSolveroperator= (const SnoptSolver &)=delete
 
 SnoptSolver (SnoptSolver &&)=delete
 
SnoptSolveroperator= (SnoptSolver &&)=delete
 
- Public Member Functions inherited from MathematicalProgramSolverInterface
 MathematicalProgramSolverInterface ()=default
 
virtual ~MathematicalProgramSolverInterface ()=default
 
 MathematicalProgramSolverInterface (const MathematicalProgramSolverInterface &)=delete
 
MathematicalProgramSolverInterfaceoperator= (const MathematicalProgramSolverInterface &)=delete
 
 MathematicalProgramSolverInterface (MathematicalProgramSolverInterface &&)=delete
 
MathematicalProgramSolverInterfaceoperator= (MathematicalProgramSolverInterface &&)=delete
 

Static Public Member Functions

static bool is_available ()
 
static SolverId id ()
 
static bool ProgramAttributesSatisfied (const MathematicalProgram &prog)
 

Constructor & Destructor Documentation

◆ SnoptSolver() [1/3]

SnoptSolver ( const SnoptSolver )
delete

◆ SnoptSolver() [2/3]

SnoptSolver ( SnoptSolver &&  )
delete

◆ SnoptSolver() [3/3]

SnoptSolver ( )
default

◆ ~SnoptSolver()

~SnoptSolver ( )
overridedefault

Member Function Documentation

◆ AreProgramAttributesSatisfied()

bool AreProgramAttributesSatisfied ( const MathematicalProgram prog) const
overridevirtual

Returns true if the program attributes are satisfied by the solver's capability.

Implements MathematicalProgramSolverInterface.

◆ available()

bool available ( ) const
inlineoverridevirtual

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

Implements MathematicalProgramSolverInterface.

◆ id()

◆ is_available()

bool is_available ( )
static

◆ operator=() [1/2]

SnoptSolver& operator= ( SnoptSolver &&  )
delete

◆ operator=() [2/2]

SnoptSolver& operator= ( const SnoptSolver )
delete

◆ ProgramAttributesSatisfied()

bool ProgramAttributesSatisfied ( const MathematicalProgram prog)
static

◆ Solve() [1/2]

SolutionResult Solve ( MathematicalProgram prog) const
overridevirtual

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.

Implements MathematicalProgramSolverInterface.

◆ Solve() [2/2]

void Solve ( const MathematicalProgram prog,
const optional< Eigen::VectorXd > &  initial_guess,
const optional< SolverOptions > &  solver_options,
MathematicalProgramResult result 
) const
inlineoverridevirtual

Solves an optimization program with optional initial guess and solver options.

Note that these initial guess and solver options are not written to prog.

Implements MathematicalProgramSolverInterface.

◆ solver_id()

SolverId solver_id ( ) const
overridevirtual

Returns the identifier of this solver.

Implements MathematicalProgramSolverInterface.


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