NloptSolver Class Reference

#include <drake/solvers/nlopt_solver.h>

Public Types
using	Details = NloptSolverDetails
	Type of details stored in MathematicalProgramResult. More...

Public Member Functions
	NloptSolver ()
	~NloptSolver () final
MathematicalProgramResult	Solve (const MathematicalProgram &prog, const std::optional< Eigen::VectorXd > &initial_guess=std::nullopt, const std::optional< SolverOptions > &solver_options=std::nullopt) const
	Like SolverInterface::Solve(), but the result is a return value instead of an output argument. More...
void	Solve (const MathematicalProgram &, const std::optional< Eigen::VectorXd > &, const std::optional< SolverOptions > &, MathematicalProgramResult *) const override
Does not allow copy, move, or assignment
	NloptSolver (const NloptSolver &)=delete
NloptSolver &	operator= (const NloptSolver &)=delete
	NloptSolver (NloptSolver &&)=delete
NloptSolver &	operator= (NloptSolver &&)=delete
Public Member Functions inherited from SolverBase
	~SolverBase () override
MathematicalProgramResult	Solve (const MathematicalProgram &prog, const std::optional< Eigen::VectorXd > &initial_guess=std::nullopt, const std::optional< SolverOptions > &solver_options=std::nullopt) const
	Like SolverInterface::Solve(), but the result is a return value instead of an output argument. More...
void	Solve (const MathematicalProgram &, const std::optional< Eigen::VectorXd > &, const std::optional< SolverOptions > &, MathematicalProgramResult *) const override
	Solves an optimization program with optional initial guess and solver options. More...
bool	available () const override
	Returns true iff support for this solver has been compiled into Drake. More...
bool	enabled () const override
	Returns true iff this solver is properly configured for use at runtime. More...
SolverId	solver_id () const final
	Returns the identifier of this solver. More...
bool	AreProgramAttributesSatisfied (const MathematicalProgram &) const override
	Returns true iff the program's attributes are compatible with this solver's capabilities. More...
std::string	ExplainUnsatisfiedProgramAttributes (const MathematicalProgram &) const override
	Describes the reasons (if any) why the program is incompatible with this solver's capabilities. More...
	SolverBase (const SolverBase &)=delete
SolverBase &	operator= (const SolverBase &)=delete
	SolverBase (SolverBase &&)=delete
SolverBase &	operator= (SolverBase &&)=delete
Public Member Functions inherited from SolverInterface
virtual	~SolverInterface ()
	SolverInterface (const SolverInterface &)=delete
SolverInterface &	operator= (const SolverInterface &)=delete
	SolverInterface (SolverInterface &&)=delete
SolverInterface &	operator= (SolverInterface &&)=delete

Static Public Member Functions
static std::string	ConstraintToleranceName ()
	The key name for the double-valued constraint tolerance. More...
static std::string	XRelativeToleranceName ()
	The key name for double-valued x relative tolerance. More...
static std::string	XAbsoluteToleranceName ()
	The key name for double-valued x absolute tolerance. More...
static std::string	MaxEvalName ()
	The key name for int-valued maximum number of evaluations. More...
static std::string	MaxTimeName ()
	The key name for the maximum runtime. More...
static std::string	AlgorithmName ()
	The key name for the string-valued algorithm. More...
Static versions of the instance methods with similar names.
static SolverId	id ()
static bool	is_available ()
static bool	is_enabled ()
static bool	ProgramAttributesSatisfied (const MathematicalProgram &)

Additional Inherited Members
Protected Member Functions inherited from SolverBase
	SolverBase (const SolverId &id, std::function< bool()> available, std::function< bool()> enabled, std::function< bool(const MathematicalProgram &)> are_satisfied, std::function< std::string(const MathematicalProgram &)> explain_unsatisfied=nullptr)
	Constructs a SolverBase with the given default implementations of the solver_id(), available(), enabled(), AreProgramAttributesSatisfied(), and ExplainUnsatisfiedProgramAttributes() methods. More...
virtual void	DoSolve (const MathematicalProgram &prog, const Eigen::VectorXd &initial_guess, const SolverOptions &merged_options, MathematicalProgramResult *result) const
	Hook for subclasses to implement Solve. More...
Protected Member Functions inherited from SolverInterface
	SolverInterface ()

Member Typedef Documentation

Details

using Details = NloptSolverDetails

Type of details stored in MathematicalProgramResult.

Constructor & Destructor Documentation

NloptSolver() [1/3]

NloptSolver ( const NloptSolver &  )

delete

NloptSolver() [2/3]

NloptSolver ( NloptSolver &&  )

delete

NloptSolver() [3/3]

NloptSolver

(

)

~NloptSolver()

~NloptSolver ( )

final

Member Function Documentation

AlgorithmName()

static std::string AlgorithmName ( )

static

The key name for the string-valued algorithm.

ConstraintToleranceName()

static std::string ConstraintToleranceName ( )

static

The key name for the double-valued constraint tolerance.

id()

static SolverId id ( )

static

is_available()

static bool is_available ( )

static

is_enabled()

static bool is_enabled ( )

static

MaxEvalName()

static std::string MaxEvalName ( )

static

The key name for int-valued maximum number of evaluations.

MaxTimeName()

static std::string MaxTimeName ( )

static

The key name for the maximum runtime.

By default, there is no maximum runtime. A nonpositive value will be interpreted as no maximum runtime.

operator=() [1/2]

NloptSolver& operator= ( NloptSolver &&  )

delete

operator=() [2/2]

NloptSolver& operator= ( const NloptSolver &  )

delete

ProgramAttributesSatisfied()

static bool ProgramAttributesSatisfied ( const MathematicalProgram &  )

static

Solve() [1/2]

MathematicalProgramResult Solve

Like SolverInterface::Solve(), but the result is a return value instead of an output argument.

Solve() [2/2]

void Solve

override

XAbsoluteToleranceName()

static std::string XAbsoluteToleranceName ( )

static

The key name for double-valued x absolute tolerance.

XRelativeToleranceName()

static std::string XRelativeToleranceName ( )

static

The key name for double-valued x relative tolerance.

---

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

• drake/solvers/nlopt_solver.h