DefaultSolver Class Reference

The Default Solver Class. More...

#include <OSDefaultSolver.h>

Inheritance diagram for DefaultSolver:

Inheritance graph
[legend]
Collaboration diagram for DefaultSolver:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void solve ()=0
 solve is a virtual function -- the actual solvers will implement their own solve method
virtual void buildSolverInstance ()=0
 buildSolverInstance is a virtual function -- the actual solvers will implement their own buildSolverInstance method -- the solver instance is the instance the individual solver sees in its API
virtual void setSolverOptions ()=0
 setSolverOptions is a virtual function -- the actual solvers will implement their own setSolverOptions method -- the solver options are the options the individual solver sees in its API
 DefaultSolver ()
 default constructor.
virtual ~DefaultSolver ()=0
 default destructor.

Public Attributes

std::string osil
 osil holds the problem instance as a std::string
std::string osol
 osol holds the options for the solver
std::string osrl
 osrl holds the solution or result of the model
OSInstanceosinstance
 osinstance holds the problem instance in-memory as an OSInstance object
OSOptionosoption
 osoption holds the solver options in-memory as an OSOption object
OSResultosresult
 osresult holds the solution or result of the model in-memory as an OSResult object
std::string sSolverName
 sSolverName is the name of the Coin solver used, e.g.
bool bCallbuildSolverInstance
 bCallbuildSolverInstance is set to true if buildSolverService has been called
bool bSetSolverOptions
 bSetSolverOptions is set to true if setSolverOptions has been called, false otherwise

Detailed Description

The Default Solver Class.

Author:
Robert Fourer, Jun Ma, Kipp Martin,
Version:
1.0, 10/05/2005
Since:
OS1.0

Definition at line 35 of file OSDefaultSolver.h.


Constructor & Destructor Documentation

DefaultSolver::DefaultSolver (  ) 

default constructor.

Definition at line 23 of file OSDefaultSolver.cpp.

DefaultSolver::~DefaultSolver (  )  [pure virtual]

default destructor.

Definition at line 39 of file OSDefaultSolver.cpp.


Member Function Documentation

virtual void DefaultSolver::solve (  )  [pure virtual]

solve is a virtual function -- the actual solvers will implement their own solve method

Implemented in BonminSolver, CoinSolver, CouenneSolver, IpoptSolver, KnitroSolver, and LindoSolver.

Referenced by OS_DipInterface::generateInitialMaster(), main(), runSolver(), and OSMatlab::solve().

virtual void DefaultSolver::buildSolverInstance (  )  [pure virtual]

buildSolverInstance is a virtual function -- the actual solvers will implement their own buildSolverInstance method -- the solver instance is the instance the individual solver sees in its API

Implemented in BonminSolver, CoinSolver, CouenneSolver, IpoptSolver, KnitroSolver, and LindoSolver.

Referenced by main(), and runSolver().

virtual void DefaultSolver::setSolverOptions (  )  [pure virtual]

setSolverOptions is a virtual function -- the actual solvers will implement their own setSolverOptions method -- the solver options are the options the individual solver sees in its API

Implemented in BonminSolver, CoinSolver, CouenneSolver, IpoptSolver, KnitroSolver, and LindoSolver.

Referenced by main(), and runSolver().


Member Data Documentation

std::string DefaultSolver::osil

osil holds the problem instance as a std::string

Definition at line 43 of file OSDefaultSolver.h.

Referenced by LindoSolver::buildSolverInstance(), IpoptSolver::buildSolverInstance(), CouenneSolver::buildSolverInstance(), CoinSolver::buildSolverInstance(), BonminSolver::buildSolverInstance(), main(), and KnitroSolver::solve().

std::string DefaultSolver::osol

osol holds the options for the solver

Definition at line 46 of file OSDefaultSolver.h.

Referenced by main(), runSolver(), IpoptSolver::setSolverOptions(), CouenneSolver::setSolverOptions(), CoinSolver::setSolverOptions(), BonminSolver::setSolverOptions(), OSMatlab::solve(), and CouenneSolver::solve().

std::string DefaultSolver::osrl

osrl holds the solution or result of the model

Definition at line 50 of file OSDefaultSolver.h.

Referenced by LindoSolver::buildSolverInstance(), KnitroSolver::buildSolverInstance(), CouenneSolver::buildSolverInstance(), CoinSolver::buildSolverInstance(), BonminSolver::buildSolverInstance(), LindoSolver::generateLindoModel(), CoinSolver::getCoinSolverType(), main(), LindoSolver::optimize(), LindoSolver::processConstraints(), LindoSolver::processNonlinearExpressions(), LindoSolver::processQuadraticTerms(), LindoSolver::processVariables(), runSolver(), CoinSolver::setCoinPackedMatrix(), LindoSolver::setSolverOptions(), CouenneSolver::setSolverOptions(), BonminSolver::setSolverOptions(), OSMatlab::solve(), LindoSolver::solve(), KnitroSolver::solve(), CouenneSolver::solve(), CoinSolver::solve(), BonminSolver::solve(), OSDipBlockCoinSolver::solve(), CouenneSolver::writeResult(), CoinSolver::writeResult(), and BonminSolver::writeResult().

OSInstance* DefaultSolver::osinstance

osinstance holds the problem instance in-memory as an OSInstance object

Definition at line 54 of file OSDefaultSolver.h.

Referenced by LindoSolver::buildSolverInstance(), IpoptSolver::buildSolverInstance(), CouenneSolver::buildSolverInstance(), CoinSolver::buildSolverInstance(), BonminSolver::buildSolverInstance(), LindoSolver::dataEchoCheck(), KnitroSolver::dataEchoCheck(), IpoptSolver::dataEchoCheck(), CoinSolver::dataEchoCheck(), BonminSolver::dataEchoCheck(), OS_DipInterface::generateInitialMaster(), LindoSolver::generateLindoModel(), OSBearcatSolverXkij::getInitialRestrictedMaster(), OSBearcatSolverXij::getInitialRestrictedMaster(), main(), OSBearcatSolverXij::OneOPT(), LindoSolver::optimize(), OSDipBlockCoinSolver::OSDipBlockCoinSolver(), LindoSolver::processConstraints(), LindoSolver::processNonlinearExpressions(), LindoSolver::processQuadraticTerms(), LindoSolver::processVariables(), OSColGenApp::resetMaster(), runSolver(), CoinSolver::setCoinPackedMatrix(), IpoptSolver::setSolverOptions(), CoinSolver::setSolverOptions(), OSMatlab::solve(), KnitroSolver::solve(), CouenneSolver::solve(), CoinSolver::solve(), BonminSolver::solve(), OSColGenApp::solve(), CouenneSolver::writeResult(), CoinSolver::writeResult(), and BonminSolver::writeResult().

OSOption* DefaultSolver::osoption

osoption holds the solver options in-memory as an OSOption object

Definition at line 58 of file OSDefaultSolver.h.

Referenced by IpoptSolver::buildSolverInstance(), BonminSolver::buildSolverInstance(), OS_DipInterface::generateInitialMaster(), OSBearcatSolverXkij::getInitialRestrictedMaster(), main(), OSColGenApp::resetMaster(), IpoptSolver::setSolverOptions(), CouenneSolver::setSolverOptions(), CoinSolver::setSolverOptions(), BonminSolver::setSolverOptions(), CouenneSolver::solve(), and OSColGenApp::solve().

OSResult* DefaultSolver::osresult

osresult holds the solution or result of the model in-memory as an OSResult object

Definition at line 61 of file OSDefaultSolver.h.

Referenced by BonminSolver::BonminSolver(), LindoSolver::buildSolverInstance(), KnitroSolver::buildSolverInstance(), IpoptSolver::buildSolverInstance(), CouenneSolver::buildSolverInstance(), CoinSolver::buildSolverInstance(), BonminSolver::buildSolverInstance(), CouenneSolver::CouenneSolver(), OS_DipInterface::generateInitialMaster(), LindoSolver::generateLindoModel(), CoinSolver::getCoinSolverType(), OSBearcatSolverXkij::getInitialRestrictedMaster(), OSBearcatSolverXij::getRouteDistance(), IpoptSolver::IpoptSolver(), KnitroSolver::KnitroSolver(), main(), LindoSolver::optimize(), LindoSolver::processConstraints(), LindoSolver::processNonlinearExpressions(), LindoSolver::processQuadraticTerms(), LindoSolver::processVariables(), CoinSolver::setCoinPackedMatrix(), LindoSolver::setSolverOptions(), IpoptSolver::setSolverOptions(), CouenneSolver::setSolverOptions(), BonminSolver::setSolverOptions(), LindoSolver::solve(), KnitroSolver::solve(), IpoptSolver::solve(), CouenneSolver::solve(), CoinSolver::solve(), BonminSolver::solve(), OSDipBlockCoinSolver::solve(), OSColGenApp::solveRestrictedMasterRelaxation(), CouenneSolver::writeResult(), CoinSolver::writeResult(), BonminSolver::writeResult(), BonminSolver::~BonminSolver(), CoinSolver::~CoinSolver(), CouenneSolver::~CouenneSolver(), IpoptSolver::~IpoptSolver(), KnitroSolver::~KnitroSolver(), and LindoSolver::~LindoSolver().

std::string DefaultSolver::sSolverName

sSolverName is the name of the Coin solver used, e.g.

glpk, or clp

Definition at line 68 of file OSDefaultSolver.h.

Referenced by CoinSolver::buildSolverInstance(), OS_DipInterface::generateInitialMaster(), OSBearcatSolverXkij::getInitialRestrictedMaster(), main(), OSDipBlockCoinSolver::OSDipBlockCoinSolver(), OSColGenApp::resetMaster(), runSolver(), CoinSolver::setSolverOptions(), OSMatlab::solve(), CoinSolver::solve(), OSColGenApp::solve(), and CoinSolver::writeResult().

bool DefaultSolver::bCallbuildSolverInstance

bCallbuildSolverInstance is set to true if buildSolverService has been called

Definition at line 75 of file OSDefaultSolver.h.

Referenced by LindoSolver::buildSolverInstance(), IpoptSolver::buildSolverInstance(), CouenneSolver::buildSolverInstance(), CoinSolver::buildSolverInstance(), and BonminSolver::buildSolverInstance().

bool DefaultSolver::bSetSolverOptions

bSetSolverOptions is set to true if setSolverOptions has been called, false otherwise

Definition at line 82 of file OSDefaultSolver.h.

Referenced by IpoptSolver::setSolverOptions(), CouenneSolver::setSolverOptions(), CoinSolver::setSolverOptions(), and BonminSolver::setSolverOptions().


The documentation for this class was generated from the following files:
Generated on Thu Nov 10 03:12:28 2011 by  doxygen 1.4.7