- 3.0.2 optimal control module.
Public Member Functions | List of all members
ct::optcon::tpl::IpoptSolver< SCALAR > Class Template Reference

#include <IpoptSolver.h>

Inheritance diagram for ct::optcon::tpl::IpoptSolver< SCALAR >:
ct::optcon::tpl::NlpSolver< SCALAR >

Public Member Functions

 IpoptSolver ()
 
 IpoptSolver (std::shared_ptr< tpl::Nlp< SCALAR >> nlp, NlpSolverSettings settings)
 
bool solve () override
 Solves the nlp. More...
 
void prepareWarmStart (size_t maxIterations) override
 Prepares the solver for a warmstarting scenario with available (good) initial guess. More...
 
void configureDerived (const NlpSolverSettings &settings) override
 Forwards the settings to the corresponding nlp solver. More...
 
- Public Member Functions inherited from ct::optcon::tpl::NlpSolver< SCALAR >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW NlpSolver ()
 Default constructor. More...
 
 NlpSolver (std::shared_ptr< Nlp< SCALAR >> nlp)
 Custom Constructor 1. More...
 
 NlpSolver (std::shared_ptr< Nlp< SCALAR >> nlp, NlpSolverSettings settings)
 Custom constructor 2. More...
 
virtual ~NlpSolver ()=default
 Destructor. More...
 
void configure (const NlpSolverSettings &settings)
 Configures the solver with new settings. More...
 
bool isInitialized ()
 

Additional Inherited Members

- Protected Attributes inherited from ct::optcon::tpl::NlpSolver< SCALAR >
std::shared_ptr< Nlp< SCALAR > > nlp_
 
NlpSolverSettings settings_
 
bool isInitialized_
 

Constructor & Destructor Documentation

◆ IpoptSolver() [1/2]

template<typename SCALAR >
ct::optcon::tpl::IpoptSolver< SCALAR >::IpoptSolver ( )
inline

◆ IpoptSolver() [2/2]

template<typename SCALAR >
ct::optcon::tpl::IpoptSolver< SCALAR >::IpoptSolver ( std::shared_ptr< tpl::Nlp< SCALAR >>  nlp,
NlpSolverSettings  settings 
)
inline

Member Function Documentation

◆ solve()

template<typename SCALAR >
bool IpoptSolver::solve ( )
inlineoverridevirtual

Solves the nlp.

Returns
Returns true of solve succeeded

Implements ct::optcon::tpl::NlpSolver< SCALAR >.

◆ prepareWarmStart()

template<typename SCALAR >
void IpoptSolver::prepareWarmStart ( size_t  maxIterations)
inlineoverridevirtual

Prepares the solver for a warmstarting scenario with available (good) initial guess.

Parameters
[in]maxIterationsSpecifies the maximum number of nlp iteration the user is willing to spend

Implements ct::optcon::tpl::NlpSolver< SCALAR >.

◆ configureDerived()

template<typename SCALAR >
void IpoptSolver::configureDerived ( const NlpSolverSettings &  settings)
inlineoverridevirtual

Forwards the settings to the corresponding nlp solver.

Parameters
[in]settingsThe nlp settings

Implements ct::optcon::tpl::NlpSolver< SCALAR >.

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