Dip  0.92.4
Protected Attributes | List of all members
OsiNullSolverInterface Class Reference

#include <OsiNullSolverInterface.hpp>

+ Inheritance diagram for OsiNullSolverInterface:

Public Member Functions

Solve methods
virtual void initialSolve ()
 Solve initial LP relaxation. More...
 
virtual void resolve ()
 Resolve an LP relaxation after problem modification. More...
 
virtual void branchAndBound ()
 Invoke solver's built-in enumeration algorithm. More...
 
void copyParameters (OsiNullSolverInterface &rhs)
 
virtual void initialSolve ()
 Solve initial LP relaxation. More...
 
virtual void resolve ()
 Resolve an LP relaxation after problem modification. More...
 
virtual void branchAndBound ()
 Invoke solver's built-in enumeration algorithm. More...
 
void copyParameters (OsiNullSolverInterface &rhs)
 
Methods returning info on how the solution process terminated
virtual bool isAbandoned () const
 Are there numerical difficulties? More...
 
virtual bool isProvenOptimal () const
 Is optimality proven? More...
 
virtual bool isProvenPrimalInfeasible () const
 Is primal infeasiblity proven? More...
 
virtual bool isProvenDualInfeasible () const
 Is dual infeasiblity proven? More...
 
virtual bool isPrimalObjectiveLimitReached () const
 Is the given primal objective limit reached? More...
 
virtual bool isDualObjectiveLimitReached () const
 Is the given dual objective limit reached? More...
 
virtual bool isIterationLimitReached () const
 Iteration limit reached? More...
 
virtual bool isAbandoned () const
 Are there numerical difficulties? More...
 
virtual bool isProvenOptimal () const
 Is optimality proven? More...
 
virtual bool isProvenPrimalInfeasible () const
 Is primal infeasiblity proven? More...
 
virtual bool isProvenDualInfeasible () const
 Is dual infeasiblity proven? More...
 
virtual bool isPrimalObjectiveLimitReached () const
 Is the given primal objective limit reached? More...
 
virtual bool isDualObjectiveLimitReached () const
 Is the given dual objective limit reached? More...
 
virtual bool isIterationLimitReached () const
 Iteration limit reached? More...
 
Warm start methods

Note that the warm start methods return a generic CoinWarmStart object.

The precise characteristics of this object are solver-dependent. Clients who wish to maintain a maximum degree of solver independence should take care to avoid unnecessary assumptions about the properties of a warm start object.

virtual CoinWarmStart * getEmptyWarmStart () const
 Get an empty warm start object. More...
 
virtual CoinWarmStart * getWarmStart () const
 Get warm start information. More...
 
virtual bool setWarmStart (const CoinWarmStart *warmstart)
 Set warm start information. More...
 
virtual CoinWarmStart * getEmptyWarmStart () const
 Get an empty warm start object. More...
 
virtual CoinWarmStart * getWarmStart () const
 Get warm start information. More...
 
virtual bool setWarmStart (const CoinWarmStart *warmstart)
 Set warm start information. More...
 
Problem query methods

Querying a problem that has no data associated with it will result in zeros for the number of rows and columns, and NULL pointers from the methods that return vectors.

Const pointers returned from any data-query method are valid as long as the data is unchanged and the solver is not called.

virtual int getNumCols () const
 Get number of columns. More...
 
virtual int getNumRows () const
 Get number of rows. More...
 
virtual int getNumElements () const
 Get number of nonzero elements. More...
 
virtual int getNumIntegers () const
 Get number of integer variables. More...
 
virtual const double * getColLower () const
 Get pointer to array[getNumCols()] of column lower bounds. More...
 
virtual const double * getColUpper () const
 Get pointer to array[getNumCols()] of column upper bounds. More...
 
virtual const char * getRowSense () const
 Get pointer to array[getNumRows()] of row constraint senses. More...
 
virtual const double * getRightHandSide () const
 
virtual const double * getRowRange () const
 
virtual const double * getRowLower () const
 Get pointer to array[getNumRows()] of row lower bounds. More...
 
virtual const double * getRowUpper () const
 Get pointer to array[getNumRows()] of row upper bounds. More...
 
virtual const double * getObjCoefficients () const
 Get pointer to array[getNumCols()] of objective function coefficients. More...
 
virtual double getObjSense () const
 Get objective function sense (1 for min (default), -1 for max) More...
 
virtual bool isContinuous (int colIndex) const
 Return true if variable is continuous. More...
 
virtual bool isBinary (int colIndex) const
 Return true if variable is binary. More...
 
virtual bool isInteger (int colIndex) const
 Return true if column is integer. More...
 
virtual const CoinPackedMatrix * getMatrixByRow () const
 Get pointer to row-wise copy of matrix. More...
 
virtual const CoinPackedMatrix * getMatrixByCol () const
 Get pointer to column-wise copy of matrix. More...
 
virtual double getInfinity () const
 Get solver's value for infinity. More...
 
virtual int getNumCols () const
 Get number of columns. More...
 
virtual int getNumRows () const
 Get number of rows. More...
 
virtual int getNumElements () const
 Get number of nonzero elements. More...
 
virtual int getNumIntegers () const
 Get number of integer variables. More...
 
virtual const double * getColLower () const
 Get pointer to array[getNumCols()] of column lower bounds. More...
 
virtual const double * getColUpper () const
 Get pointer to array[getNumCols()] of column upper bounds. More...
 
virtual const char * getRowSense () const
 Get pointer to array[getNumRows()] of row constraint senses. More...
 
virtual const double * getRightHandSide () const
 
virtual const double * getRowRange () const
 
virtual const double * getRowLower () const
 Get pointer to array[getNumRows()] of row lower bounds. More...
 
virtual const double * getRowUpper () const
 Get pointer to array[getNumRows()] of row upper bounds. More...
 
virtual const double * getObjCoefficients () const
 Get pointer to array[getNumCols()] of objective function coefficients. More...
 
virtual double getObjSense () const
 Get objective function sense (1 for min (default), -1 for max) More...
 
virtual bool isContinuous (int colIndex) const
 Return true if variable is continuous. More...
 
virtual bool isBinary (int colIndex) const
 Return true if variable is binary. More...
 
virtual bool isInteger (int colIndex) const
 Return true if column is integer. More...
 
virtual const CoinPackedMatrix * getMatrixByRow () const
 Get pointer to row-wise copy of matrix. More...
 
virtual const CoinPackedMatrix * getMatrixByCol () const
 Get pointer to column-wise copy of matrix. More...
 
virtual double getInfinity () const
 Get solver's value for infinity. More...
 
Solution query methods
virtual const double * getColSolution () const
 Get pointer to array[getNumCols()] of primal variable values. More...
 
virtual const double * getRowPrice () const
 Get pointer to array[getNumRows()] of dual variable values. More...
 
virtual const double * getReducedCost () const
 Get a pointer to array[getNumCols()] of reduced costs. More...
 
virtual const double * getRowActivity () const
 Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector). More...
 
virtual double getObjValue () const
 Get objective function value. More...
 
virtual int getIterationCount () const
 Get the number of iterations it took to solve the problem (whatever `‘iteration’' means to the solver). More...
 
virtual std::vector< double * > getDualRays (int maxNumRays) const
 Get as many dual rays as the solver can provide. More...
 
virtual std::vector< double * > getPrimalRays (int maxNumRays) const
 
virtual const double * getColSolution () const
 Get pointer to array[getNumCols()] of primal variable values. More...
 
virtual const double * getRowPrice () const
 Get pointer to array[getNumRows()] of dual variable values. More...
 
virtual const double * getReducedCost () const
 Get a pointer to array[getNumCols()] of reduced costs. More...
 
virtual const double * getRowActivity () const
 Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector). More...
 
virtual double getObjValue () const
 Get objective function value. More...
 
virtual int getIterationCount () const
 Get the number of iterations it took to solve the problem (whatever `‘iteration’' means to the solver). More...
 
virtual std::vector< double * > getDualRays (int maxNumRays) const
 Get as many dual rays as the solver can provide. More...
 
virtual std::vector< double * > getPrimalRays (int maxNumRays) const
 
Methods to modify the objective, bounds, and solution

For functions which take a set of indices as parameters (setObjCoeffSet(), setColSetBounds(), setRowSetBounds(), setRowSetTypes()), the parameters follow the C++ STL iterator convention: indexFirst points to the first index in the set, and indexLast points to a position one past the last index in the set.

virtual void setObjCoeff (int elementIndex, double elementValue)
 Set an objective function coefficient. More...
 
virtual void setColLower (int elementIndex, double elementValue)
 Set a single column lower bound. More...
 
virtual void setColUpper (int elementIndex, double elementValue)
 Set a single column upper bound. More...
 
virtual void setRowLower (int elementIndex, double elementValue)
 Set a single row lower bound. More...
 
virtual void setRowUpper (int elementIndex, double elementValue)
 Set a single row upper bound. More...
 
virtual void setRowType (int index, char sense, double rightHandSide, double range)
 Set the type of a single row. More...
 
virtual void setObjSense (double s)
 Set the objective function sense. More...
 
virtual void setColType (const char *colType)
 Set characters for columns types. More...
 
virtual void setColSolution (const double *colsol)
 
virtual void setRowPrice (const double *rowprice)
 Set dual solution variable values. More...
 
virtual void setObjCoeff (int elementIndex, double elementValue)
 Set an objective function coefficient. More...
 
virtual void setColLower (int elementIndex, double elementValue)
 Set a single column lower bound. More...
 
virtual void setColUpper (int elementIndex, double elementValue)
 Set a single column upper bound. More...
 
virtual void setRowLower (int elementIndex, double elementValue)
 Set a single row lower bound. More...
 
virtual void setRowUpper (int elementIndex, double elementValue)
 Set a single row upper bound. More...
 
virtual void setRowType (int index, char sense, double rightHandSide, double range)
 Set the type of a single row. More...
 
virtual void setObjSense (double s)
 Set the objective function sense. More...
 
virtual void setColType (const char *colType)
 Set characters for columns types. More...
 
virtual void setColSolution (const double *colsol)
 
virtual void setRowPrice (const double *rowprice)
 Set dual solution variable values. More...
 
Methods to set variable type
virtual void setContinuous (int index)
 Set the index-th variable to be a continuous variable. More...
 
virtual void setInteger (int index)
 Set the index-th variable to be an integer variable. More...
 
virtual void setContinuous (int index)
 Set the index-th variable to be a continuous variable. More...
 
virtual void setInteger (int index)
 Set the index-th variable to be an integer variable. More...
 
Methods to modify the constraint system.

Set the variables listed in indices (which is of length len) to be continuous variables

Note that new columns are added as continuous variables.

virtual void addCol (const CoinPackedVectorBase &vec, const double collb, const double colub, const double obj)
 Add a column (primal variable) to the problem. More...
 
virtual void deleteCols (const int num, const int *colIndices)
 Remove a set of columns (primal variables) from the problem. More...
 
virtual void addRow (const CoinPackedVectorBase &vec, const double rowlb, const double rowub)
 Add a row (constraint) to the problem. More...
 
virtual void addRow (const CoinPackedVectorBase &vec, const char rowsen, const double rowrhs, const double rowrng)
 
virtual void deleteRows (const int num, const int *rowIndices)
 Delete a set of rows (constraints) from the problem. More...
 
virtual void addCol (const CoinPackedVectorBase &vec, const double collb, const double colub, const double obj)
 Add a column (primal variable) to the problem. More...
 
virtual void deleteCols (const int num, const int *colIndices)
 Remove a set of columns (primal variables) from the problem. More...
 
virtual void addRow (const CoinPackedVectorBase &vec, const double rowlb, const double rowub)
 Add a row (constraint) to the problem. More...
 
virtual void addRow (const CoinPackedVectorBase &vec, const char rowsen, const double rowrhs, const double rowrng)
 
virtual void deleteRows (const int num, const int *rowIndices)
 Delete a set of rows (constraints) from the problem. More...
 
Methods to input a problem
void loadDataAndSolution (const CoinPackedMatrix &rowMatrix, const CoinPackedMatrix &colMatrix, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub, const char *colType, const double *primalSol, const double infinity)
 
virtual void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub)
 Load in an problem by copying the arguments (the constraints on the rows are given by lower and upper bounds). More...
 
virtual void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, double *&rowlb, double *&rowub)
 Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by lower and upper bounds). More...
 
virtual void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const char *rowsen, const double *rowrhs, const double *rowrng)
 Load in an problem by copying the arguments (the constraints on the rows are given by sense/rhs/range triplets). More...
 
virtual void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, char *&rowsen, double *&rowrhs, double *&rowrng)
 Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by sense/rhs/range triplets). More...
 
virtual void loadProblem (const int numcols, const int numrows, const CoinBigIndex *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub)
 Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps). More...
 
virtual void loadProblem (const int numcols, const int numrows, const CoinBigIndex *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const char *rowsen, const double *rowrhs, const double *rowrng)
 Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps). More...
 
virtual void writeMps (const char *filename, const char *extension="mps", double objSense=0.0) const
 Write the problem in MPS format to the specified file. More...
 
void loadDataAndSolution (const CoinPackedMatrix &rowMatrix, const CoinPackedMatrix &colMatrix, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub, const char *colType, const double *primalSol, const double infinity)
 
virtual void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub)
 Load in an problem by copying the arguments (the constraints on the rows are given by lower and upper bounds). More...
 
virtual void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, double *&rowlb, double *&rowub)
 Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by lower and upper bounds). More...
 
virtual void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const char *rowsen, const double *rowrhs, const double *rowrng)
 Load in an problem by copying the arguments (the constraints on the rows are given by sense/rhs/range triplets). More...
 
virtual void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, char *&rowsen, double *&rowrhs, double *&rowrng)
 Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by sense/rhs/range triplets). More...
 
virtual void loadProblem (const int numcols, const int numrows, const CoinBigIndex *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub)
 Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps). More...
 
virtual void loadProblem (const int numcols, const int numrows, const CoinBigIndex *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const char *rowsen, const double *rowrhs, const double *rowrng)
 Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps). More...
 
virtual void writeMps (const char *filename, const char *extension="mps", double objSense=0.0) const
 Write the problem in MPS format to the specified file. More...
 
Constructors and destructors
 OsiNullSolverInterface ()
 Default Constructor. More...
 
virtual OsiNullSolverInterfaceclone (bool copyData=true) const
 Clone. More...
 
 OsiNullSolverInterface (const OsiNullSolverInterface &)
 Copy constructor (disabled) More...
 
OsiNullSolverInterfaceoperator= (const OsiNullSolverInterface &rhs)
 Assignment operator (disabled) More...
 
virtual ~OsiNullSolverInterface ()
 Destructor. More...
 
 OsiNullSolverInterface ()
 Default Constructor. More...
 
virtual OsiNullSolverInterfaceclone (bool copyData=true) const
 Clone. More...
 
 OsiNullSolverInterface (const OsiNullSolverInterface &)
 Copy constructor (disabled) More...
 
OsiNullSolverInterfaceoperator= (const OsiNullSolverInterface &rhs)
 Assignment operator (disabled) More...
 
virtual ~OsiNullSolverInterface ()
 Destructor. More...
 

Protected Member Functions

Protected methods
virtual void applyRowCut (const OsiRowCut &rc)
 Apply a row cut (append to the constraint matrix). More...
 
virtual void applyColCut (const OsiColCut &cc)
 Apply a column cut (adjust the bounds of one or more variables). More...
 
template<class T >
forceIntoRange (const T value, const T lower, const T upper) const
 A quick inlined function to force a value to be between a minimum and a maximum value. More...
 
virtual void applyRowCut (const OsiRowCut &rc)
 Apply a row cut (append to the constraint matrix). More...
 
virtual void applyColCut (const OsiColCut &cc)
 Apply a column cut (adjust the bounds of one or more variables). More...
 
template<class T >
forceIntoRange (const T value, const T lower, const T upper) const
 A quick inlined function to force a value to be between a minimum and a maximum value. More...
 

Protected Attributes

OsiDatadata_
 

Detailed Description

Definition at line 38 of file OsiNullSolverInterface.hpp.

Constructor & Destructor Documentation

◆ OsiNullSolverInterface() [1/4]

OsiNullSolverInterface::OsiNullSolverInterface ( )
inline

Default Constructor.

Definition at line 676 of file OsiNullSolverInterface.hpp.

◆ OsiNullSolverInterface() [2/4]

OsiNullSolverInterface::OsiNullSolverInterface ( const OsiNullSolverInterface )

Copy constructor (disabled)

◆ ~OsiNullSolverInterface() [1/2]

virtual OsiNullSolverInterface::~OsiNullSolverInterface ( )
inlinevirtual

Destructor.

Definition at line 700 of file OsiNullSolverInterface.hpp.

◆ OsiNullSolverInterface() [3/4]

OsiNullSolverInterface::OsiNullSolverInterface ( )
inline

Default Constructor.

Definition at line 676 of file OsiNullSolverInterface2.hpp.

◆ OsiNullSolverInterface() [4/4]

OsiNullSolverInterface::OsiNullSolverInterface ( const OsiNullSolverInterface )

Copy constructor (disabled)

◆ ~OsiNullSolverInterface() [2/2]

virtual OsiNullSolverInterface::~OsiNullSolverInterface ( )
inlinevirtual

Destructor.

Definition at line 700 of file OsiNullSolverInterface2.hpp.

Member Function Documentation

◆ initialSolve() [1/2]

virtual void OsiNullSolverInterface::initialSolve ( )
inlinevirtual

Solve initial LP relaxation.

Definition at line 44 of file OsiNullSolverInterface.hpp.

◆ resolve() [1/2]

virtual void OsiNullSolverInterface::resolve ( )
inlinevirtual

Resolve an LP relaxation after problem modification.

Definition at line 49 of file OsiNullSolverInterface.hpp.

◆ branchAndBound() [1/2]

virtual void OsiNullSolverInterface::branchAndBound ( )
inlinevirtual

Invoke solver's built-in enumeration algorithm.

Definition at line 54 of file OsiNullSolverInterface.hpp.

◆ copyParameters() [1/2]

void OsiNullSolverInterface::copyParameters ( OsiNullSolverInterface rhs)

◆ isAbandoned() [1/2]

virtual bool OsiNullSolverInterface::isAbandoned ( ) const
inlinevirtual

Are there numerical difficulties?

Definition at line 67 of file OsiNullSolverInterface.hpp.

◆ isProvenOptimal() [1/2]

virtual bool OsiNullSolverInterface::isProvenOptimal ( ) const
inlinevirtual

Is optimality proven?

Definition at line 72 of file OsiNullSolverInterface.hpp.

◆ isProvenPrimalInfeasible() [1/2]

virtual bool OsiNullSolverInterface::isProvenPrimalInfeasible ( ) const
inlinevirtual

Is primal infeasiblity proven?

Definition at line 77 of file OsiNullSolverInterface.hpp.

◆ isProvenDualInfeasible() [1/2]

virtual bool OsiNullSolverInterface::isProvenDualInfeasible ( ) const
inlinevirtual

Is dual infeasiblity proven?

Definition at line 82 of file OsiNullSolverInterface.hpp.

◆ isPrimalObjectiveLimitReached() [1/2]

virtual bool OsiNullSolverInterface::isPrimalObjectiveLimitReached ( ) const
inlinevirtual

Is the given primal objective limit reached?

Definition at line 87 of file OsiNullSolverInterface.hpp.

◆ isDualObjectiveLimitReached() [1/2]

virtual bool OsiNullSolverInterface::isDualObjectiveLimitReached ( ) const
inlinevirtual

Is the given dual objective limit reached?

Definition at line 92 of file OsiNullSolverInterface.hpp.

◆ isIterationLimitReached() [1/2]

virtual bool OsiNullSolverInterface::isIterationLimitReached ( ) const
inlinevirtual

Iteration limit reached?

Definition at line 97 of file OsiNullSolverInterface.hpp.

◆ getEmptyWarmStart() [1/2]

virtual CoinWarmStart* OsiNullSolverInterface::getEmptyWarmStart ( ) const
inlinevirtual

Get an empty warm start object.

This routine returns an empty warm start object. Its purpose is to provide a way for a client to acquire a warm start object of the appropriate type for the solver, which can then be resized and modified as desired.

Definition at line 121 of file OsiNullSolverInterface.hpp.

◆ getWarmStart() [1/2]

virtual CoinWarmStart* OsiNullSolverInterface::getWarmStart ( ) const
inlinevirtual

Get warm start information.

Return warm start information for the current state of the solver interface. If there is no valid warm start information, an empty warm start object wil be returned.

Definition at line 132 of file OsiNullSolverInterface.hpp.

◆ setWarmStart() [1/2]

virtual bool OsiNullSolverInterface::setWarmStart ( const CoinWarmStart *  warmstart)
inlinevirtual

Set warm start information.

Return true or false depending on whether the warm start information was accepted or not. By definition, a call to setWarmStart with an empty warm start object should remove the warm start information held in the solver interface.

Definition at line 144 of file OsiNullSolverInterface.hpp.

◆ getNumCols() [1/2]

virtual int OsiNullSolverInterface::getNumCols ( ) const
inlinevirtual

Get number of columns.

Definition at line 162 of file OsiNullSolverInterface.hpp.

◆ getNumRows() [1/2]

virtual int OsiNullSolverInterface::getNumRows ( ) const
inlinevirtual

Get number of rows.

Definition at line 167 of file OsiNullSolverInterface.hpp.

◆ getNumElements() [1/2]

virtual int OsiNullSolverInterface::getNumElements ( ) const
inlinevirtual

Get number of nonzero elements.

Definition at line 172 of file OsiNullSolverInterface.hpp.

◆ getNumIntegers() [1/2]

virtual int OsiNullSolverInterface::getNumIntegers ( ) const
inlinevirtual

Get number of integer variables.

Definition at line 184 of file OsiNullSolverInterface.hpp.

◆ getColLower() [1/2]

virtual const double* OsiNullSolverInterface::getColLower ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of column lower bounds.

Definition at line 195 of file OsiNullSolverInterface.hpp.

◆ getColUpper() [1/2]

virtual const double* OsiNullSolverInterface::getColUpper ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of column upper bounds.

Definition at line 200 of file OsiNullSolverInterface.hpp.

◆ getRowSense() [1/2]

virtual const char* OsiNullSolverInterface::getRowSense ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row constraint senses.

  • 'L': <= constraint
  • 'E': = constraint
  • 'G': >= constraint
  • 'R': ranged constraint
  • 'N': free constraint

Get pointer to array[getNumRows()] of row right-hand sides

Definition at line 213 of file OsiNullSolverInterface.hpp.

◆ getRightHandSide() [1/2]

virtual const double* OsiNullSolverInterface::getRightHandSide ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row ranges.

Definition at line 230 of file OsiNullSolverInterface.hpp.

◆ getRowRange() [1/2]

virtual const double* OsiNullSolverInterface::getRowRange ( ) const
inlinevirtual

Definition at line 243 of file OsiNullSolverInterface.hpp.

◆ getRowLower() [1/2]

virtual const double* OsiNullSolverInterface::getRowLower ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row lower bounds.

Definition at line 248 of file OsiNullSolverInterface.hpp.

◆ getRowUpper() [1/2]

virtual const double* OsiNullSolverInterface::getRowUpper ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row upper bounds.

Definition at line 253 of file OsiNullSolverInterface.hpp.

◆ getObjCoefficients() [1/2]

virtual const double* OsiNullSolverInterface::getObjCoefficients ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of objective function coefficients.

Definition at line 258 of file OsiNullSolverInterface.hpp.

◆ getObjSense() [1/2]

virtual double OsiNullSolverInterface::getObjSense ( ) const
inlinevirtual

Get objective function sense (1 for min (default), -1 for max)

Definition at line 263 of file OsiNullSolverInterface.hpp.

◆ isContinuous() [1/2]

virtual bool OsiNullSolverInterface::isContinuous ( int  colIndex) const
inlinevirtual

Return true if variable is continuous.

Definition at line 269 of file OsiNullSolverInterface.hpp.

◆ isBinary() [1/2]

virtual bool OsiNullSolverInterface::isBinary ( int  colIndex) const
inlinevirtual

Return true if variable is binary.

Definition at line 274 of file OsiNullSolverInterface.hpp.

◆ isInteger() [1/2]

virtual bool OsiNullSolverInterface::isInteger ( int  colIndex) const
inlinevirtual

Return true if column is integer.

Note: This function returns true if the the column is binary or a general integer.

Definition at line 282 of file OsiNullSolverInterface.hpp.

◆ getMatrixByRow() [1/2]

virtual const CoinPackedMatrix* OsiNullSolverInterface::getMatrixByRow ( ) const
inlinevirtual

Get pointer to row-wise copy of matrix.

Definition at line 288 of file OsiNullSolverInterface.hpp.

◆ getMatrixByCol() [1/2]

virtual const CoinPackedMatrix* OsiNullSolverInterface::getMatrixByCol ( ) const
inlinevirtual

Get pointer to column-wise copy of matrix.

Definition at line 293 of file OsiNullSolverInterface.hpp.

◆ getInfinity() [1/2]

virtual double OsiNullSolverInterface::getInfinity ( ) const
inlinevirtual

Get solver's value for infinity.

Definition at line 297 of file OsiNullSolverInterface.hpp.

◆ getColSolution() [1/2]

virtual const double* OsiNullSolverInterface::getColSolution ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of primal variable values.

Definition at line 305 of file OsiNullSolverInterface.hpp.

◆ getRowPrice() [1/2]

virtual const double* OsiNullSolverInterface::getRowPrice ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of dual variable values.

Definition at line 311 of file OsiNullSolverInterface.hpp.

◆ getReducedCost() [1/2]

virtual const double* OsiNullSolverInterface::getReducedCost ( ) const
inlinevirtual

Get a pointer to array[getNumCols()] of reduced costs.

Definition at line 317 of file OsiNullSolverInterface.hpp.

◆ getRowActivity() [1/2]

virtual const double* OsiNullSolverInterface::getRowActivity ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector).

Definition at line 324 of file OsiNullSolverInterface.hpp.

◆ getObjValue() [1/2]

virtual double OsiNullSolverInterface::getObjValue ( ) const
inlinevirtual

Get objective function value.

Definition at line 329 of file OsiNullSolverInterface.hpp.

◆ getIterationCount() [1/2]

virtual int OsiNullSolverInterface::getIterationCount ( ) const
inlinevirtual

Get the number of iterations it took to solve the problem (whatever `‘iteration’' means to the solver).

Definition at line 336 of file OsiNullSolverInterface.hpp.

◆ getDualRays() [1/2]

virtual std::vector<double*> OsiNullSolverInterface::getDualRays ( int  maxNumRays) const
inlinevirtual

Get as many dual rays as the solver can provide.

In case of proven primal infeasibility there should be at least one.

Note
Implementors of solver interfaces note that the double pointers in the vector should point to arrays of length getNumRows() and they should be allocated via new[].
Clients of solver interfaces note that it is the client's responsibility to free the double pointers in the vector using delete[].

Get as many primal rays as the solver can provide. (In case of proven dual infeasibility there should be at least one.)

NOTE for implementers of solver interfaces:
The double pointers in the vector should point to arrays of length getNumCols() and they should be allocated via new[].

NOTE for users of solver interfaces:
It is the user's responsibility to free the double pointers in the vector using delete[].

Definition at line 353 of file OsiNullSolverInterface.hpp.

◆ getPrimalRays() [1/2]

virtual std::vector<double*> OsiNullSolverInterface::getPrimalRays ( int  maxNumRays) const
inlinevirtual

Definition at line 368 of file OsiNullSolverInterface.hpp.

◆ setObjCoeff() [1/2]

virtual void OsiNullSolverInterface::setObjCoeff ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set an objective function coefficient.

Definition at line 385 of file OsiNullSolverInterface.hpp.

◆ setColLower() [1/2]

virtual void OsiNullSolverInterface::setColLower ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single column lower bound.

Use -getInfinity() for -infinity.

Definition at line 391 of file OsiNullSolverInterface.hpp.

◆ setColUpper() [1/2]

virtual void OsiNullSolverInterface::setColUpper ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single column upper bound.

Use getInfinity() for infinity.

Definition at line 397 of file OsiNullSolverInterface.hpp.

◆ setRowLower() [1/2]

virtual void OsiNullSolverInterface::setRowLower ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single row lower bound.

Use -getInfinity() for -infinity.

Definition at line 403 of file OsiNullSolverInterface.hpp.

◆ setRowUpper() [1/2]

virtual void OsiNullSolverInterface::setRowUpper ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single row upper bound.

Use getInfinity() for infinity.

Definition at line 409 of file OsiNullSolverInterface.hpp.

◆ setRowType() [1/2]

virtual void OsiNullSolverInterface::setRowType ( int  index,
char  sense,
double  rightHandSide,
double  range 
)
inlinevirtual

Set the type of a single row.

Definition at line 414 of file OsiNullSolverInterface.hpp.

◆ setObjSense() [1/2]

virtual void OsiNullSolverInterface::setObjSense ( double  s)
inlinevirtual

Set the objective function sense.

(1 for min (default), -1 for max)

Definition at line 421 of file OsiNullSolverInterface.hpp.

◆ setColType() [1/2]

virtual void OsiNullSolverInterface::setColType ( const char *  colType)
inlinevirtual

Set characters for columns types.

colType[i] can have values

  • 'C' : continuous
  • 'B' : binary
  • 'I' : integer

Definition at line 433 of file OsiNullSolverInterface.hpp.

◆ setColSolution() [1/2]

virtual void OsiNullSolverInterface::setColSolution ( const double *  colsol)
inlinevirtual

Definition at line 447 of file OsiNullSolverInterface.hpp.

◆ setRowPrice() [1/2]

virtual void OsiNullSolverInterface::setRowPrice ( const double *  rowprice)
inlinevirtual

Set dual solution variable values.

rowprice[getNumRows()] is an array of values for the dual variables. These values are copied to memory owned by the solver interface object or the solver. They will be returned as the result of getRowPrice() until changed by another call to setRowPrice() or by a call to any solver routine. Whether the solver makes use of the solution in any way is solver-dependent.

Definition at line 462 of file OsiNullSolverInterface.hpp.

◆ setContinuous() [1/2]

virtual void OsiNullSolverInterface::setContinuous ( int  index)
inlinevirtual

Set the index-th variable to be a continuous variable.

Definition at line 470 of file OsiNullSolverInterface.hpp.

◆ setInteger() [1/2]

virtual void OsiNullSolverInterface::setInteger ( int  index)
inlinevirtual

Set the index-th variable to be an integer variable.

Definition at line 475 of file OsiNullSolverInterface.hpp.

◆ addCol() [1/2]

virtual void OsiNullSolverInterface::addCol ( const CoinPackedVectorBase &  vec,
const double  collb,
const double  colub,
const double  obj 
)
inlinevirtual

Add a column (primal variable) to the problem.

Definition at line 492 of file OsiNullSolverInterface.hpp.

◆ deleteCols() [1/2]

virtual void OsiNullSolverInterface::deleteCols ( const int  num,
const int *  colIndices 
)
inlinevirtual

Remove a set of columns (primal variables) from the problem.

The solver interface for a basis-oriented solver will maintain valid warm start information if all deleted variables are nonbasic.

Definition at line 504 of file OsiNullSolverInterface.hpp.

◆ addRow() [1/4]

virtual void OsiNullSolverInterface::addRow ( const CoinPackedVectorBase &  vec,
const double  rowlb,
const double  rowub 
)
inlinevirtual

Add a row (constraint) to the problem.

Definition at line 509 of file OsiNullSolverInterface.hpp.

◆ addRow() [2/4]

virtual void OsiNullSolverInterface::addRow ( const CoinPackedVectorBase &  vec,
const char  rowsen,
const double  rowrhs,
const double  rowrng 
)
inlinevirtual

Definition at line 515 of file OsiNullSolverInterface.hpp.

◆ deleteRows() [1/2]

virtual void OsiNullSolverInterface::deleteRows ( const int  num,
const int *  rowIndices 
)
inlinevirtual

Delete a set of rows (constraints) from the problem.

The solver interface for a basis-oriented solver will maintain valid warm start information if all deleted rows are loose.

Definition at line 526 of file OsiNullSolverInterface.hpp.

◆ loadDataAndSolution() [1/2]

void OsiNullSolverInterface::loadDataAndSolution ( const CoinPackedMatrix &  rowMatrix,
const CoinPackedMatrix &  colMatrix,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  rowlb,
const double *  rowub,
const char *  colType,
const double *  primalSol,
const double  infinity 
)
inline

Definition at line 535 of file OsiNullSolverInterface.hpp.

◆ loadProblem() [1/8]

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

Load in an problem by copying the arguments (the constraints on the rows are given by lower and upper bounds).

If a pointer is 0 then the following values are the default:

  • colub: all columns have upper bound infinity
  • collb: all columns have lower bound 0
  • rowub: all rows have upper bound infinity
  • rowlb: all rows have lower bound -infinity
  • obj: all variables have 0 objective coefficient

Definition at line 574 of file OsiNullSolverInterface.hpp.

◆ assignProblem() [1/4]

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

Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by lower and upper bounds).

For default values see the previous method.

Warning
The arguments passed to this method will be freed using the C++ delete and delete[] functions.

Definition at line 594 of file OsiNullSolverInterface.hpp.

◆ loadProblem() [2/8]

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

Load in an problem by copying the arguments (the constraints on the rows are given by sense/rhs/range triplets).

If a pointer is 0 then the following values are the default:

  • colub: all columns have upper bound infinity
  • collb: all columns have lower bound 0
  • obj: all variables have 0 objective coefficient
  • rowsen: all rows are >=
  • rowrhs: all right hand sides are 0
  • rowrng: 0 for the ranged rows

Definition at line 612 of file OsiNullSolverInterface.hpp.

◆ assignProblem() [2/4]

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

Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by sense/rhs/range triplets).

For default values see the previous method.

Warning
The arguments passed to this method will be freed using the C++ delete and delete[] functions.

Definition at line 629 of file OsiNullSolverInterface.hpp.

◆ loadProblem() [3/8]

virtual void OsiNullSolverInterface::loadProblem ( const int  numcols,
const int  numrows,
const CoinBigIndex *  start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  rowlb,
const double *  rowub 
)
inlinevirtual

Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).

Definition at line 638 of file OsiNullSolverInterface.hpp.

◆ loadProblem() [4/8]

virtual void OsiNullSolverInterface::loadProblem ( const int  numcols,
const int  numrows,
const CoinBigIndex *  start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const char *  rowsen,
const double *  rowrhs,
const double *  rowrng 
)
inlinevirtual

Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).

Definition at line 649 of file OsiNullSolverInterface.hpp.

◆ writeMps() [1/2]

virtual void OsiNullSolverInterface::writeMps ( const char *  filename,
const char *  extension = "mps",
double  objSense = 0.0 
) const
inlinevirtual

Write the problem in MPS format to the specified file.

If objSense is non-zero, a value of -1.0 causes the problem to be written with a maximization objective; +1.0 forces a minimization objective. If objSense is zero, the choice is left to implementation.

Definition at line 665 of file OsiNullSolverInterface.hpp.

◆ clone() [1/2]

virtual OsiNullSolverInterface* OsiNullSolverInterface::clone ( bool  copyData = true) const
inlinevirtual

Clone.

The result of calling clone(false) is defined to be equivalent to calling the default constructor OsiNullSolverInterface().

Definition at line 688 of file OsiNullSolverInterface.hpp.

◆ operator=() [1/2]

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

Assignment operator (disabled)

◆ applyRowCut() [1/2]

virtual void OsiNullSolverInterface::applyRowCut ( const OsiRowCut &  rc)
inlineprotectedvirtual

Apply a row cut (append to the constraint matrix).

Definition at line 712 of file OsiNullSolverInterface.hpp.

◆ applyColCut() [1/2]

virtual void OsiNullSolverInterface::applyColCut ( const OsiColCut &  cc)
inlineprotectedvirtual

Apply a column cut (adjust the bounds of one or more variables).

Definition at line 717 of file OsiNullSolverInterface.hpp.

◆ forceIntoRange() [1/2]

template<class T >
T OsiNullSolverInterface::forceIntoRange ( const T  value,
const T  lower,
const T  upper 
) const
inlineprotected

A quick inlined function to force a value to be between a minimum and a maximum value.

Definition at line 723 of file OsiNullSolverInterface.hpp.

◆ initialSolve() [2/2]

virtual void OsiNullSolverInterface::initialSolve ( )
inlinevirtual

Solve initial LP relaxation.

Definition at line 44 of file OsiNullSolverInterface2.hpp.

◆ resolve() [2/2]

virtual void OsiNullSolverInterface::resolve ( )
inlinevirtual

Resolve an LP relaxation after problem modification.

Definition at line 49 of file OsiNullSolverInterface2.hpp.

◆ branchAndBound() [2/2]

virtual void OsiNullSolverInterface::branchAndBound ( )
inlinevirtual

Invoke solver's built-in enumeration algorithm.

Definition at line 54 of file OsiNullSolverInterface2.hpp.

◆ copyParameters() [2/2]

void OsiNullSolverInterface::copyParameters ( OsiNullSolverInterface rhs)

◆ isAbandoned() [2/2]

virtual bool OsiNullSolverInterface::isAbandoned ( ) const
inlinevirtual

Are there numerical difficulties?

Definition at line 67 of file OsiNullSolverInterface2.hpp.

◆ isProvenOptimal() [2/2]

virtual bool OsiNullSolverInterface::isProvenOptimal ( ) const
inlinevirtual

Is optimality proven?

Definition at line 72 of file OsiNullSolverInterface2.hpp.

◆ isProvenPrimalInfeasible() [2/2]

virtual bool OsiNullSolverInterface::isProvenPrimalInfeasible ( ) const
inlinevirtual

Is primal infeasiblity proven?

Definition at line 77 of file OsiNullSolverInterface2.hpp.

◆ isProvenDualInfeasible() [2/2]

virtual bool OsiNullSolverInterface::isProvenDualInfeasible ( ) const
inlinevirtual

Is dual infeasiblity proven?

Definition at line 82 of file OsiNullSolverInterface2.hpp.

◆ isPrimalObjectiveLimitReached() [2/2]

virtual bool OsiNullSolverInterface::isPrimalObjectiveLimitReached ( ) const
inlinevirtual

Is the given primal objective limit reached?

Definition at line 87 of file OsiNullSolverInterface2.hpp.

◆ isDualObjectiveLimitReached() [2/2]

virtual bool OsiNullSolverInterface::isDualObjectiveLimitReached ( ) const
inlinevirtual

Is the given dual objective limit reached?

Definition at line 92 of file OsiNullSolverInterface2.hpp.

◆ isIterationLimitReached() [2/2]

virtual bool OsiNullSolverInterface::isIterationLimitReached ( ) const
inlinevirtual

Iteration limit reached?

Definition at line 97 of file OsiNullSolverInterface2.hpp.

◆ getEmptyWarmStart() [2/2]

virtual CoinWarmStart* OsiNullSolverInterface::getEmptyWarmStart ( ) const
inlinevirtual

Get an empty warm start object.

This routine returns an empty warm start object. Its purpose is to provide a way for a client to acquire a warm start object of the appropriate type for the solver, which can then be resized and modified as desired.

Definition at line 121 of file OsiNullSolverInterface2.hpp.

◆ getWarmStart() [2/2]

virtual CoinWarmStart* OsiNullSolverInterface::getWarmStart ( ) const
inlinevirtual

Get warm start information.

Return warm start information for the current state of the solver interface. If there is no valid warm start information, an empty warm start object wil be returned.

Definition at line 132 of file OsiNullSolverInterface2.hpp.

◆ setWarmStart() [2/2]

virtual bool OsiNullSolverInterface::setWarmStart ( const CoinWarmStart *  warmstart)
inlinevirtual

Set warm start information.

Return true or false depending on whether the warm start information was accepted or not. By definition, a call to setWarmStart with an empty warm start object should remove the warm start information held in the solver interface.

Definition at line 144 of file OsiNullSolverInterface2.hpp.

◆ getNumCols() [2/2]

virtual int OsiNullSolverInterface::getNumCols ( ) const
inlinevirtual

Get number of columns.

Definition at line 162 of file OsiNullSolverInterface2.hpp.

◆ getNumRows() [2/2]

virtual int OsiNullSolverInterface::getNumRows ( ) const
inlinevirtual

Get number of rows.

Definition at line 167 of file OsiNullSolverInterface2.hpp.

◆ getNumElements() [2/2]

virtual int OsiNullSolverInterface::getNumElements ( ) const
inlinevirtual

Get number of nonzero elements.

Definition at line 172 of file OsiNullSolverInterface2.hpp.

◆ getNumIntegers() [2/2]

virtual int OsiNullSolverInterface::getNumIntegers ( ) const
inlinevirtual

Get number of integer variables.

Definition at line 184 of file OsiNullSolverInterface2.hpp.

◆ getColLower() [2/2]

virtual const double* OsiNullSolverInterface::getColLower ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of column lower bounds.

Definition at line 195 of file OsiNullSolverInterface2.hpp.

◆ getColUpper() [2/2]

virtual const double* OsiNullSolverInterface::getColUpper ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of column upper bounds.

Definition at line 200 of file OsiNullSolverInterface2.hpp.

◆ getRowSense() [2/2]

virtual const char* OsiNullSolverInterface::getRowSense ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row constraint senses.

  • 'L': <= constraint
  • 'E': = constraint
  • 'G': >= constraint
  • 'R': ranged constraint
  • 'N': free constraint

Get pointer to array[getNumRows()] of row right-hand sides

Definition at line 213 of file OsiNullSolverInterface2.hpp.

◆ getRightHandSide() [2/2]

virtual const double* OsiNullSolverInterface::getRightHandSide ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row ranges.

Definition at line 230 of file OsiNullSolverInterface2.hpp.

◆ getRowRange() [2/2]

virtual const double* OsiNullSolverInterface::getRowRange ( ) const
inlinevirtual

Definition at line 243 of file OsiNullSolverInterface2.hpp.

◆ getRowLower() [2/2]

virtual const double* OsiNullSolverInterface::getRowLower ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row lower bounds.

Definition at line 248 of file OsiNullSolverInterface2.hpp.

◆ getRowUpper() [2/2]

virtual const double* OsiNullSolverInterface::getRowUpper ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row upper bounds.

Definition at line 253 of file OsiNullSolverInterface2.hpp.

◆ getObjCoefficients() [2/2]

virtual const double* OsiNullSolverInterface::getObjCoefficients ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of objective function coefficients.

Definition at line 258 of file OsiNullSolverInterface2.hpp.

◆ getObjSense() [2/2]

virtual double OsiNullSolverInterface::getObjSense ( ) const
inlinevirtual

Get objective function sense (1 for min (default), -1 for max)

Definition at line 263 of file OsiNullSolverInterface2.hpp.

◆ isContinuous() [2/2]

virtual bool OsiNullSolverInterface::isContinuous ( int  colIndex) const
inlinevirtual

Return true if variable is continuous.

Definition at line 269 of file OsiNullSolverInterface2.hpp.

◆ isBinary() [2/2]

virtual bool OsiNullSolverInterface::isBinary ( int  colIndex) const
inlinevirtual

Return true if variable is binary.

Definition at line 274 of file OsiNullSolverInterface2.hpp.

◆ isInteger() [2/2]

virtual bool OsiNullSolverInterface::isInteger ( int  colIndex) const
inlinevirtual

Return true if column is integer.

Note: This function returns true if the the column is binary or a general integer.

Definition at line 282 of file OsiNullSolverInterface2.hpp.

◆ getMatrixByRow() [2/2]

virtual const CoinPackedMatrix* OsiNullSolverInterface::getMatrixByRow ( ) const
inlinevirtual

Get pointer to row-wise copy of matrix.

Definition at line 288 of file OsiNullSolverInterface2.hpp.

◆ getMatrixByCol() [2/2]

virtual const CoinPackedMatrix* OsiNullSolverInterface::getMatrixByCol ( ) const
inlinevirtual

Get pointer to column-wise copy of matrix.

Definition at line 293 of file OsiNullSolverInterface2.hpp.

◆ getInfinity() [2/2]

virtual double OsiNullSolverInterface::getInfinity ( ) const
inlinevirtual

Get solver's value for infinity.

Definition at line 297 of file OsiNullSolverInterface2.hpp.

◆ getColSolution() [2/2]

virtual const double* OsiNullSolverInterface::getColSolution ( ) const
inlinevirtual

Get pointer to array[getNumCols()] of primal variable values.

Definition at line 305 of file OsiNullSolverInterface2.hpp.

◆ getRowPrice() [2/2]

virtual const double* OsiNullSolverInterface::getRowPrice ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of dual variable values.

Definition at line 311 of file OsiNullSolverInterface2.hpp.

◆ getReducedCost() [2/2]

virtual const double* OsiNullSolverInterface::getReducedCost ( ) const
inlinevirtual

Get a pointer to array[getNumCols()] of reduced costs.

Definition at line 317 of file OsiNullSolverInterface2.hpp.

◆ getRowActivity() [2/2]

virtual const double* OsiNullSolverInterface::getRowActivity ( ) const
inlinevirtual

Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector).

Definition at line 324 of file OsiNullSolverInterface2.hpp.

◆ getObjValue() [2/2]

virtual double OsiNullSolverInterface::getObjValue ( ) const
inlinevirtual

Get objective function value.

Definition at line 329 of file OsiNullSolverInterface2.hpp.

◆ getIterationCount() [2/2]

virtual int OsiNullSolverInterface::getIterationCount ( ) const
inlinevirtual

Get the number of iterations it took to solve the problem (whatever `‘iteration’' means to the solver).

Definition at line 336 of file OsiNullSolverInterface2.hpp.

◆ getDualRays() [2/2]

virtual std::vector<double*> OsiNullSolverInterface::getDualRays ( int  maxNumRays) const
inlinevirtual

Get as many dual rays as the solver can provide.

In case of proven primal infeasibility there should be at least one.

Note
Implementors of solver interfaces note that the double pointers in the vector should point to arrays of length getNumRows() and they should be allocated via new[].
Clients of solver interfaces note that it is the client's responsibility to free the double pointers in the vector using delete[].

Get as many primal rays as the solver can provide. (In case of proven dual infeasibility there should be at least one.)

NOTE for implementers of solver interfaces:
The double pointers in the vector should point to arrays of length getNumCols() and they should be allocated via new[].

NOTE for users of solver interfaces:
It is the user's responsibility to free the double pointers in the vector using delete[].

Definition at line 353 of file OsiNullSolverInterface2.hpp.

◆ getPrimalRays() [2/2]

virtual std::vector<double*> OsiNullSolverInterface::getPrimalRays ( int  maxNumRays) const
inlinevirtual

Definition at line 368 of file OsiNullSolverInterface2.hpp.

◆ setObjCoeff() [2/2]

virtual void OsiNullSolverInterface::setObjCoeff ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set an objective function coefficient.

Definition at line 385 of file OsiNullSolverInterface2.hpp.

◆ setColLower() [2/2]

virtual void OsiNullSolverInterface::setColLower ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single column lower bound.

Use -getInfinity() for -infinity.

Definition at line 391 of file OsiNullSolverInterface2.hpp.

◆ setColUpper() [2/2]

virtual void OsiNullSolverInterface::setColUpper ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single column upper bound.

Use getInfinity() for infinity.

Definition at line 397 of file OsiNullSolverInterface2.hpp.

◆ setRowLower() [2/2]

virtual void OsiNullSolverInterface::setRowLower ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single row lower bound.

Use -getInfinity() for -infinity.

Definition at line 403 of file OsiNullSolverInterface2.hpp.

◆ setRowUpper() [2/2]

virtual void OsiNullSolverInterface::setRowUpper ( int  elementIndex,
double  elementValue 
)
inlinevirtual

Set a single row upper bound.

Use getInfinity() for infinity.

Definition at line 409 of file OsiNullSolverInterface2.hpp.

◆ setRowType() [2/2]

virtual void OsiNullSolverInterface::setRowType ( int  index,
char  sense,
double  rightHandSide,
double  range 
)
inlinevirtual

Set the type of a single row.

Definition at line 414 of file OsiNullSolverInterface2.hpp.

◆ setObjSense() [2/2]

virtual void OsiNullSolverInterface::setObjSense ( double  s)
inlinevirtual

Set the objective function sense.

(1 for min (default), -1 for max)

Definition at line 421 of file OsiNullSolverInterface2.hpp.

◆ setColType() [2/2]

virtual void OsiNullSolverInterface::setColType ( const char *  colType)
inlinevirtual

Set characters for columns types.

colType[i] can have values

  • 'C' : continuous
  • 'B' : binary
  • 'I' : integer

Definition at line 433 of file OsiNullSolverInterface2.hpp.

◆ setColSolution() [2/2]

virtual void OsiNullSolverInterface::setColSolution ( const double *  colsol)
inlinevirtual

Definition at line 447 of file OsiNullSolverInterface2.hpp.

◆ setRowPrice() [2/2]

virtual void OsiNullSolverInterface::setRowPrice ( const double *  rowprice)
inlinevirtual

Set dual solution variable values.

rowprice[getNumRows()] is an array of values for the dual variables. These values are copied to memory owned by the solver interface object or the solver. They will be returned as the result of getRowPrice() until changed by another call to setRowPrice() or by a call to any solver routine. Whether the solver makes use of the solution in any way is solver-dependent.

Definition at line 462 of file OsiNullSolverInterface2.hpp.

◆ setContinuous() [2/2]

virtual void OsiNullSolverInterface::setContinuous ( int  index)
inlinevirtual

Set the index-th variable to be a continuous variable.

Definition at line 470 of file OsiNullSolverInterface2.hpp.

◆ setInteger() [2/2]

virtual void OsiNullSolverInterface::setInteger ( int  index)
inlinevirtual

Set the index-th variable to be an integer variable.

Definition at line 475 of file OsiNullSolverInterface2.hpp.

◆ addCol() [2/2]

virtual void OsiNullSolverInterface::addCol ( const CoinPackedVectorBase &  vec,
const double  collb,
const double  colub,
const double  obj 
)
inlinevirtual

Add a column (primal variable) to the problem.

Definition at line 492 of file OsiNullSolverInterface2.hpp.

◆ deleteCols() [2/2]

virtual void OsiNullSolverInterface::deleteCols ( const int  num,
const int *  colIndices 
)
inlinevirtual

Remove a set of columns (primal variables) from the problem.

The solver interface for a basis-oriented solver will maintain valid warm start information if all deleted variables are nonbasic.

Definition at line 504 of file OsiNullSolverInterface2.hpp.

◆ addRow() [3/4]

virtual void OsiNullSolverInterface::addRow ( const CoinPackedVectorBase &  vec,
const double  rowlb,
const double  rowub 
)
inlinevirtual

Add a row (constraint) to the problem.

Definition at line 509 of file OsiNullSolverInterface2.hpp.

◆ addRow() [4/4]

virtual void OsiNullSolverInterface::addRow ( const CoinPackedVectorBase &  vec,
const char  rowsen,
const double  rowrhs,
const double  rowrng 
)
inlinevirtual

Definition at line 515 of file OsiNullSolverInterface2.hpp.

◆ deleteRows() [2/2]

virtual void OsiNullSolverInterface::deleteRows ( const int  num,
const int *  rowIndices 
)
inlinevirtual

Delete a set of rows (constraints) from the problem.

The solver interface for a basis-oriented solver will maintain valid warm start information if all deleted rows are loose.

Definition at line 526 of file OsiNullSolverInterface2.hpp.

◆ loadDataAndSolution() [2/2]

void OsiNullSolverInterface::loadDataAndSolution ( const CoinPackedMatrix &  rowMatrix,
const CoinPackedMatrix &  colMatrix,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  rowlb,
const double *  rowub,
const char *  colType,
const double *  primalSol,
const double  infinity 
)
inline

Definition at line 535 of file OsiNullSolverInterface2.hpp.

◆ loadProblem() [5/8]

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

Load in an problem by copying the arguments (the constraints on the rows are given by lower and upper bounds).

If a pointer is 0 then the following values are the default:

  • colub: all columns have upper bound infinity
  • collb: all columns have lower bound 0
  • rowub: all rows have upper bound infinity
  • rowlb: all rows have lower bound -infinity
  • obj: all variables have 0 objective coefficient

Definition at line 574 of file OsiNullSolverInterface2.hpp.

◆ assignProblem() [3/4]

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

Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by lower and upper bounds).

For default values see the previous method.

Warning
The arguments passed to this method will be freed using the C++ delete and delete[] functions.

Definition at line 594 of file OsiNullSolverInterface2.hpp.

◆ loadProblem() [6/8]

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

Load in an problem by copying the arguments (the constraints on the rows are given by sense/rhs/range triplets).

If a pointer is 0 then the following values are the default:

  • colub: all columns have upper bound infinity
  • collb: all columns have lower bound 0
  • obj: all variables have 0 objective coefficient
  • rowsen: all rows are >=
  • rowrhs: all right hand sides are 0
  • rowrng: 0 for the ranged rows

Definition at line 612 of file OsiNullSolverInterface2.hpp.

◆ assignProblem() [4/4]

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

Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by sense/rhs/range triplets).

For default values see the previous method.

Warning
The arguments passed to this method will be freed using the C++ delete and delete[] functions.

Definition at line 629 of file OsiNullSolverInterface2.hpp.

◆ loadProblem() [7/8]

virtual void OsiNullSolverInterface::loadProblem ( const int  numcols,
const int  numrows,
const CoinBigIndex *  start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  rowlb,
const double *  rowub 
)
inlinevirtual

Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).

Definition at line 638 of file OsiNullSolverInterface2.hpp.

◆ loadProblem() [8/8]

virtual void OsiNullSolverInterface::loadProblem ( const int  numcols,
const int  numrows,
const CoinBigIndex *  start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const char *  rowsen,
const double *  rowrhs,
const double *  rowrng 
)
inlinevirtual

Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).

Definition at line 649 of file OsiNullSolverInterface2.hpp.

◆ writeMps() [2/2]

virtual void OsiNullSolverInterface::writeMps ( const char *  filename,
const char *  extension = "mps",
double  objSense = 0.0 
) const
inlinevirtual

Write the problem in MPS format to the specified file.

If objSense is non-zero, a value of -1.0 causes the problem to be written with a maximization objective; +1.0 forces a minimization objective. If objSense is zero, the choice is left to implementation.

Definition at line 665 of file OsiNullSolverInterface2.hpp.

◆ clone() [2/2]

virtual OsiNullSolverInterface* OsiNullSolverInterface::clone ( bool  copyData = true) const
inlinevirtual

Clone.

The result of calling clone(false) is defined to be equivalent to calling the default constructor OsiNullSolverInterface().

Definition at line 688 of file OsiNullSolverInterface2.hpp.

◆ operator=() [2/2]

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

Assignment operator (disabled)

◆ applyRowCut() [2/2]

virtual void OsiNullSolverInterface::applyRowCut ( const OsiRowCut &  rc)
inlineprotectedvirtual

Apply a row cut (append to the constraint matrix).

Definition at line 712 of file OsiNullSolverInterface2.hpp.

◆ applyColCut() [2/2]

virtual void OsiNullSolverInterface::applyColCut ( const OsiColCut &  cc)
inlineprotectedvirtual

Apply a column cut (adjust the bounds of one or more variables).

Definition at line 717 of file OsiNullSolverInterface2.hpp.

◆ forceIntoRange() [2/2]

template<class T >
T OsiNullSolverInterface::forceIntoRange ( const T  value,
const T  lower,
const T  upper 
) const
inlineprotected

A quick inlined function to force a value to be between a minimum and a maximum value.

Definition at line 723 of file OsiNullSolverInterface2.hpp.

Member Data Documentation

◆ data_

OsiData * OsiNullSolverInterface::data_
protected

Definition at line 730 of file OsiNullSolverInterface.hpp.


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