Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
Bonmin::HeuristicLocalBranching Class Reference

#include <BonHeuristicLocalBranching.hpp>

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

Public Member Functions

 HeuristicLocalBranching ()
 Default constructor. More...
 
 HeuristicLocalBranching (BonminSetup *setup)
 Constructor with setup. More...
 
 HeuristicLocalBranching (const HeuristicLocalBranching &other)
 Copy constructor. More...
 
virtual CbcHeuristic * clone () const
 Virtual constructor. More...
 
virtual ~HeuristicLocalBranching ()
 Destructor. More...
 
virtual void setModel (CbcModel *model)
 Update model. More...
 
virtual void validate ()
 Validate model i.e. sets when_ to 0 if necessary. More...
 
int solution (double &objectiveValue, double *newSolution)
 Runs heuristic. More...
 
void Initialize (Ipopt::SmartPtr< Ipopt::OptionsList > options)
 Initiaize using passed options. More...
 
- Public Member Functions inherited from Bonmin::LocalSolverBasedHeuristic
 LocalSolverBasedHeuristic ()
 Default constructor. More...
 
 LocalSolverBasedHeuristic (BonminSetup *setup)
 Constructor with setup. More...
 
 LocalSolverBasedHeuristic (const LocalSolverBasedHeuristic &other)
 Copy constructor. More...
 
 ~LocalSolverBasedHeuristic ()
 Destructor. 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, 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 Public Member Functions inherited from Bonmin::LocalSolverBasedHeuristic
static void registerOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register the options common to all local search based heuristics. More...
 

Private Attributes

int howOften_
 How often to do (code can change) More...
 
int numberSolutions_
 Number of solutions so we can do something at solution. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from Bonmin::LocalSolverBasedHeuristic
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 inherited from Bonmin::LocalSolverBasedHeuristic
BonminSetupsetup_
 Setup to use for local searches (will make copies). More...
 

Detailed Description

Definition at line 16 of file BonHeuristicLocalBranching.hpp.

Constructor & Destructor Documentation

Bonmin::HeuristicLocalBranching::HeuristicLocalBranching ( )

Default constructor.

Definition at line 18 of file BonHeuristicLocalBranching.cpp.

Bonmin::HeuristicLocalBranching::HeuristicLocalBranching ( BonminSetup setup)

Constructor with setup.

Definition at line 24 of file BonHeuristicLocalBranching.cpp.

Bonmin::HeuristicLocalBranching::HeuristicLocalBranching ( const HeuristicLocalBranching other)

Copy constructor.

Definition at line 32 of file BonHeuristicLocalBranching.cpp.

Bonmin::HeuristicLocalBranching::~HeuristicLocalBranching ( )
virtual

Destructor.

Definition at line 38 of file BonHeuristicLocalBranching.cpp.

Member Function Documentation

virtual CbcHeuristic* Bonmin::HeuristicLocalBranching::clone ( ) const
inlinevirtual

Virtual constructor.

Implements Bonmin::LocalSolverBasedHeuristic.

Definition at line 26 of file BonHeuristicLocalBranching.hpp.

void Bonmin::HeuristicLocalBranching::setModel ( CbcModel *  model)
virtual

Update model.

Definition at line 42 of file BonHeuristicLocalBranching.cpp.

void Bonmin::HeuristicLocalBranching::validate ( )
virtual

Validate model i.e. sets when_ to 0 if necessary.

Definition at line 50 of file BonHeuristicLocalBranching.cpp.

int Bonmin::HeuristicLocalBranching::solution ( double &  objectiveValue,
double *  newSolution 
)
virtual

Runs heuristic.

Implements Bonmin::LocalSolverBasedHeuristic.

Definition at line 78 of file BonHeuristicLocalBranching.cpp.

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

Register the options common to all local search based heuristics.

Definition at line 122 of file BonHeuristicLocalBranching.cpp.

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

Initiaize using passed options.

Definition at line 136 of file BonHeuristicLocalBranching.cpp.

Member Data Documentation

int Bonmin::HeuristicLocalBranching::howOften_
private

How often to do (code can change)

Definition at line 51 of file BonHeuristicLocalBranching.hpp.

int Bonmin::HeuristicLocalBranching::numberSolutions_
private

Number of solutions so we can do something at solution.

Definition at line 53 of file BonHeuristicLocalBranching.hpp.


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