#include <BonFilterSolver.hpp>

Inheritance diagram for Bonmin::FilterSolver:

Classes
struct	cachedInfo
	Cached information for reoptimizing. More...

class	UnsolvedFilterError

Public Types
typedef FilterTypes::fint	fint
	Fortran type for integer used in filter. More...

typedef FilterTypes::real	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 UnsolvedError *	newUnsolvedError (int num, Ipopt::SmartPtr< TMINLP2TNLP > problem, std::string name)

	FilterSolver (bool createEmpty=false)
	Default constructor. More...

	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. More...

	FilterSolver (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist)
	Constructor with passed journalist, roptions, options. More...

	FilterSolver (const FilterSolver &other)
	Copy constructor. More...

virtual	~FilterSolver ()
	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 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...

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. More...

Private Attributes
Coin::SmartPtr< FilterWarmStart >	warmF_

Coin::SmartPtr< cachedInfo >	cached_
	Cached information on last problem optimized for reoptimization. More...

int	default_log_level_
	To record default log level. More...

Static Private Attributes
static std::string	solverName_

Friends
struct	BqpdSolver::cachedInfo

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 BonFilterSolver.hpp.

Member Typedef Documentation

typedef FilterTypes::fint Bonmin::FilterSolver::fint

Fortran type for integer used in filter.

Definition at line 46 of file BonFilterSolver.hpp.

typedef FilterTypes::real Bonmin::FilterSolver::real

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
	)

inlinevirtual

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

inlinevirtual

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 ( )

inlinevirtual

Solves a problem expresses as a TNLP.

Implements Bonmin::TNLPSolver.

Definition at line 118 of file BonFilterSolver.hpp.

virtual void Bonmin::FilterSolver::disableWarmStart ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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 )

inlinevirtual

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 ( )

inlinevirtual

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

inlinevirtual

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
	)

staticprivate

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_

staticprivate

Definition at line 336 of file BonFilterSolver.hpp.

Referenced by solverName().

int Bonmin::FilterSolver::default_log_level_

private

To record default log level.

Definition at line 339 of file BonFilterSolver.hpp.

Referenced by setOutputToDefault().

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

BonFilterSolver.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation