Public Types | Public Member Functions | Protected Attributes | List of all members
ifopt::Solver Class Referenceabstract

Solver interface implemented by IPOPT and SNOPT. More...

#include <solver.h>

Inheritance diagram for ifopt::Solver:
Inheritance graph
[legend]

Public Types

using Ptr = std::shared_ptr< Solver >
 

Public Member Functions

int GetReturnStatus () const
 Get the return status for the optimization. More...
 
virtual void Solve (Problem &nlp)=0
 Uses a specific solver (IPOPT, SNOPT) to solve the NLP. More...
 
virtual ~Solver ()=default
 

Protected Attributes

int status_
 

Detailed Description

Solver interface implemented by IPOPT and SNOPT.

Definition at line 72 of file solver.h.

Member Typedef Documentation

◆ Ptr

using ifopt::Solver::Ptr = std::shared_ptr<Solver>

Definition at line 74 of file solver.h.

Constructor & Destructor Documentation

◆ ~Solver()

virtual ifopt::Solver::~Solver ( )
virtualdefault

Member Function Documentation

◆ GetReturnStatus()

int ifopt::Solver::GetReturnStatus ( ) const
inline

Get the return status for the optimization.

e.g. https://coin-or.github.io/Ipopt/OUTPUT.html

Definition at line 88 of file solver.h.

◆ Solve()

virtual void ifopt::Solver::Solve ( Problem nlp)
pure virtual

Uses a specific solver (IPOPT, SNOPT) to solve the NLP.

Parameters
[in/out]nlp The nonlinear programming problem.

Implemented in ifopt::SnoptSolver, and ifopt::IpoptSolver.

Member Data Documentation

◆ status_

int ifopt::Solver::status_
protected

Definition at line 88 of file solver.h.


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


ifopt
Author(s): Alexander W. Winkler
autogenerated on Thu Sep 15 2022 02:14:55