Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | List of all members
Bonmin::LocalSolverBasedHeuristic Class Referenceabstract

#include <BonLocalSolverBasedHeuristic.hpp>

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

Public Member Functions

 LocalSolverBasedHeuristic ()
 Default constructor. More...
 
 LocalSolverBasedHeuristic (BonminSetup *setup)
 Constructor with setup. More...
 
 LocalSolverBasedHeuristic (const LocalSolverBasedHeuristic &other)
 Copy constructor. More...
 
 ~LocalSolverBasedHeuristic ()
 Destructor. More...
 
virtual CbcHeuristic * clone () const =0
 Virtual copy constructor. More...
 
LocalSolverBasedHeuristicoperator= (const LocalSolverBasedHeuristic &rhs)
 Assignment operator. More...
 
virtual void resetModel (CbcModel *model)
 Resets stuff if model changes. More...
 
void setSetup (BonminSetup *setup)
 Change setup used for heuristic. More...
 
virtual int solution (double &objectiveValue, double *newSolution)=0
 Performs heuristic. More...
 
virtual int solution (double &objectiveValue, double *newSolution, OsiCuts &cs)
 Performs heuristic which adds cuts. More...
 
int doLocalSearch (OsiTMINLPInterface *solver, double *solution, double &solValue, double cutoff, std::string prefix="local_solver.") const
 Do a local search based on setup and passed solver. More...
 
virtual void setupDefaults (Ipopt::SmartPtr< Ipopt::OptionsList > options)
 Setup the defaults. More...
 
void Initialize (Ipopt::SmartPtr< Ipopt::OptionsList > options)
 Initiaize using passed options. More...
 

Static Public Member Functions

static void registerOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register the options common to all local search based heuristics. More...
 

Static Protected Member Functions

static void changeIfNotSet (Ipopt::SmartPtr< Ipopt::OptionsList > options, std::string prefix, const std::string &option, const std::string &value)
 
static void changeIfNotSet (Ipopt::SmartPtr< Ipopt::OptionsList > options, std::string prefix, const std::string &option, const double &value)
 
static void changeIfNotSet (Ipopt::SmartPtr< Ipopt::OptionsList > options, std::string prefix, const std::string &option, const int &value)
 

Protected Attributes

BonminSetupsetup_
 Setup to use for local searches (will make copies). More...
 

Private Attributes

double time_limit_
 Time limit in local search. More...
 
int max_number_nodes_
 maximal number of nodes in local search. More...
 
int max_number_solutions_
 Maximal number of solutions in local search. More...
 

Detailed Description

Definition at line 15 of file BonLocalSolverBasedHeuristic.hpp.

Constructor & Destructor Documentation

Bonmin::LocalSolverBasedHeuristic::LocalSolverBasedHeuristic ( )

Default constructor.

Definition at line 13 of file BonLocalSolverBasedHeuristic.cpp.

Bonmin::LocalSolverBasedHeuristic::LocalSolverBasedHeuristic ( BonminSetup setup)

Constructor with setup.

Definition at line 20 of file BonLocalSolverBasedHeuristic.cpp.

Bonmin::LocalSolverBasedHeuristic::LocalSolverBasedHeuristic ( const LocalSolverBasedHeuristic other)

Copy constructor.

Definition at line 29 of file BonLocalSolverBasedHeuristic.cpp.

Bonmin::LocalSolverBasedHeuristic::~LocalSolverBasedHeuristic ( )

Destructor.

Definition at line 37 of file BonLocalSolverBasedHeuristic.cpp.

Member Function Documentation

virtual CbcHeuristic* Bonmin::LocalSolverBasedHeuristic::clone ( ) const
pure virtual
LocalSolverBasedHeuristic & Bonmin::LocalSolverBasedHeuristic::operator= ( const LocalSolverBasedHeuristic rhs)

Assignment operator.

Definition at line 41 of file BonLocalSolverBasedHeuristic.cpp.

virtual void Bonmin::LocalSolverBasedHeuristic::resetModel ( CbcModel *  model)
inlinevirtual

Resets stuff if model changes.

Definition at line 40 of file BonLocalSolverBasedHeuristic.hpp.

void Bonmin::LocalSolverBasedHeuristic::setSetup ( BonminSetup setup)
inline

Change setup used for heuristic.

Definition at line 45 of file BonLocalSolverBasedHeuristic.hpp.

virtual int Bonmin::LocalSolverBasedHeuristic::solution ( double &  objectiveValue,
double *  newSolution 
)
pure virtual
virtual int Bonmin::LocalSolverBasedHeuristic::solution ( double &  objectiveValue,
double *  newSolution,
OsiCuts &  cs 
)
inlinevirtual

Performs heuristic which adds cuts.

Definition at line 54 of file BonLocalSolverBasedHeuristic.hpp.

int Bonmin::LocalSolverBasedHeuristic::doLocalSearch ( OsiTMINLPInterface solver,
double *  solution,
double &  solValue,
double  cutoff,
std::string  prefix = "local_solver." 
) const

Do a local search based on setup and passed solver.

Definition at line 91 of file BonLocalSolverBasedHeuristic.cpp.

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

Register the options common to all local search based heuristics.

Definition at line 112 of file BonLocalSolverBasedHeuristic.cpp.

void Bonmin::LocalSolverBasedHeuristic::setupDefaults ( Ipopt::SmartPtr< Ipopt::OptionsList >  options)
virtual

Setup the defaults.

Reimplemented in Bonmin::PumpForMinlp.

Definition at line 81 of file BonLocalSolverBasedHeuristic.cpp.

void Bonmin::LocalSolverBasedHeuristic::Initialize ( Ipopt::SmartPtr< Ipopt::OptionsList >  options)

Initiaize using passed options.

Some fancy defaults.

Definition at line 117 of file BonLocalSolverBasedHeuristic.cpp.

void Bonmin::LocalSolverBasedHeuristic::changeIfNotSet ( Ipopt::SmartPtr< Ipopt::OptionsList >  options,
std::string  prefix,
const std::string &  option,
const std::string &  value 
)
staticprotected

Definition at line 50 of file BonLocalSolverBasedHeuristic.cpp.

void Bonmin::LocalSolverBasedHeuristic::changeIfNotSet ( Ipopt::SmartPtr< Ipopt::OptionsList >  options,
std::string  prefix,
const std::string &  option,
const double &  value 
)
staticprotected

Definition at line 60 of file BonLocalSolverBasedHeuristic.cpp.

void Bonmin::LocalSolverBasedHeuristic::changeIfNotSet ( Ipopt::SmartPtr< Ipopt::OptionsList >  options,
std::string  prefix,
const std::string &  option,
const int value 
)
staticprotected

Definition at line 70 of file BonLocalSolverBasedHeuristic.cpp.

Member Data Documentation

BonminSetup* Bonmin::LocalSolverBasedHeuristic::setup_
protected

Setup to use for local searches (will make copies).

Definition at line 75 of file BonLocalSolverBasedHeuristic.hpp.

double Bonmin::LocalSolverBasedHeuristic::time_limit_
private

Time limit in local search.

Definition at line 93 of file BonLocalSolverBasedHeuristic.hpp.

int Bonmin::LocalSolverBasedHeuristic::max_number_nodes_
private

maximal number of nodes in local search.

Definition at line 95 of file BonLocalSolverBasedHeuristic.hpp.

int Bonmin::LocalSolverBasedHeuristic::max_number_solutions_
private

Maximal number of solutions in local search.

Definition at line 97 of file BonLocalSolverBasedHeuristic.hpp.


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