Bonmin 1.8.9
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Friends | List of all members
Bonmin::BqpdSolver Class Reference

#include <BonBqpdSolver.hpp>

+ Inheritance diagram for Bonmin::BqpdSolver:
+ Collaboration diagram for Bonmin::BqpdSolver:

Classes

class  UnsolvedBqpdError
 

Public Types

typedef ipfint fint
 Fortran type for integer used in filter.
 
typedef double real
 Fortran type for double.used in filter.
 
- 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...
 

Public Member Functions

virtual UnsolvedErrornewUnsolvedError (int num, Ipopt::SmartPtr< TMINLP2TNLP > problem, std::string name)
 
 BqpdSolver (bool createEmpty=false)
 Default constructor.
 
 BqpdSolver (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist, const std::string &prefix)
 Constructor with passed journalist, roptions, options.
 
virtual ~BqpdSolver ()
 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
 

Friends

class FilterSolver
 

Solve methods

virtual ReturnStatus OptimizeTNLP (const Ipopt::SmartPtr< Ipopt::TNLP > &tnlp)
 Solves a problem expresses as a TNLP.
 
virtual 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 bool markHotStart ()
 Safe the current state (after most recent solve that must have been successful) as hot start information and use that for all further solves, until unmarkHotStart is called.
 
virtual CoinWarmStartgetUsedWarmStart (Ipopt::SmartPtr< TMINLP2TNLP > tnlp) const
 Get warm start used in last optimization.
 
virtual CoinWarmStartgetWarmStart (Ipopt::SmartPtr< 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 Ipopt::SmartPtr< TNLPSolverclone ()
 Virtual copy constructor.
 
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.
 
void registerOptions ()
 Register this solver options into passed roptions.
 
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

- 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 20 of file BonBqpdSolver.hpp.

Member Typedef Documentation

◆ fint

Fortran type for integer used in filter.

Definition at line 46 of file BonBqpdSolver.hpp.

◆ real

typedef double Bonmin::BqpdSolver::real

Fortran type for double.used in filter.

Definition at line 48 of file BonBqpdSolver.hpp.

Constructor & Destructor Documentation

◆ BqpdSolver() [1/2]

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

Default constructor.

◆ BqpdSolver() [2/2]

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

Constructor with passed journalist, roptions, options.

◆ ~BqpdSolver()

virtual Bonmin::BqpdSolver::~BqpdSolver ( )
virtual

destructor

Member Function Documentation

◆ newUnsolvedError()

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

Implements Bonmin::TNLPSolver.

Definition at line 51 of file BonBqpdSolver.hpp.

◆ Initialize() [1/2]

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

Initialize the TNLPSolver (read options from params_file)

Implements Bonmin::TNLPSolver.

◆ Initialize() [2/2]

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

Initialize the TNLPSolver (read options from istream is)

Implements Bonmin::TNLPSolver.

◆ OptimizeTNLP()

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

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

◆ ReOptimizeTNLP()

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

Resolves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

◆ setWarmStart()

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

Set the warm start in the solver.

Implements Bonmin::TNLPSolver.

◆ markHotStart()

virtual bool Bonmin::BqpdSolver::markHotStart ( )
inlinevirtual

Safe the current state (after most recent solve that must have been successful) as hot start information and use that for all further solves, until unmarkHotStart is called.

Definition at line 94 of file BonBqpdSolver.hpp.

◆ getUsedWarmStart()

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

Get warm start used in last optimization.

Implements Bonmin::TNLPSolver.

Definition at line 97 of file BonBqpdSolver.hpp.

◆ getWarmStart()

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

Get the warm start form the solver.

Implements Bonmin::TNLPSolver.

◆ getEmptyWarmStart()

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

Implements Bonmin::TNLPSolver.

◆ warmStartIsValid()

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

Check that warm start object is valid.

Implements Bonmin::TNLPSolver.

◆ enableWarmStart()

virtual void Bonmin::BqpdSolver::enableWarmStart ( )
inlinevirtual

Enable the warm start options in the solver.

Implements Bonmin::TNLPSolver.

Definition at line 109 of file BonBqpdSolver.hpp.

◆ disableWarmStart()

virtual void Bonmin::BqpdSolver::disableWarmStart ( )
inlinevirtual

Disable the warm start options in the solver.

Implements Bonmin::TNLPSolver.

Definition at line 112 of file BonBqpdSolver.hpp.

◆ clone()

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

Virtual copy constructor.

Implements Bonmin::TNLPSolver.

◆ CPUTime()

virtual double Bonmin::BqpdSolver::CPUTime ( )
inlinevirtual

Get the CpuTime of the last optimization.

Implements Bonmin::TNLPSolver.

Definition at line 121 of file BonBqpdSolver.hpp.

◆ IterationCount()

virtual int Bonmin::BqpdSolver::IterationCount ( )
inlinevirtual

Get the iteration count of the last optimization.

Implements Bonmin::TNLPSolver.

Definition at line 127 of file BonBqpdSolver.hpp.

◆ setOutputToDefault()

virtual void Bonmin::BqpdSolver::setOutputToDefault ( )
inlinevirtual

turn off all output from the solver

Implements Bonmin::TNLPSolver.

Definition at line 134 of file BonBqpdSolver.hpp.

◆ forceSolverOutput()

virtual void Bonmin::BqpdSolver::forceSolverOutput ( int log_level)
inlinevirtual

turn on all output from the solver

Implements Bonmin::TNLPSolver.

Definition at line 139 of file BonBqpdSolver.hpp.

◆ solverName()

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

Get the solver name.

Implements Bonmin::TNLPSolver.

Definition at line 145 of file BonBqpdSolver.hpp.

◆ registerOptions() [1/2]

void Bonmin::BqpdSolver::registerOptions ( )
inline

Register this solver options into passed roptions.

Definition at line 151 of file BonBqpdSolver.hpp.

◆ errorCode()

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

Error code (solver specific).

Implements Bonmin::TNLPSolver.

Definition at line 157 of file BonBqpdSolver.hpp.

◆ registerOptions() [2/2]

static void Bonmin::BqpdSolver::registerOptions ( Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
static

Register this solver options into passed roptions.

Friends And Related Symbol Documentation

◆ FilterSolver

friend class FilterSolver
friend

Definition at line 23 of file BonBqpdSolver.hpp.


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