ifopt::IpoptSolver Class Reference

An interface to IPOPT, fully hiding its implementation. More...

#include <ipopt_solver.h>

Inheritance diagram for ifopt::IpoptSolver:

Public Types
using	Ptr = std::shared_ptr< IpoptSolver >
Public Types inherited from ifopt::Solver
using	Ptr = std::shared_ptr< Solver >

Public Member Functions
int	GetReturnStatus ()
	Get the return status for the optimization. More...
double	GetTotalWallclockTime ()
	Get the total wall clock time for the optimization, including function evaluations. More...
	IpoptSolver ()
void	SetOption (const std::string &name, const std::string &value)
void	SetOption (const std::string &name, int value)
void	SetOption (const std::string &name, double value)
void	Solve (Problem &nlp) override
	Creates an IpoptAdapter and solves the NLP. More...
virtual	~IpoptSolver ()=default
Public Member Functions inherited from ifopt::Solver
virtual	~Solver ()=default

Private Attributes
std::shared_ptr< Ipopt::IpoptApplication >	ipopt_app_
int	status_

Detailed Description

An interface to IPOPT, fully hiding its implementation.

To set specific options, see: https://www.coin-or.org/Ipopt/documentation/node40.html

Definition at line 48 of file ipopt_solver.h.

Member Typedef Documentation

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

Definition at line 50 of file ipopt_solver.h.

Constructor & Destructor Documentation

ifopt::IpoptSolver::IpoptSolver

(

)

Definition at line 32 of file ipopt_solver.cc.

virtual ifopt::IpoptSolver::~IpoptSolver ( )

virtualdefault

Member Function Documentation

int ifopt::IpoptSolver::GetReturnStatus

(

)

Get the return status for the optimization.

Definition at line 114 of file ipopt_solver.cc.

double ifopt::IpoptSolver::GetTotalWallclockTime

(

)

Get the total wall clock time for the optimization, including function evaluations.

Definition at line 108 of file ipopt_solver.cc.

void ifopt::IpoptSolver::SetOption	(	const std::string &	name,
		const std::string &	value
	)

Set options for the IPOPT solver. A complete list can be found here: https://www.coin-or.org/Ipopt/documentation/node40.html

Definition at line 90 of file ipopt_solver.cc.

void ifopt::IpoptSolver::SetOption	(	const std::string &	name,
		int	value
	)

Definition at line 96 of file ipopt_solver.cc.

void ifopt::IpoptSolver::SetOption	(	const std::string &	name,
		double	value
	)

Definition at line 102 of file ipopt_solver.cc.

void ifopt::IpoptSolver::Solve ( Problem &  nlp )

overridevirtual

Creates an IpoptAdapter and solves the NLP.

Parameters

[in/out]

nlp The specific problem.

Implements ifopt::Solver.

Definition at line 64 of file ipopt_solver.cc.

Member Data Documentation

std::shared_ptr<Ipopt::IpoptApplication> ifopt::IpoptSolver::ipopt_app_

private

Definition at line 76 of file ipopt_solver.h.

int ifopt::IpoptSolver::status_

private

Definition at line 77 of file ipopt_solver.h.

---

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

• ipopt_solver.h
• ipopt_solver.cc