DyLP  1.10.1
Friends | List of all members
OsiDylpSolverInterface Class Reference

COIN OSI API for dylp. More...

#include <OsiDylpSolverInterface.hpp>

+ Inheritance diagram for OsiDylpSolverInterface:
+ Collaboration diagram for OsiDylpSolverInterface:

Public Member Functions

Constructors and Destructors
 OsiDylpSolverInterface ()
 Default constructor. More...
 
 OsiDylpSolverInterface (const OsiDylpSolverInterface &src)
 Copy constructor. More...
 
OsiSolverInterface * clone (bool copyData=true) const
 Clone the solver object. More...
 
OsiDylpSolverInterfaceoperator= (const OsiDylpSolverInterface &rhs)
 Assignment. More...
 
 ~OsiDylpSolverInterface ()
 Destructor. More...
 
void reset ()
 Reset the solver object to the state produced by the default constructor. More...
 
Methods to load a problem
int readMps (const char *filename, const char *extension="mps")
 Read a problem description in MPS format from a file. More...
 
int readMps (const char *filename, const char *extension, int &numberSets, CoinSet **&sets)
 Read a problem description in MPS format from a file, including SOS information. More...
 
void writeMps (const char *basename, const char *extension="mps", double objsense=0.0) const
 Write the problem into the specified file in MPS format. More...
 
void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const char *rowsen, const double *rowrhs, const double *rowrng)
 Load a problem description (OSI packed matrix, row sense, parameters unaffected). More...
 
void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub)
 Load a problem description (OSI packed matrix, row bounds, parameters unaffected). More...
 
void loadProblem (const int colcnt, const int rowcnt, const int *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const char *sense, const double *rhsin, const double *range)
 Load a problem description (standard column-major packed matrix, row sense, parameters unaffected) More...
 
void loadProblem (const int colcnt, const int rowcnt, const int *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const double *row_lower, const double *row_upper)
 Load a problem description (standard column-major packed matrix, row bounds, parameters unaffected) More...
 
void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, char *&rowsen, double *&rowrhs, double *&rowrng)
 Load a problem description (OSI packed matrix, row sense, parameters destroyed). More...
 
void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, double *&rowlb, double *&rowub)
 Load a problem description (OSI packed matrix, row bounds, parameters destroyed). More...
 
Methods to obtain problem information
int getNumCols () const
 Get the number of columns (variables) More...
 
int getNumRows () const
 Get the number of rows (constraints) More...
 
int getNumElements () const
 Get the number of non-zero coefficients. More...
 
int getNumIntegers () const
 Get the number of integer variables. More...
 
const double * getColLower () const
 Get the column (variable) lower bound vector. More...
 
const double * getColUpper () const
 Get the column (variable) upper bound vector. More...
 
bool isContinuous (int colIndex) const
 Return true if the variable is continuous. More...
 
bool isBinary (int colIndex) const
 Return true if the variable is binary. More...
 
bool isIntegerNonBinary (int colIndex) const
 Return true if the variable is general integer. More...
 
bool isInteger (int colIndex) const
 Return true if the variable is integer (general or binary) More...
 
const char * getRowSense () const
 Get the row sense (constraint type) vector. More...
 
const double * getRightHandSide () const
 Get the row (constraint) right-hand-side vector. More...
 
const double * getRowRange () const
 Get the row (constraint) range vector. More...
 
const double * getRowLower () const
 Get the row (constraint) lower bound vector. More...
 
const double * getRowUpper () const
 Get the row (constraint) upper bound vector. More...
 
const double * getObjCoefficients () const
 Get the objective function coefficient vector. More...
 
double getObjSense () const
 Get the objective function sense (min/max) More...
 
const CoinPackedMatrix * getMatrixByRow () const
 Get a pointer to a row-major copy of the constraint matrix. More...
 
const CoinPackedMatrix * getMatrixByCol () const
 Get a pointer to a column-major copy of the constraint matrix. More...
 
Methods for row and column names.

Only the set methods need to be overridden to ensure consistent names between OsiDylp and the OSI base class.

void setObjName (std::string name)
 Set the objective function name. More...
 
void setRowName (int ndx, std::string name)
 Set a row name. More...
 
void setColName (int ndx, std::string name)
 Set a column name. More...
 
Methods to modify the problem
void setContinuous (int index)
 Set a single variable to be continuous. More...
 
void setInteger (int index)
 Set a single variable to be integer. More...
 
void setColLower (int index, double value)
 Set the lower bound on a column (variable) More...
 
void setColUpper (int index, double value)
 Set the upper bound on a column (variable) More...
 
void setRowLower (int index, double value)
 Set the lower bound on a row (constraint) More...
 
void setRowUpper (int index, double value)
 Set the upper bound on a row (constraint) More...
 
void setRowType (int index, char rowsen, double rowrhs, double rowrng)
 Set the type of a row (constraint) More...
 
void setObjCoeff (int index, double value)
 Set an objective function coefficient. More...
 
void setObjective (const double *array)
 Set the objective coefficients for all columns. More...
 
void setObjSense (double sense)
 Set the sense (min/max) of the objective. More...
 
void setColSolution (const double *colsol)
 Set the value of the primal variables in the problem solution. More...
 
void setRowPrice (const double *)
 Set the value of the dual variables in the problem solution. More...
 
void addCol (const CoinPackedVectorBase &vec, const double collb, const double colub, const double obj)
 Add a column (variable) to the problem. More...
 
void deleteCols (const int num, const int *colIndices)
 Remove column(s) (variable(s)) from the problem. More...
 
void addRow (const CoinPackedVectorBase &row, const double rowlb, const double rowub)
 Add a row (constraint) to the problem. More...
 
void addRow (const CoinPackedVectorBase &row, const char rowsen, const double rowrhs, const double rowrng)
 Add a row (constraint) to the problem. More...
 
void deleteRows (const int num, const int *rowIndices)
 Delete row(s) (constraint(s)) from the problem. More...
 
void applyRowCut (const OsiRowCut &cut)
 Apply a row (constraint) cut (add one constraint) More...
 
void applyColCut (const OsiColCut &cut)
 Apply a column (variable) cut (adjust one or more bounds) More...
 
Solve methods
void initialSolve ()
 Solve an lp from scratch. More...
 
CoinWarmStart * getEmptyWarmStart () const
 Get an empty OsiDylpWarmStartBasis object. More...
 
CoinWarmStart * getWarmStart () const
 Build a warm start object for the current lp solution. More...
 
bool setWarmStart (const CoinWarmStart *warmStart)
 Apply a warm start object. More...
 
void resolve ()
 Call dylp to reoptimize (warm start). More...
 
void markHotStart ()
 Create a hot start snapshot. More...
 
void solveFromHotStart ()
 Call dylp to reoptimize (hot start). More...
 
void unmarkHotStart ()
 Delete the hot start snapshot. More...
 
Methods returning solver termination status
bool isAbandoned () const
 True if dylp abandoned the problem. More...
 
bool isProvenOptimal () const
 True if dylp reported an optimal solution. More...
 
bool isProvenPrimalInfeasible () const
 True if dylp reported the problem to be primal infeasible. More...
 
bool isProvenDualInfeasible () const
 True if dylp reported the problem to be dual infeasible (primal unbounded) More...
 
bool isIterationLimitReached () const
 True if dylp reached the iteration limit. More...
 
int getIterationCount () const
 Get the number of iterations for the last lp. More...
 
bool isPrimalObjectiveLimitReached () const
 Is the primal objective limit reached? More...
 
bool isDualObjectiveLimitReached () const
 Is the dual objective limit reached? More...
 
Methods to set/get solver parameters
double getInfinity () const
 Get dylp's value for infinity. More...
 
bool setIntParam (OsiIntParam key, int value)
 Set an OSI integer parameter. More...
 
bool setDblParam (OsiDblParam key, double value)
 Set an OSI double parameter. More...
 
bool setStrParam (OsiStrParam key, const std::string &value)
 Set an OSI string parameter. More...
 
bool setHintParam (OsiHintParam key, bool sense=true, OsiHintStrength strength=OsiHintTry, void *info=0)
 Set an OSI hint. More...
 
bool getIntParam (OsiIntParam key, int &value) const
 Get an OSI integer parameter. More...
 
bool getDblParam (OsiDblParam key, double &value) const
 Get an OSI double parameter. More...
 
bool getStrParam (OsiStrParam key, std::string &value) const
 Get an OSI string parameter. More...
 
bool getHintParam (OsiHintParam key, bool &sense, OsiHintStrength &strength, void *&info) const
 Get an OSI hint. More...
 
void newLanguage (CoinMessages::Language language)
 Change the language for OsiDylp messages. More...
 
void setLanguage (CoinMessages::Language language)
 An alias for OsiDylpSolverInterface::newLanguage. More...
 
Methods to obtain solution information
double getObjValue () const
 Get the objective function value for the solution. More...
 
const double * getColSolution () const
 Return the vector of primal variables for the solution. More...
 
const double * getRowPrice () const
 Return the vector of dual variables for the solution. More...
 
const double * getReducedCost () const
 Return the vector of reduced costs for the solution. More...
 
const double * getRowActivity () const
 Return the vector of row activity for the solution. More...
 
std::vector< double * > getDualRays (int maxNumRays, bool fullRay) const
 Get as many dual rays as the solver can provide. More...
 
std::vector< double * > getPrimalRays (int maxNumRays) const
 Get as many primal rays as the solver can provide. More...
 
Simplex API methods
int canDoSimplexInterface () const
 Return the simplex implementation level. More...
 
void enableFactorization () const
 Prepare the solver for the use of tableau access methods. More...
 
void disableFactorization () const
 Undo the effects of enableFactorization. More...
 
bool basisIsAvailable () const
 Check if an optimal basis is available. More...
 
void getBasisStatus (int *archStatus, int *logStatus) const
 Retrieve status information for architectural and logical variables. More...
 
int setBasisStatus (const int *archStatus, const int *logStatus)
 Set a basis and update the factorization and solution. More...
 
virtual void getReducedGradient (double *columnReducedCosts, double *duals, const double *c) const
 Calculate duals and reduced costs for the given objective coefficients. More...
 
virtual void getBasics (int *index) const
 Get indices of basic variables. More...
 
virtual void getBInvCol (int col, double *betak) const
 Get a column of the basis inverse. More...
 
virtual void getBInvACol (int col, double *abarj) const
 Get a column of the tableau. More...
 
virtual void getBInvRow (int row, double *betai) const
 Get a row of the basis inverse. More...
 
virtual void getBInvARow (int row, double *abari, double *betai=0) const
 Get a row of the tableau. More...
 
Debugging Methods
void activateRowCutDebugger (const char *modelName)
 Activate the row cut debugger. More...
 
void activateRowCutDebugger (const double *solution, bool keepContinuous=false)
 Activate the row cut debugger. More...
 
Dylp-specific methods
void dylp_controlfile (const char *name, const bool silent, const bool mustexist=true)
 Process an options (.spc) file. More...
 
void dylp_logfile (const char *name, bool echo=false)
 Establish a log file. More...
 
void dylp_outfile (const char *name)
 Establish an output (solution and/or statistics) file. More...
 
void dylp_printsoln (bool wantSoln, bool wantStats)
 Print the solution and/or statistics to the output file. More...
 
void setOsiDylpMessages (CoinMessages::Language local_language)
 Set the language for messages. More...
 
Unsupported functions
void branchAndBound ()
 Invoke the solver's built-in branch-and-bound algorithm. More...
 

Friends

void OsiDylpSolverInterfaceUnitTest (const std::string &mpsDir, const std::string &netLibDir)
 Unit test for OsiDylpSolverInterface. More...
 

Dylp data structures

These fields hold pointers to the data structures which are used to pass an lp problem to dylp.

lpopts_structinitialSolveOptions
 Solver options for an initial solve. More...
 
lpopts_structresolveOptions
 Solver options for a resolve. More...
 
lptols_structtolerances
 Solver numeric tolerances. More...
 

Detailed Description

COIN OSI API for dylp.

The class OsiDylpSolverInterface (ODSI) implements the public functions defined for the COIN OsiSolverInterface (OSI) API.

OsiDylpSolverInterface Principles for Users

In addition to the principles outlined for the OsiSolverInterface class, ODSI maintains the following:

Construction of a Constraint System: A constraint system can be batch loaded from a file (MPS format) or from a data structure, or it can be built incrementally. When building a constraint system incrementally, keep in mind that you must create a row or column (addRow or addCol, respectively) before you can adjust other properties (row or column bounds, objective, variable values, etc.)

Existence of a Solution: For proper operation, OSI requires that a SI maintain a basic primal solution at all times after a problem has been loaded.

When a problem is loaded, ODSI generates a basic primal solution (primal variable values and a matching basis). The solution is not necessarily primal or dual feasible. In terms of the objective function, this solution is pessimistic, but not necessarily worst-case. ODSI does not generate matching values for the dual variables (row prices).

Any successful call to dylp (i.e., a call that results in an optimal, infeasible, or unbounded result, or that terminates on iteration limit) will replace the existing solution with the result of the call to dylp.

It is possible to specify initial values for the primal and dual variables using setColSolution() and setRowPrice(). To specify an initial basis, see the documentation for the CoinWarmStartBasis and OsiDylpWarmStartBasis classes. When these functions are used, it is the responsibility of the client to ensure validity and consistency.

Maintenance of an LP Basis Skirting the edges of the principle that changing the problem invalidates the solution, OsiDylp will maintain a valid basis across two common operations used in branch-and-cut: deletion of a loose constraint and deletion of a nonbasic variable. Arguably the set of allowable modifications could be increased.

Assignment Assignment (operator=()) works pretty much as you'd expect, with one exception. Only one ODSI object can control the dylp solver at a time, so hot start information is not copied on assignment.

Detailed implementation comments are contained in OsiDylpSolverInterface.cpp, which is not normally scanned when generating COIN OSI API documentation.

Definition at line 107 of file OsiDylpSolverInterface.hpp.

Constructor & Destructor Documentation

OsiDylpSolverInterface::OsiDylpSolverInterface ( )

Default constructor.

OsiDylpSolverInterface::OsiDylpSolverInterface ( const OsiDylpSolverInterface src)

Copy constructor.

OsiDylpSolverInterface::~OsiDylpSolverInterface ( )

Destructor.

Member Function Documentation

OsiSolverInterface* OsiDylpSolverInterface::clone ( bool  copyData = true) const

Clone the solver object.

OsiDylpSolverInterface& OsiDylpSolverInterface::operator= ( const OsiDylpSolverInterface rhs)

Assignment.

void OsiDylpSolverInterface::reset ( )

Reset the solver object to the state produced by the default constructor.

int OsiDylpSolverInterface::readMps ( const char *  filename,
const char *  extension = "mps" 
)

Read a problem description in MPS format from a file.

int OsiDylpSolverInterface::readMps ( const char *  filename,
const char *  extension,
int &  numberSets,
CoinSet **&  sets 
)

Read a problem description in MPS format from a file, including SOS information.

void OsiDylpSolverInterface::writeMps ( const char *  basename,
const char *  extension = "mps",
double  objsense = 0.0 
) const

Write the problem into the specified file in MPS format.

objsense == 1 forces the file to be written as a maximisation problem, while -1 forces a minimisation problem. The default of 0 writes the file as maximisation or minimisation using the solver's current setting.

void OsiDylpSolverInterface::loadProblem ( const CoinPackedMatrix &  matrix,
const double *  collb,
const double *  colub,
const double *  obj,
const char *  rowsen,
const double *  rowrhs,
const double *  rowrng 
)

Load a problem description (OSI packed matrix, row sense, parameters unaffected).

void OsiDylpSolverInterface::loadProblem ( const CoinPackedMatrix &  matrix,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  rowlb,
const double *  rowub 
)

Load a problem description (OSI packed matrix, row bounds, parameters unaffected).

void OsiDylpSolverInterface::loadProblem ( const int  colcnt,
const int  rowcnt,
const int *  start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const char *  sense,
const double *  rhsin,
const double *  range 
)

Load a problem description (standard column-major packed matrix, row sense, parameters unaffected)

void OsiDylpSolverInterface::loadProblem ( const int  colcnt,
const int  rowcnt,
const int *  start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  row_lower,
const double *  row_upper 
)

Load a problem description (standard column-major packed matrix, row bounds, parameters unaffected)

void OsiDylpSolverInterface::assignProblem ( CoinPackedMatrix *&  matrix,
double *&  collb,
double *&  colub,
double *&  obj,
char *&  rowsen,
double *&  rowrhs,
double *&  rowrng 
)

Load a problem description (OSI packed matrix, row sense, parameters destroyed).

void OsiDylpSolverInterface::assignProblem ( CoinPackedMatrix *&  matrix,
double *&  collb,
double *&  colub,
double *&  obj,
double *&  rowlb,
double *&  rowub 
)

Load a problem description (OSI packed matrix, row bounds, parameters destroyed).

int OsiDylpSolverInterface::getNumCols ( ) const

Get the number of columns (variables)

int OsiDylpSolverInterface::getNumRows ( ) const

Get the number of rows (constraints)

int OsiDylpSolverInterface::getNumElements ( ) const

Get the number of non-zero coefficients.

int OsiDylpSolverInterface::getNumIntegers ( ) const

Get the number of integer variables.

Counts both binary and general integer variables.

const double* OsiDylpSolverInterface::getColLower ( ) const

Get the column (variable) lower bound vector.

const double* OsiDylpSolverInterface::getColUpper ( ) const

Get the column (variable) upper bound vector.

bool OsiDylpSolverInterface::isContinuous ( int  colIndex) const

Return true if the variable is continuous.

bool OsiDylpSolverInterface::isBinary ( int  colIndex) const

Return true if the variable is binary.

bool OsiDylpSolverInterface::isIntegerNonBinary ( int  colIndex) const

Return true if the variable is general integer.

bool OsiDylpSolverInterface::isInteger ( int  colIndex) const

Return true if the variable is integer (general or binary)

const char* OsiDylpSolverInterface::getRowSense ( ) const

Get the row sense (constraint type) vector.

const double* OsiDylpSolverInterface::getRightHandSide ( ) const

Get the row (constraint) right-hand-side vector.

const double* OsiDylpSolverInterface::getRowRange ( ) const

Get the row (constraint) range vector.

const double* OsiDylpSolverInterface::getRowLower ( ) const

Get the row (constraint) lower bound vector.

const double* OsiDylpSolverInterface::getRowUpper ( ) const

Get the row (constraint) upper bound vector.

const double* OsiDylpSolverInterface::getObjCoefficients ( ) const

Get the objective function coefficient vector.

double OsiDylpSolverInterface::getObjSense ( ) const

Get the objective function sense (min/max)

A value of 1 indicates minimisation; -1 indicates maximisation.

const CoinPackedMatrix* OsiDylpSolverInterface::getMatrixByRow ( ) const

Get a pointer to a row-major copy of the constraint matrix.

const CoinPackedMatrix* OsiDylpSolverInterface::getMatrixByCol ( ) const

Get a pointer to a column-major copy of the constraint matrix.

void OsiDylpSolverInterface::setObjName ( std::string  name)

Set the objective function name.

void OsiDylpSolverInterface::setRowName ( int  ndx,
std::string  name 
)

Set a row name.

Quietly does nothing if the name discipline (#OsiNameDiscipline) is auto. Quietly fails if the row index is invalid.

void OsiDylpSolverInterface::setColName ( int  ndx,
std::string  name 
)

Set a column name.

Quietly does nothing if the name discipline (#OsiNameDiscipline) is auto. Quietly fails if the column index is invalid.

void OsiDylpSolverInterface::setContinuous ( int  index)

Set a single variable to be continuous.

void OsiDylpSolverInterface::setInteger ( int  index)

Set a single variable to be integer.

void OsiDylpSolverInterface::setColLower ( int  index,
double  value 
)

Set the lower bound on a column (variable)

void OsiDylpSolverInterface::setColUpper ( int  index,
double  value 
)

Set the upper bound on a column (variable)

void OsiDylpSolverInterface::setRowLower ( int  index,
double  value 
)

Set the lower bound on a row (constraint)

void OsiDylpSolverInterface::setRowUpper ( int  index,
double  value 
)

Set the upper bound on a row (constraint)

void OsiDylpSolverInterface::setRowType ( int  index,
char  rowsen,
double  rowrhs,
double  rowrng 
)

Set the type of a row (constraint)

void OsiDylpSolverInterface::setObjCoeff ( int  index,
double  value 
)

Set an objective function coefficient.

void OsiDylpSolverInterface::setObjective ( const double *  array)

Set the objective coefficients for all columns.

void OsiDylpSolverInterface::setObjSense ( double  sense)

Set the sense (min/max) of the objective.

Use 1 for minimisation, -1 for maximisation. (The default is minimisation; the objective is multiplied by -1 to maximise.)

void OsiDylpSolverInterface::setColSolution ( const double *  colsol)

Set the value of the primal variables in the problem solution.

void OsiDylpSolverInterface::setRowPrice ( const double *  )

Set the value of the dual variables in the problem solution.

void OsiDylpSolverInterface::addCol ( const CoinPackedVectorBase &  vec,
const double  collb,
const double  colub,
const double  obj 
)

Add a column (variable) to the problem.

void OsiDylpSolverInterface::deleteCols ( const int  num,
const int *  colIndices 
)

Remove column(s) (variable(s)) from the problem.

void OsiDylpSolverInterface::addRow ( const CoinPackedVectorBase &  row,
const double  rowlb,
const double  rowub 
)

Add a row (constraint) to the problem.

void OsiDylpSolverInterface::addRow ( const CoinPackedVectorBase &  row,
const char  rowsen,
const double  rowrhs,
const double  rowrng 
)

Add a row (constraint) to the problem.

void OsiDylpSolverInterface::deleteRows ( const int  num,
const int *  rowIndices 
)

Delete row(s) (constraint(s)) from the problem.

void OsiDylpSolverInterface::applyRowCut ( const OsiRowCut &  cut)

Apply a row (constraint) cut (add one constraint)

void OsiDylpSolverInterface::applyColCut ( const OsiColCut &  cut)

Apply a column (variable) cut (adjust one or more bounds)

void OsiDylpSolverInterface::initialSolve ( )

Solve an lp from scratch.

CoinWarmStart* OsiDylpSolverInterface::getEmptyWarmStart ( ) const

Get an empty OsiDylpWarmStartBasis object.

CoinWarmStart* OsiDylpSolverInterface::getWarmStart ( ) const

Build a warm start object for the current lp solution.

bool OsiDylpSolverInterface::setWarmStart ( const CoinWarmStart *  warmStart)

Apply a warm start object.

By definition, a null parameter is a request to synch the warm start basis with the solver. ODSI interprets a 0x0 basis as a request to remove warm start information.

void OsiDylpSolverInterface::resolve ( )

Call dylp to reoptimize (warm start).

void OsiDylpSolverInterface::markHotStart ( )

Create a hot start snapshot.

void OsiDylpSolverInterface::solveFromHotStart ( )

Call dylp to reoptimize (hot start).

void OsiDylpSolverInterface::unmarkHotStart ( )

Delete the hot start snapshot.

bool OsiDylpSolverInterface::isAbandoned ( ) const

True if dylp abandoned the problem.

bool OsiDylpSolverInterface::isProvenOptimal ( ) const

True if dylp reported an optimal solution.

bool OsiDylpSolverInterface::isProvenPrimalInfeasible ( ) const

True if dylp reported the problem to be primal infeasible.

bool OsiDylpSolverInterface::isProvenDualInfeasible ( ) const

True if dylp reported the problem to be dual infeasible (primal unbounded)

bool OsiDylpSolverInterface::isIterationLimitReached ( ) const

True if dylp reached the iteration limit.

int OsiDylpSolverInterface::getIterationCount ( ) const

Get the number of iterations for the last lp.

bool OsiDylpSolverInterface::isPrimalObjectiveLimitReached ( ) const

Is the primal objective limit reached?

Put in different terms, quit when the objective value becomes better than the given limit for an acceptable value.

bool OsiDylpSolverInterface::isDualObjectiveLimitReached ( ) const

Is the dual objective limit reached?

Put in different terms, quit when the objective value becomes worse than the given limit for an acceptable value.

double OsiDylpSolverInterface::getInfinity ( ) const

Get dylp's value for infinity.

bool OsiDylpSolverInterface::setIntParam ( OsiIntParam  key,
int  value 
)

Set an OSI integer parameter.

bool OsiDylpSolverInterface::setDblParam ( OsiDblParam  key,
double  value 
)

Set an OSI double parameter.

bool OsiDylpSolverInterface::setStrParam ( OsiStrParam  key,
const std::string &  value 
)

Set an OSI string parameter.

bool OsiDylpSolverInterface::setHintParam ( OsiHintParam  key,
bool  sense = true,
OsiHintStrength  strength = OsiHintTry,
void *  info = 0 
)

Set an OSI hint.

bool OsiDylpSolverInterface::getIntParam ( OsiIntParam  key,
int &  value 
) const

Get an OSI integer parameter.

bool OsiDylpSolverInterface::getDblParam ( OsiDblParam  key,
double &  value 
) const

Get an OSI double parameter.

bool OsiDylpSolverInterface::getStrParam ( OsiStrParam  key,
std::string &  value 
) const

Get an OSI string parameter.

bool OsiDylpSolverInterface::getHintParam ( OsiHintParam  key,
bool sense,
OsiHintStrength &  strength,
void *&  info 
) const

Get an OSI hint.

void OsiDylpSolverInterface::newLanguage ( CoinMessages::Language  language)
inline

Change the language for OsiDylp messages.

Definition at line 569 of file OsiDylpSolverInterface.hpp.

void OsiDylpSolverInterface::setLanguage ( CoinMessages::Language  language)
inline

An alias for OsiDylpSolverInterface::newLanguage.

Definition at line 574 of file OsiDylpSolverInterface.hpp.

double OsiDylpSolverInterface::getObjValue ( ) const

Get the objective function value for the solution.

const double* OsiDylpSolverInterface::getColSolution ( ) const

Return the vector of primal variables for the solution.

const double* OsiDylpSolverInterface::getRowPrice ( ) const

Return the vector of dual variables for the solution.

const double* OsiDylpSolverInterface::getReducedCost ( ) const

Return the vector of reduced costs for the solution.

const double* OsiDylpSolverInterface::getRowActivity ( ) const

Return the vector of row activity for the solution.

std::vector<double *> OsiDylpSolverInterface::getDualRays ( int  maxNumRays,
bool  fullRay 
) const

Get as many dual rays as the solver can provide.

If fullRay is false (the default), the ray will contain only the components associated with the row duals. If fullRay is set to true, the ray will also contain the components associated with nonbasic variables.

std::vector<double *> OsiDylpSolverInterface::getPrimalRays ( int  maxNumRays) const

Get as many primal rays as the solver can provide.

int OsiDylpSolverInterface::canDoSimplexInterface ( ) const

Return the simplex implementation level.

void OsiDylpSolverInterface::enableFactorization ( ) const

Prepare the solver for the use of tableau access methods.

In order for the tableau methods to work, the ODSI object invoking them must own the solver; the most recent call to optimise the problem must have resulted in an optimal solution; and the solver must be holding retained data structures for that optimal solution. It's much more efficient if the solver is using the full system, but it's not mandatory.

Because this is a const method, we can't force any of this; we can only check.

void OsiDylpSolverInterface::disableFactorization ( ) const

Undo the effects of enableFactorization.

Even if resolve was invoked by enableFactorization, little needs to be done here. Ownership of the solver is transferred by invocation, so there's no need to explicitly give it back.

bool OsiDylpSolverInterface::basisIsAvailable ( ) const

Check if an optimal basis is available.

void OsiDylpSolverInterface::getBasisStatus ( int *  archStatus,
int *  logStatus 
) const

Retrieve status information for architectural and logical variables.

Retrieve status vectors for architectural (also called structural or column) and logical (also called artificial or row) variables. Returns the same information as getWarmStart, but in a different format.

int OsiDylpSolverInterface::setBasisStatus ( const int *  archStatus,
const int *  logStatus 
)

Set a basis and update the factorization and solution.

Provides the combined functionality of setWarmStart followed by resolve. As with getBasisStatus, the status vectors are coded as integers.

virtual void OsiDylpSolverInterface::getReducedGradient ( double *  columnReducedCosts,
double *  duals,
const double *  c 
) const
virtual

Calculate duals and reduced costs for the given objective coefficients.

The solver's objective coefficient vector is not changed (cf. #setObjectiveAndRefresh)

virtual void OsiDylpSolverInterface::getBasics ( int *  index) const
virtual

Get indices of basic variables.

virtual void OsiDylpSolverInterface::getBInvCol ( int  col,
double *  betak 
) const
virtual

Get a column of the basis inverse.

virtual void OsiDylpSolverInterface::getBInvACol ( int  col,
double *  abarj 
) const
virtual

Get a column of the tableau.

virtual void OsiDylpSolverInterface::getBInvRow ( int  row,
double *  betai 
) const
virtual

Get a row of the basis inverse.

virtual void OsiDylpSolverInterface::getBInvARow ( int  row,
double *  abari,
double *  betai = 0 
) const
virtual

Get a row of the tableau.

void OsiDylpSolverInterface::activateRowCutDebugger ( const char *  modelName)

Activate the row cut debugger.

Activate the debugger for a model known to the debugger. The debugger will consult an internal database for an optimal solution vector.

void OsiDylpSolverInterface::activateRowCutDebugger ( const double *  solution,
bool  keepContinuous = false 
)

Activate the row cut debugger.

Activate the debugger for a model not included in the debugger's internal database. solution must be a full solution vector, but only the integer variables need to be correct. The debugger will fill in the continuous variables by solving an lp relaxation with the integer variables fixed as specified. If the given values for the continuous variables should be preserved, set keepContinuous to true.

void OsiDylpSolverInterface::dylp_controlfile ( const char *  name,
const bool  silent,
const bool  mustexist = true 
)

Process an options (.spc) file.

void OsiDylpSolverInterface::dylp_logfile ( const char *  name,
bool  echo = false 
)

Establish a log file.

void OsiDylpSolverInterface::dylp_outfile ( const char *  name)

Establish an output (solution and/or statistics) file.

void OsiDylpSolverInterface::dylp_printsoln ( bool  wantSoln,
bool  wantStats 
)

Print the solution and/or statistics to the output file.

void OsiDylpSolverInterface::setOsiDylpMessages ( CoinMessages::Language  local_language)

Set the language for messages.

void OsiDylpSolverInterface::branchAndBound ( )

Invoke the solver's built-in branch-and-bound algorithm.

Friends And Related Function Documentation

void OsiDylpSolverInterfaceUnitTest ( const std::string &  mpsDir,
const std::string &  netLibDir 
)
friend

Unit test for OsiDylpSolverInterface.

Performs various tests to see if ODSI is functioning correctly. Not an exhaustive test, but it'll (usually) catch gross problems.

Member Data Documentation

lpopts_struct* OsiDylpSolverInterface::initialSolveOptions

Solver options for an initial solve.

Definition at line 778 of file OsiDylpSolverInterface.hpp.

lpopts_struct* OsiDylpSolverInterface::resolveOptions

Solver options for a resolve.

Definition at line 781 of file OsiDylpSolverInterface.hpp.

lptols_struct* OsiDylpSolverInterface::tolerances

Solver numeric tolerances.

Definition at line 784 of file OsiDylpSolverInterface.hpp.

CoinWarmStart* OsiDylpSolverInterface::basis

Definition at line 939 of file OsiDylpSolverInterface.hpp.

basisCondition OsiDylpSolverInterface::condition

Definition at line 940 of file OsiDylpSolverInterface.hpp.

int OsiDylpSolverInterface::balance

Definition at line 941 of file OsiDylpSolverInterface.hpp.

int OsiDylpSolverInterface::simplex

Definition at line 957 of file OsiDylpSolverInterface.hpp.

bool OsiDylpSolverInterface::saved_fullsys

Definition at line 958 of file OsiDylpSolverInterface.hpp.


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