Bonmin  1.7
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends
Bonmin::FilterSolver Class Reference

#include <BonFilterSolver.hpp>

Inheritance diagram for Bonmin::FilterSolver:
Bonmin::TNLPSolver

List of all members.

Classes

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

Public Types

typedef FilterTypes::fint fint
 Fortran type for integer used in filter.
typedef FilterTypes::real real
 Fortran type for double.used in filter.

Public Member Functions

virtual UnsolvedErrornewUnsolvedError (int num, Ipopt::SmartPtr< TMINLP2TNLP > problem, std::string name)
 FilterSolver (bool createEmpty=false)
 Default constructor.
 FilterSolver (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.
 FilterSolver (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist)
 Constructor with passed journalist, roptions, options.
 FilterSolver (const FilterSolver &other)
 Copy constructor.
virtual ~FilterSolver ()
 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)
virtual Ipopt::SmartPtr
< TNLPSolver
clone ()
 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).
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 CoinWarmStart * getUsedWarmStart (Ipopt::SmartPtr< TMINLP2TNLP > tnlp) const
 Get warm start used in last optimization.
virtual CoinWarmStart * getWarmStart (Ipopt::SmartPtr< TMINLP2TNLP > tnlp) const
 Get the warm start form the solver.
virtual CoinWarmStart * getEmptyWarmStart () const
 Solves a problem expresses as a TNLP.
virtual bool warmStartIsValid (const CoinWarmStart *ws) const
 Check that warm start object is valid.
virtual void enableWarmStart ()
 Solves a problem expresses as a TNLP.
virtual void disableWarmStart ()
 Solves a problem expresses as a TNLP.

Static Public Member Functions

static void registerOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register this solver options into passed roptions.

Private Member Functions

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

Static Private Member Functions

static void TMat2RowPMat (bool symmetric, fint n, fint m, int nnz, const Ipopt::Index *iRow, const Ipopt::Index *iCol, int *permutation2, fint *lws, int nnz_offset, int n_offset, Ipopt::TNLP::IndexStyleEnum index_style)
 Converting TMatrices into row-ordered matrices.

Private Attributes

Coin::SmartPtr< FilterWarmStartwarmF_
Coin::SmartPtr< cachedInfocached_
 Cached information on last problem optimized for reoptimization.
int default_log_level_
 To record default log level.

Static Private Attributes

static std::string solverName_

Friends

struct BqpdSolver::cachedInfo

Detailed Description

Definition at line 20 of file BonFilterSolver.hpp.


Member Typedef Documentation

Fortran type for integer used in filter.

Definition at line 46 of file BonFilterSolver.hpp.

Fortran type for double.used in filter.

Definition at line 48 of file BonFilterSolver.hpp.


Constructor & Destructor Documentation

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

Default constructor.

Bonmin::FilterSolver::FilterSolver ( 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.

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

Constructor with passed journalist, roptions, options.

Bonmin::FilterSolver::FilterSolver ( const FilterSolver other)

Copy constructor.

virtual Bonmin::FilterSolver::~FilterSolver ( ) [virtual]

destructor


Member Function Documentation

virtual UnsolvedError* Bonmin::FilterSolver::newUnsolvedError ( int  num,
Ipopt::SmartPtr< TMINLP2TNLP problem,
std::string  name 
) [inline, virtual]

Implements Bonmin::TNLPSolver.

Definition at line 51 of file BonFilterSolver.hpp.

virtual bool Bonmin::FilterSolver::Initialize ( std::string  params_file) [virtual]

Initialize the TNLPSolver (read options from params_file)

Implements Bonmin::TNLPSolver.

virtual bool Bonmin::FilterSolver::Initialize ( std::istream &  is) [virtual]

Initialize the TNLPSolver (read options from istream is)

Implements Bonmin::TNLPSolver.

virtual ReturnStatus Bonmin::FilterSolver::OptimizeTNLP ( const Ipopt::SmartPtr< Ipopt::TNLP > &  tnlp) [virtual]

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

virtual ReturnStatus Bonmin::FilterSolver::ReOptimizeTNLP ( const Ipopt::SmartPtr< Ipopt::TNLP > &  tnlp) [virtual]

Resolves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

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

Set the warm start in the solver.

Implements Bonmin::TNLPSolver.

virtual CoinWarmStart* Bonmin::FilterSolver::getUsedWarmStart ( Ipopt::SmartPtr< TMINLP2TNLP tnlp) const [inline, virtual]

Get warm start used in last optimization.

Implements Bonmin::TNLPSolver.

Definition at line 102 of file BonFilterSolver.hpp.

References warmF_.

virtual CoinWarmStart* Bonmin::FilterSolver::getWarmStart ( Ipopt::SmartPtr< TMINLP2TNLP tnlp) const [virtual]

Get the warm start form the solver.

Implements Bonmin::TNLPSolver.

virtual CoinWarmStart* Bonmin::FilterSolver::getEmptyWarmStart ( ) const [virtual]

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

virtual bool Bonmin::FilterSolver::warmStartIsValid ( const CoinWarmStart *  ws) const [virtual]

Check that warm start object is valid.

Implements Bonmin::TNLPSolver.

virtual void Bonmin::FilterSolver::enableWarmStart ( ) [inline, virtual]

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

Definition at line 118 of file BonFilterSolver.hpp.

virtual void Bonmin::FilterSolver::disableWarmStart ( ) [inline, virtual]

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

Definition at line 121 of file BonFilterSolver.hpp.

References warmF_.

virtual Ipopt::SmartPtr<TNLPSolver> Bonmin::FilterSolver::clone ( ) [virtual]

Virtual copy constructor.

Implements Bonmin::TNLPSolver.

virtual double Bonmin::FilterSolver::CPUTime ( ) [inline, virtual]

Get the CpuTime of the last optimization.

Implements Bonmin::TNLPSolver.

Definition at line 132 of file BonFilterSolver.hpp.

References cached_.

virtual int Bonmin::FilterSolver::IterationCount ( ) [inline, virtual]

Get the iteration count of the last optimization.

Implements Bonmin::TNLPSolver.

Definition at line 138 of file BonFilterSolver.hpp.

References cached_.

virtual void Bonmin::FilterSolver::setOutputToDefault ( ) [inline, virtual]

turn off all output from the solver

Implements Bonmin::TNLPSolver.

Definition at line 144 of file BonFilterSolver.hpp.

References cached_, and default_log_level_.

virtual void Bonmin::FilterSolver::forceSolverOutput ( int  log_level) [inline, virtual]

turn on all output from the solver

Implements Bonmin::TNLPSolver.

Definition at line 149 of file BonFilterSolver.hpp.

References cached_.

virtual std::string& Bonmin::FilterSolver::solverName ( ) [inline, virtual]

Get the solver name.

Implements Bonmin::TNLPSolver.

Definition at line 155 of file BonFilterSolver.hpp.

References solverName_.

void Bonmin::FilterSolver::registerOptions ( ) [inline]

Register this solver options into passed roptions.

Definition at line 161 of file BonFilterSolver.hpp.

References Bonmin::TNLPSolver::roptions_.

virtual int Bonmin::FilterSolver::errorCode ( ) const [inline, virtual]

Error code (solver specific).

Implements Bonmin::TNLPSolver.

Definition at line 167 of file BonFilterSolver.hpp.

static void Bonmin::FilterSolver::registerOptions ( Ipopt::SmartPtr< Bonmin::RegisteredOptions roptions) [static]

Register this solver options into passed roptions.

TNLPSolver::ReturnStatus Bonmin::FilterSolver::callOptimizer ( ) [private]

Perform optimization using data structure in cache.

static void Bonmin::FilterSolver::TMat2RowPMat ( bool  symmetric,
fint  n,
fint  m,
int  nnz,
const Ipopt::Index *  iRow,
const Ipopt::Index *  iCol,
int *  permutation2,
fint lws,
int  nnz_offset,
int  n_offset,
Ipopt::TNLP::IndexStyleEnum  index_style 
) [static, private]

Converting TMatrices into row-ordered matrices.


Friends And Related Function Documentation

friend struct BqpdSolver::cachedInfo [friend]

Definition at line 24 of file BonFilterSolver.hpp.


Member Data Documentation

Coin::SmartPtr<FilterWarmStart> Bonmin::FilterSolver::warmF_ [private]

Definition at line 179 of file BonFilterSolver.hpp.

Referenced by disableWarmStart(), and getUsedWarmStart().

Coin::SmartPtr<cachedInfo> Bonmin::FilterSolver::cached_ [private]

Cached information on last problem optimized for reoptimization.

Definition at line 333 of file BonFilterSolver.hpp.

Referenced by CPUTime(), forceSolverOutput(), IterationCount(), and setOutputToDefault().

std::string Bonmin::FilterSolver::solverName_ [static, private]

Definition at line 336 of file BonFilterSolver.hpp.

Referenced by solverName().

To record default log level.

Reimplemented from Bonmin::TNLPSolver.

Definition at line 339 of file BonFilterSolver.hpp.

Referenced by setOutputToDefault().


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