Bonmin 1.8.9
Loading...
Searching...
No Matches
Bonmin::IpoptSolver Class Reference

#include <BonIpoptSolver.hpp>

+ Inheritance diagram for Bonmin::IpoptSolver:
+ Collaboration diagram for Bonmin::IpoptSolver:

Classes

class  UnsolvedIpoptError
 

Public Member Functions

virtual UnsolvedErrornewUnsolvedError (int num, Ipopt::SmartPtr< TMINLP2TNLP > problem, std::string name)
 
 IpoptSolver (bool createEmpty=false)
 Constructor.
 
 IpoptSolver (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist, const std::string &prefix)
 Constructor with Passed in journalist, registered options, options.
 
 IpoptSolver (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist)
 Constructor with Passed in journalist, registered options, options.
 
 IpoptSolver (const IpoptSolver &other)
 Copy constructor.
 
virtual Ipopt::SmartPtr< TNLPSolverclone ()
 virtual copy constructor
 
virtual ~IpoptSolver ()
 Virtual destructor.
 
virtual bool Initialize (std::string params_file)
 Initialize the TNLPSolver (read options from params_file)
 
virtual bool Initialize (std::istream &is)
 Initialize the TNLPSolver (read options from istream is)
 
- Public Member Functions inherited from Bonmin::TNLPSolver
 TNLPSolver ()
 default Constructor
 
 TNLPSolver (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist, const std::string &prefix)
 Constructor with options initialization.
 
virtual ~TNLPSolver ()
 Virtual destructor.
 
Ipopt::SmartPtr< Ipopt::Journalistjournalist ()
 Get a pointer to a journalist.
 
Ipopt::SmartPtr< Bonmin::RegisteredOptionsroptions ()
 Get a pointer to RegisteredOptions (generally used to add new ones)
 
Ipopt::SmartPtr< const Ipopt::OptionsListoptions () const
 Get the options (for getting their values).
 
Ipopt::SmartPtr< Ipopt::OptionsListoptions ()
 Get the options (for getting and setting their values).
 
const char * prefix ()
 Get the prefix.
 
bool isRecoverable (ReturnStatus &r)
 Say if an optimization status for a problem which failed is recoverable (problem may be solvable).
 
void setup_global_time_limit (double time_limit)
 Setup for a global time limit for solver.
 
bool isError (ReturnStatus &r)
 Say if return status is an error.
 
- Public Member Functions inherited from Ipopt::ReferencedObject
 ReferencedObject ()
 
virtual ~ReferencedObject ()
 
Index ReferenceCount () const
 
void AddRef (const Referencer *referencer) const
 
void ReleaseRef (const Referencer *referencer) const
 

Solve methods

virtual TNLPSolver::ReturnStatus OptimizeTNLP (const Ipopt::SmartPtr< Ipopt::TNLP > &tnlp)
 Solves a problem expresses as a TNLP.
 
virtual TNLPSolver::ReturnStatus ReOptimizeTNLP (const Ipopt::SmartPtr< Ipopt::TNLP > &tnlp)
 Resolves a problem expresses as a TNLP.
 
virtual bool setWarmStart (const CoinWarmStart *warm, Ipopt::SmartPtr< TMINLP2TNLP > tnlp)
 Set the warm start in the solver.
 
virtual CoinWarmStartgetUsedWarmStart (Ipopt::SmartPtr< TMINLP2TNLP > tnlp) const
 Get warm start used in last optimization.
 
virtual CoinWarmStartgetWarmStart (Ipopt::SmartPtr< Bonmin::TMINLP2TNLP > tnlp) const
 Get the warm start form the solver.
 
virtual CoinWarmStartgetEmptyWarmStart () const
 
virtual bool warmStartIsValid (const CoinWarmStart *ws) const
 Check that warm start object is valid.
 
virtual void enableWarmStart ()
 Enable the warm start options in the solver.
 
virtual void disableWarmStart ()
 Disable the warm start options in the solver.
 
virtual double CPUTime ()
 Get the CpuTime of the last optimization.
 
virtual int IterationCount ()
 Get the iteration count of the last optimization.
 
virtual void setOutputToDefault ()
 turn off all output from the solver
 
virtual void forceSolverOutput (int log_level)
 turn on all output from the solver
 
virtual std::string & solverName ()
 Get the solver name.
 
Ipopt::ApplicationReturnStatus getOptStatus () const
 Return status of last optimization.
 
Ipopt::IpoptApplicationgetIpoptApp ()
 
virtual int errorCode () const
 Error code (solver specific).
 
static void RegisterOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register this solver options into passed roptions.
 

Additional Inherited Members

- Public Types inherited from Bonmin::TNLPSolver
enum  ReturnStatus {
  iterationLimit = -3 , timeLimit = 5 , doesNotConverge = -8 , computationError = -2 ,
  notEnoughFreedom = -1 , illDefinedProblem = -4 , illegalOption =-5 , externalException =-6 ,
  exception =-7 , solvedOptimal = 1 , solvedOptimalTol =2 , provenInfeasible =3 ,
  unbounded = 4 , numReturnCodes
}
 Standard return statuses for a solver. More...
 
- Static Public Member Functions inherited from Bonmin::TNLPSolver
static void RegisterOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register this solver options into passed roptions.
 
- Protected Member Functions inherited from Bonmin::TNLPSolver
bool zeroDimension (const Ipopt::SmartPtr< Ipopt::TNLP > &tnlp, ReturnStatus &optimization_status)
 Determine if problem is of dimension zero and if it is check if solution is feasible.
 
void initializeOptionsAndJournalist ()
 Initializes options and journalist.
 
 TNLPSolver (const TNLPSolver &other)
 Copy Constructor.
 
- Protected Attributes inherited from Bonmin::TNLPSolver
Ipopt::SmartPtr< Ipopt::Journalistjournalist_
 Storage of Journalist for output.
 
Ipopt::SmartPtr< Ipopt::OptionsListoptions_
 List of Options.
 
Ipopt::SmartPtr< Bonmin::RegisteredOptionsroptions_
 Registered Options.
 
std::string prefix_
 Prefix to use for reading bonmin's options.
 
double start_time_
 Global start time.
 
double time_limit_
 Global time limit.
 
int default_log_level_
 To record default log level.
 

Detailed Description

Definition at line 18 of file BonIpoptSolver.hpp.

Constructor & Destructor Documentation

◆ IpoptSolver() [1/4]

Bonmin::IpoptSolver::IpoptSolver ( bool createEmpty = false)

Constructor.

◆ IpoptSolver() [2/4]

Bonmin::IpoptSolver::IpoptSolver ( Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions,
Ipopt::SmartPtr< Ipopt::OptionsList > options,
Ipopt::SmartPtr< Ipopt::Journalist > journalist,
const std::string & prefix )

Constructor with Passed in journalist, registered options, options.

◆ IpoptSolver() [3/4]

Bonmin::IpoptSolver::IpoptSolver ( Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions,
Ipopt::SmartPtr< Ipopt::OptionsList > options,
Ipopt::SmartPtr< Ipopt::Journalist > journalist )

Constructor with Passed in journalist, registered options, options.

◆ IpoptSolver() [4/4]

Bonmin::IpoptSolver::IpoptSolver ( const IpoptSolver & other)

Copy constructor.

◆ ~IpoptSolver()

virtual Bonmin::IpoptSolver::~IpoptSolver ( )
virtual

Virtual destructor.

Member Function Documentation

◆ newUnsolvedError()

virtual UnsolvedError * Bonmin::IpoptSolver::newUnsolvedError ( int num,
Ipopt::SmartPtr< TMINLP2TNLP > problem,
std::string name )
inlinevirtual

Implements Bonmin::TNLPSolver.

Definition at line 39 of file BonIpoptSolver.hpp.

◆ clone()

virtual Ipopt::SmartPtr< TNLPSolver > Bonmin::IpoptSolver::clone ( )
virtual

virtual copy constructor

Implements Bonmin::TNLPSolver.

◆ Initialize() [1/2]

virtual bool Bonmin::IpoptSolver::Initialize ( std::string params_file)
virtual

Initialize the TNLPSolver (read options from params_file)

Implements Bonmin::TNLPSolver.

◆ Initialize() [2/2]

virtual bool Bonmin::IpoptSolver::Initialize ( std::istream & is)
virtual

Initialize the TNLPSolver (read options from istream is)

Implements Bonmin::TNLPSolver.

◆ OptimizeTNLP()

virtual TNLPSolver::ReturnStatus Bonmin::IpoptSolver::OptimizeTNLP ( const Ipopt::SmartPtr< Ipopt::TNLP > & tnlp)
virtual

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

◆ ReOptimizeTNLP()

virtual TNLPSolver::ReturnStatus Bonmin::IpoptSolver::ReOptimizeTNLP ( const Ipopt::SmartPtr< Ipopt::TNLP > & tnlp)
virtual

Resolves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

◆ setWarmStart()

virtual bool Bonmin::IpoptSolver::setWarmStart ( const CoinWarmStart * warm,
Ipopt::SmartPtr< TMINLP2TNLP > tnlp )
virtual

Set the warm start in the solver.

Implements Bonmin::TNLPSolver.

◆ getUsedWarmStart()

virtual CoinWarmStart * Bonmin::IpoptSolver::getUsedWarmStart ( Ipopt::SmartPtr< TMINLP2TNLP > tnlp) const
virtual

Get warm start used in last optimization.

Implements Bonmin::TNLPSolver.

◆ getWarmStart()

virtual CoinWarmStart * Bonmin::IpoptSolver::getWarmStart ( Ipopt::SmartPtr< Bonmin::TMINLP2TNLP > tnlp) const
virtual

Get the warm start form the solver.

Implements Bonmin::TNLPSolver.

◆ getEmptyWarmStart()

virtual CoinWarmStart * Bonmin::IpoptSolver::getEmptyWarmStart ( ) const
virtual

Implements Bonmin::TNLPSolver.

◆ warmStartIsValid()

virtual bool Bonmin::IpoptSolver::warmStartIsValid ( const CoinWarmStart * ws) const
virtual

Check that warm start object is valid.

Implements Bonmin::TNLPSolver.

◆ enableWarmStart()

virtual void Bonmin::IpoptSolver::enableWarmStart ( )
virtual

Enable the warm start options in the solver.

Implements Bonmin::TNLPSolver.

◆ disableWarmStart()

virtual void Bonmin::IpoptSolver::disableWarmStart ( )
virtual

Disable the warm start options in the solver.

Implements Bonmin::TNLPSolver.

◆ CPUTime()

virtual double Bonmin::IpoptSolver::CPUTime ( )
virtual

Get the CpuTime of the last optimization.

Implements Bonmin::TNLPSolver.

◆ IterationCount()

virtual int Bonmin::IpoptSolver::IterationCount ( )
virtual

Get the iteration count of the last optimization.

Implements Bonmin::TNLPSolver.

◆ setOutputToDefault()

virtual void Bonmin::IpoptSolver::setOutputToDefault ( )
virtual

turn off all output from the solver

Implements Bonmin::TNLPSolver.

◆ forceSolverOutput()

virtual void Bonmin::IpoptSolver::forceSolverOutput ( int log_level)
virtual

turn on all output from the solver

Implements Bonmin::TNLPSolver.

◆ solverName()

virtual std::string & Bonmin::IpoptSolver::solverName ( )
inlinevirtual

Get the solver name.

Implements Bonmin::TNLPSolver.

Definition at line 123 of file BonIpoptSolver.hpp.

◆ RegisterOptions()

static void Bonmin::IpoptSolver::RegisterOptions ( Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
inlinestatic

Register this solver options into passed roptions.

Definition at line 129 of file BonIpoptSolver.hpp.

◆ getOptStatus()

Ipopt::ApplicationReturnStatus Bonmin::IpoptSolver::getOptStatus ( ) const
inline

Return status of last optimization.

Definition at line 137 of file BonIpoptSolver.hpp.

◆ getIpoptApp()

Ipopt::IpoptApplication & Bonmin::IpoptSolver::getIpoptApp ( )
inline

Definition at line 142 of file BonIpoptSolver.hpp.

◆ errorCode()

virtual int Bonmin::IpoptSolver::errorCode ( ) const
inlinevirtual

Error code (solver specific).

Implements Bonmin::TNLPSolver.

Definition at line 147 of file BonIpoptSolver.hpp.


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