Drake
Drake C++ Documentation
Loading...
Searching...
No Matches
NloptSolverDetails Struct Reference

Detailed Description

The NLopt solver details after calling Solve() function.

The user can call MathematicalProgramResult::get_solver_details<NloptSolver>() to obtain the details.

#include <drake/solvers/nlopt_solver.h>

Public Attributes

int status {}
 The return code of NLopt on every termination, including the negative (failure) codes.

Member Data Documentation

◆ status

int status {}

The return code of NLopt on every termination, including the negative (failure) codes.

Please refer to https://nlopt.readthedocs.io/en/latest/NLopt_Reference/#return-values.

On NLOPT_INVALID_ARGS (-2) and NLOPT_OUT_OF_MEMORY (-3) the result holds no solution (every decision variable is NaN). On every other code, including NLOPT_FAILURE (-1) and NLOPT_ROUNDOFF_LIMITED (-4), the result holds the point NLopt returned. Which point that is depends on the algorithm; e.g., LD_SLSQP returns its best feasible iterate if it found one. The point may violate the constraints or be non-finite, and may be the initial guess.


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