Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
Bonmin::BqpdSolver Class Reference

#include <BonBqpdSolver.hpp>

Inheritance diagram for Bonmin::BqpdSolver:
Inheritance graph
[legend]
Collaboration diagram for Bonmin::BqpdSolver:
Collaboration graph
[legend]

Classes

struct  cachedInfo
 Cached information for reoptimizing. More...
 
class  UnsolvedBqpdError
 

Public Types

typedef ipfint fint
 Fortran type for integer used in filter. More...
 
typedef double real
 Fortran type for double.used in filter. More...
 
- 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. More...
 
 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. More...
 
virtual ~BqpdSolver ()
 destructor More...
 
virtual bool Initialize (std::string params_file)
 Initialize the TNLPSolver (read options from params_file) More...
 
virtual bool Initialize (std::istream &is)
 Initialize the TNLPSolver (read options from istream is) More...
 
virtual Ipopt::SmartPtr
< TNLPSolver
clone ()
 Virtual copy constructor. More...
 
virtual double CPUTime ()
 Get the CpuTime of the last optimization. More...
 
virtual int IterationCount ()
 Get the iteration count of the last optimization. More...
 
virtual void setOutputToDefault ()
 turn off all output from the solver More...
 
virtual void forceSolverOutput (int log_level)
 turn on all output from the solver More...
 
virtual std::string & solverName ()
 Get the solver name. More...
 
void registerOptions ()
 Register this solver options into passed roptions. More...
 
virtual int errorCode () const
 Error code (solver specific). More...
 
Solve methods
virtual ReturnStatus OptimizeTNLP (const Ipopt::SmartPtr< Ipopt::TNLP > &tnlp)
 Solves a problem expresses as a TNLP. More...
 
virtual ReturnStatus ReOptimizeTNLP (const Ipopt::SmartPtr< Ipopt::TNLP > &tnlp)
 Resolves a problem expresses as a TNLP. More...
 
virtual bool setWarmStart (const CoinWarmStart *warm, Ipopt::SmartPtr< TMINLP2TNLP > tnlp)
 Set the warm start in the solver. More...
 
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. More...
 
virtual CoinWarmStart * getUsedWarmStart (Ipopt::SmartPtr< TMINLP2TNLP > tnlp) const
 Get warm start used in last optimization. More...
 
virtual CoinWarmStart * getWarmStart (Ipopt::SmartPtr< TMINLP2TNLP > tnlp) const
 Get the warm start form the solver. More...
 
virtual CoinWarmStart * getEmptyWarmStart () const
 Solves a problem expresses as a TNLP. More...
 
virtual bool warmStartIsValid (const CoinWarmStart *ws) const
 Check that warm start object is valid. More...
 
virtual void enableWarmStart ()
 Solves a problem expresses as a TNLP. More...
 
virtual void disableWarmStart ()
 Solves a problem expresses as a TNLP. More...
 
- Public Member Functions inherited from Bonmin::TNLPSolver
 TNLPSolver ()
 default Constructor More...
 
 TNLPSolver (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist, const std::string &prefix)
 Constructor with options initialization. More...
 
virtual ~TNLPSolver ()
 Virtual destructor. More...
 
Ipopt::SmartPtr
< Ipopt::Journalist > 
journalist ()
 Get a pointer to a journalist. More...
 
Ipopt::SmartPtr
< Bonmin::RegisteredOptions
roptions ()
 Get a pointer to RegisteredOptions (generally used to add new ones) More...
 
Ipopt::SmartPtr< const
Ipopt::OptionsList > 
options () const
 Get the options (for getting their values). More...
 
Ipopt::SmartPtr
< Ipopt::OptionsList > 
options ()
 Get the options (for getting and setting their values). More...
 
const char * prefix ()
 Get the prefix. More...
 
bool isRecoverable (ReturnStatus &r)
 Say if an optimization status for a problem which failed is recoverable (problem may be solvable). More...
 
void setup_global_time_limit (double time_limit)
 Setup for a global time limit for solver. More...
 
bool isError (ReturnStatus &r)
 Say if return status is an error. More...
 

Static Public Member Functions

static void registerOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register this solver options into passed roptions. More...
 
- Static Public Member Functions inherited from Bonmin::TNLPSolver
static void RegisterOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register this solver options into passed roptions. More...
 

Private Member Functions

Private function members.
TNLPSolver::ReturnStatus callOptimizer ()
 Perform optimization using data structure in cache. More...
 

Private Attributes

Ipopt::SmartPtr< cachedInfocached_
 Cached information on last problem optimized for reoptimization. More...
 

Friends

class FilterSolver
 

User options

double fillin_factor_
 Fill-in factor for QP factorization. More...
 
int kmax_ipt_
 Fill-in factor for QP factorization. More...
 
int mlp_ipt_
 Fill-in factor for QP factorization. More...
 
static int m0de_ = 6
 Hot start m0de. More...
 
static int reinit_freq_ = 0
 Hot start reinitialization fequency. More...
 

of solver (Bqpd)

int default_log_level_
 To record default log level. More...
 
static std::string solverName_ = "Bqpd QP"
 To record default log level. More...
 

Additional Inherited Members

- 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. More...
 
void initializeOptionsAndJournalist ()
 Initializes options and journalist. More...
 
 TNLPSolver (const TNLPSolver &other)
 Copy Constructor. More...
 
- Protected Attributes inherited from Bonmin::TNLPSolver
Ipopt::SmartPtr
< Ipopt::Journalist > 
journalist_
 Storage of Journalist for output. More...
 
Ipopt::SmartPtr
< Ipopt::OptionsList > 
options_
 List of Options. More...
 
Ipopt::SmartPtr
< Bonmin::RegisteredOptions
roptions_
 Registered Options. More...
 
std::string prefix_
 Prefix to use for reading bonmin's options. More...
 
double start_time_
 Global start time. More...
 
double time_limit_
 Global time limit. More...
 
int default_log_level_
 To record default log level. More...
 

Detailed Description

Definition at line 20 of file BonBqpdSolver.hpp.

Member Typedef Documentation

typedef ipfint Bonmin::BqpdSolver::fint

Fortran type for integer used in filter.

Definition at line 46 of file BonBqpdSolver.hpp.

typedef double Bonmin::BqpdSolver::real

Fortran type for double.used in filter.

Definition at line 48 of file BonBqpdSolver.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 117 of file BonBqpdSolver.cpp.

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.

Definition at line 125 of file BonBqpdSolver.cpp.

Bonmin::BqpdSolver::~BqpdSolver ( )
virtual

destructor

Definition at line 166 of file BonBqpdSolver.cpp.

Member Function Documentation

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.

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

Initialize the TNLPSolver (read options from params_file)

Implements Bonmin::TNLPSolver.

Definition at line 170 of file BonBqpdSolver.cpp.

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

Initialize the TNLPSolver (read options from istream is)

Implements Bonmin::TNLPSolver.

Definition at line 199 of file BonBqpdSolver.cpp.

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

Solves a problem expresses as a TNLP.

Solves a problem expressed as a TQP.

Implements Bonmin::TNLPSolver.

Definition at line 209 of file BonBqpdSolver.cpp.

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

Resolves a problem expresses as a TNLP.

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

Definition at line 233 of file BonBqpdSolver.cpp.

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

Set the warm start in the solver.

Implements Bonmin::TNLPSolver.

Definition at line 900 of file BonBqpdSolver.cpp.

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.

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.

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

Get the warm start form the solver.

Implements Bonmin::TNLPSolver.

Definition at line 928 of file BonBqpdSolver.cpp.

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

Solves a problem expresses as a TNLP.

Solves a problem expressed as a TQP.

Implements Bonmin::TNLPSolver.

Definition at line 940 of file BonBqpdSolver.cpp.

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

Check that warm start object is valid.

Implements Bonmin::TNLPSolver.

Definition at line 951 of file BonBqpdSolver.cpp.

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

Solves a problem expresses as a TNLP.

Solves a problem expressed as a TQP.

Implements Bonmin::TNLPSolver.

Definition at line 109 of file BonBqpdSolver.hpp.

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

Solves a problem expresses as a TNLP.

Solves a problem expressed as a TQP.

Implements Bonmin::TNLPSolver.

Definition at line 112 of file BonBqpdSolver.hpp.

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

Virtual copy constructor.

Implements Bonmin::TNLPSolver.

Definition at line 144 of file BonBqpdSolver.cpp.

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

Get the CpuTime of the last optimization.

Implements Bonmin::TNLPSolver.

Definition at line 121 of file BonBqpdSolver.hpp.

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.

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

turn off all output from the solver

Implements Bonmin::TNLPSolver.

Definition at line 134 of file BonBqpdSolver.hpp.

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.

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

Get the solver name.

Implements Bonmin::TNLPSolver.

Definition at line 145 of file BonBqpdSolver.hpp.

void Bonmin::BqpdSolver::registerOptions ( )
inline

Register this solver options into passed roptions.

Definition at line 151 of file BonBqpdSolver.hpp.

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

Error code (solver specific).

Implements Bonmin::TNLPSolver.

Definition at line 157 of file BonBqpdSolver.hpp.

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

Register this solver options into passed roptions.

Definition at line 109 of file BonBqpdSolver.cpp.

TNLPSolver::ReturnStatus Bonmin::BqpdSolver::callOptimizer ( )
private

Perform optimization using data structure in cache.

Solves a problem expresses as a TNLP.

Definition at line 430 of file BonBqpdSolver.cpp.

Friends And Related Function Documentation

friend class FilterSolver
friend

Definition at line 23 of file BonBqpdSolver.hpp.

Member Data Documentation

double Bonmin::BqpdSolver::fillin_factor_
private

Fill-in factor for QP factorization.

Definition at line 196 of file BonBqpdSolver.hpp.

int Bonmin::BqpdSolver::kmax_ipt_
private

Fill-in factor for QP factorization.

Definition at line 197 of file BonBqpdSolver.hpp.

int Bonmin::BqpdSolver::mlp_ipt_
private

Fill-in factor for QP factorization.

Definition at line 198 of file BonBqpdSolver.hpp.

int Bonmin::BqpdSolver::m0de_ = 6
staticprivate

Hot start m0de.

Definition at line 200 of file BonBqpdSolver.hpp.

int Bonmin::BqpdSolver::reinit_freq_ = 0
staticprivate

Hot start reinitialization fequency.

Definition at line 202 of file BonBqpdSolver.hpp.

Ipopt::SmartPtr<cachedInfo> Bonmin::BqpdSolver::cached_
private

Cached information on last problem optimized for reoptimization.

Definition at line 406 of file BonBqpdSolver.hpp.

std::string Bonmin::BqpdSolver::solverName_ = "Bqpd QP"
staticprivate

To record default log level.

Definition at line 409 of file BonBqpdSolver.hpp.

int Bonmin::BqpdSolver::default_log_level_
private

To record default log level.

Definition at line 412 of file BonBqpdSolver.hpp.


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