OS 2.10.2
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
CoinSolver Class Reference

Implements a solve method for the Coin solvers. More...

#include <OSCoinSolver.h>

+ Inheritance diagram for CoinSolver:
+ Collaboration diagram for CoinSolver:

Public Member Functions

 CoinSolver ()
 The class constructor.
 
 ~CoinSolver ()
 The class destructor.
 
virtual void solve () throw (ErrorClass)
 The implementation of the corresponding virtual function.
 
virtual void buildSolverInstance () throw (ErrorClass)
 The implementation of the corresponding virtual function.
 
virtual void setSolverOptions () throw (ErrorClass)
 The implementation of the corresponding virtual function.
 
bool setCoinPackedMatrix ()
 Create a CoinPackedMatrix.
 
std::string getCoinSolverType (std::string osol_)
 Get the solver type, e.g.
 
void dataEchoCheck ()
 Print out problem parameters.
 
void writeResult (OsiSolverInterface *solver)
 
void writeResult (CbcModel *model)
 
- Public Member Functions inherited from DefaultSolver
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

OsiSolverInterfaceosiSolver
 osiSolver is the osi solver object – in this case clp, glpk, cbc, cplex, symphony or dylp
 
OSiLReaderm_osilreader
 m_osilreader is an OSiLReader object used to create an osinstance from an osil string if needed
 
OSoLReaderm_osolreader
 m_osolreader is an OSoLReader object used to create an osoption from an osol string if needed
 
- Public Attributes inherited from DefaultSolver
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

Implements a solve method for the Coin solvers.

This class implements a solve method for the Coin solvers It reads an OSInstance object and puts into the Coin OSI format

Definition at line 37 of file OSCoinSolver.h.

Constructor & Destructor Documentation

◆ CoinSolver()

CoinSolver::CoinSolver ( )

The class constructor.

◆ ~CoinSolver()

CoinSolver::~CoinSolver ( )

The class destructor.

Member Function Documentation

◆ solve()

void CoinSolver::solve ( )
throw (ErrorClass
)
virtual

The implementation of the corresponding virtual function.

Returns
void.

Implements DefaultSolver.

◆ buildSolverInstance()

void CoinSolver::buildSolverInstance ( )
throw (ErrorClass
)
virtual

The implementation of the corresponding virtual function.

Returns
void.

Implements DefaultSolver.

◆ setSolverOptions()

void CoinSolver::setSolverOptions ( )
throw (ErrorClass
)
virtual

The implementation of the corresponding virtual function.

Returns
void.

Implements DefaultSolver.

◆ setCoinPackedMatrix()

bool CoinSolver::setCoinPackedMatrix ( )

Create a CoinPackedMatrix.

Returns
true if a CoinPackedMatrix successfully created.

◆ getCoinSolverType()

string CoinSolver::getCoinSolverType ( std::string  osol_)

Get the solver type, e.g.

clp or glpk

Parameters
astring that is an instance of OSoL
Returns
a string which contains the value of clp or glpk.

◆ dataEchoCheck()

string CoinSolver::dataEchoCheck ( )

Print out problem parameters.

Returns
void

◆ writeResult() [1/2]

void CoinSolver::writeResult ( OsiSolverInterface solver)

◆ writeResult() [2/2]

void CoinSolver::writeResult ( CbcModel model)

Member Data Documentation

◆ osiSolver

OsiSolverInterface* CoinSolver::osiSolver

osiSolver is the osi solver object – in this case clp, glpk, cbc, cplex, symphony or dylp

Definition at line 93 of file OSCoinSolver.h.

◆ m_osilreader

OSiLReader* CoinSolver::m_osilreader

m_osilreader is an OSiLReader object used to create an osinstance from an osil string if needed

Definition at line 101 of file OSCoinSolver.h.

◆ m_osolreader

OSoLReader* CoinSolver::m_osolreader

m_osolreader is an OSoLReader object used to create an osoption from an osol string if needed

Definition at line 107 of file OSCoinSolver.h.


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