OR-Tools  9.6
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
MPSolverInterfaceabstract

Detailed Description

Definition at line 1572 of file linear_solver.h.

Public Types

enum  SynchronizationStatus { MUST_RELOAD , MODEL_SYNCHRONIZED , SOLUTION_SYNCHRONIZED }
 

Public Member Functions

 MPSolverInterface (MPSolver *const solver)
 
virtual ~MPSolverInterface ()
 
virtual MPSolver::ResultStatus Solve (const MPSolverParameters &param)=0
 
virtual std::optional< MPSolutionResponse > DirectlySolveProto (const MPModelRequest &request, std::atomic< bool > *interrupt)
 
virtual void Write (const std::string &filename)
 
virtual void Reset ()=0
 
virtual void SetOptimizationDirection (bool maximize)=0
 
virtual void SetVariableBounds (int index, double lb, double ub)=0
 
virtual void SetVariableInteger (int index, bool integer)=0
 
virtual void SetConstraintBounds (int index, double lb, double ub)=0
 
virtual void AddRowConstraint (MPConstraint *const ct)=0
 
virtual bool AddIndicatorConstraint (MPConstraint *const ct)
 
virtual void AddVariable (MPVariable *const var)=0
 
virtual void SetCoefficient (MPConstraint *const constraint, const MPVariable *const variable, double new_value, double old_value)=0
 
virtual void ClearConstraint (MPConstraint *const constraint)=0
 
virtual void SetObjectiveCoefficient (const MPVariable *const variable, double coefficient)=0
 
virtual void SetObjectiveOffset (double value)=0
 
virtual void ClearObjective ()=0
 
virtual void BranchingPriorityChangedForVariable (int var_index)
 
virtual int64_t iterations () const =0
 
virtual int64_t nodes () const =0
 
double best_objective_bound () const
 
double objective_value () const
 
virtual MPSolver::BasisStatus row_status (int constraint_index) const =0
 
virtual MPSolver::BasisStatus column_status (int variable_index) const =0
 
bool CheckSolutionIsSynchronized () const
 
virtual bool CheckSolutionExists () const
 
bool CheckSolutionIsSynchronizedAndExists () const
 
virtual bool IsContinuous () const =0
 
virtual bool IsLP () const =0
 
virtual bool IsMIP () const =0
 
int last_variable_index () const
 
bool variable_is_extracted (int var_index) const
 
void set_variable_as_extracted (int var_index, bool extracted)
 
bool constraint_is_extracted (int ct_index) const
 
void set_constraint_as_extracted (int ct_index, bool extracted)
 
bool quiet () const
 
void set_quiet (bool quiet_value)
 
MPSolver::ResultStatus result_status () const
 
virtual std::string SolverVersion () const =0
 
virtual void * underlying_solver ()=0
 
virtual double ComputeExactConditionNumber () const
 
virtual void SetStartingLpBasis (const std::vector< MPSolver::BasisStatus > &variable_statuses, const std::vector< MPSolver::BasisStatus > &constraint_statuses)
 
virtual bool InterruptSolve ()
 
virtual bool NextSolution ()
 
virtual void SetCallback (MPCallback *mp_callback)
 
virtual bool SupportsCallbacks () const
 

Static Public Attributes

static constexpr int64_t kUnknownNumberOfIterations = -1
 
static constexpr int64_t kUnknownNumberOfNodes = -1
 

Protected Member Functions

void ExtractModel ()
 
virtual void ExtractNewVariables ()=0
 
virtual void ExtractNewConstraints ()=0
 
virtual void ExtractObjective ()=0
 
void ResetExtractionInformation ()
 
void InvalidateSolutionSynchronization ()
 
void SetCommonParameters (const MPSolverParameters &param)
 
void SetMIPParameters (const MPSolverParameters &param)
 
virtual void SetParameters (const MPSolverParameters &param)=0
 
void SetUnsupportedDoubleParam (MPSolverParameters::DoubleParam param)
 
virtual void SetUnsupportedIntegerParam (MPSolverParameters::IntegerParam param)
 
void SetDoubleParamToUnsupportedValue (MPSolverParameters::DoubleParam param, double value)
 
virtual void SetIntegerParamToUnsupportedValue (MPSolverParameters::IntegerParam param, int value)
 
virtual void SetRelativeMipGap (double value)=0
 
virtual void SetPrimalTolerance (double value)=0
 
virtual void SetDualTolerance (double value)=0
 
virtual void SetPresolveMode (int value)=0
 
virtual absl::Status SetNumThreads (int num_threads)
 
virtual bool SetSolverSpecificParametersAsString (const std::string &parameters)
 
virtual void SetScalingMode (int value)=0
 
virtual void SetLpAlgorithm (int value)=0
 

Protected Attributes

MPSolver *const solver_
 
SynchronizationStatus sync_status_
 
MPSolver::ResultStatus result_status_
 
bool maximize_
 
int last_constraint_index_
 
int last_variable_index_
 
double objective_value_
 
double best_objective_bound_
 
bool quiet_
 

Static Protected Attributes

static const int kDummyVariableIndex = 0
 

Member Enumeration Documentation

◆ SynchronizationStatus

enum SynchronizationStatus
Enumerator
MUST_RELOAD 
MODEL_SYNCHRONIZED 
SOLUTION_SYNCHRONIZED 

Definition at line 1574 of file linear_solver.h.

Constructor & Destructor Documentation

◆ MPSolverInterface()

MPSolverInterface ( MPSolver *const  solver)
explicit

Definition at line 1831 of file linear_solver.cc.

◆ ~MPSolverInterface()

~MPSolverInterface ( )
virtual

Definition at line 1842 of file linear_solver.cc.

Member Function Documentation

◆ AddIndicatorConstraint()

virtual bool AddIndicatorConstraint ( MPConstraint *const  ct)
inlinevirtual

Reimplemented in SCIPInterface, SatInterface, and GurobiInterface.

Definition at line 1643 of file linear_solver.h.

◆ AddRowConstraint()

virtual void AddRowConstraint ( MPConstraint *const  ct)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ AddVariable()

virtual void AddVariable ( MPVariable *const  var)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ best_objective_bound()

double best_objective_bound ( ) const

Definition at line 1911 of file linear_solver.cc.

◆ BranchingPriorityChangedForVariable()

virtual void BranchingPriorityChangedForVariable ( int  var_index)
inlinevirtual

Reimplemented in SCIPInterface, and GurobiInterface.

Definition at line 1669 of file linear_solver.h.

◆ CheckSolutionExists()

bool CheckSolutionExists ( ) const
virtual

Definition at line 1896 of file linear_solver.cc.

◆ CheckSolutionIsSynchronized()

bool CheckSolutionIsSynchronized ( ) const

Definition at line 1884 of file linear_solver.cc.

◆ CheckSolutionIsSynchronizedAndExists()

bool CheckSolutionIsSynchronizedAndExists ( ) const
inline

Definition at line 1696 of file linear_solver.h.

◆ ClearConstraint()

virtual void ClearConstraint ( MPConstraint *const  constraint)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ ClearObjective()

virtual void ClearObjective ( )
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ column_status()

virtual MPSolver::BasisStatus column_status ( int  variable_index) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ ComputeExactConditionNumber()

double ComputeExactConditionNumber ( ) const
virtual

Reimplemented in GurobiInterface.

Definition at line 1935 of file linear_solver.cc.

◆ constraint_is_extracted()

bool constraint_is_extracted ( int  ct_index) const
inline

Definition at line 1722 of file linear_solver.h.

◆ DirectlySolveProto()

virtual std::optional<MPSolutionResponse> DirectlySolveProto ( const MPModelRequest &  request,
std::atomic< bool > *  interrupt 
)
inlinevirtual

Reimplemented in SCIPInterface, SatInterface, PdlpInterface, and GurobiInterface.

Definition at line 1610 of file linear_solver.h.

◆ ExtractModel()

void ExtractModel ( )
protected

Definition at line 1848 of file linear_solver.cc.

◆ ExtractNewConstraints()

virtual void ExtractNewConstraints ( )
protectedpure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ ExtractNewVariables()

virtual void ExtractNewVariables ( )
protectedpure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ ExtractObjective()

virtual void ExtractObjective ( )
protectedpure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ InterruptSolve()

virtual bool InterruptSolve ( )
inlinevirtual

Reimplemented in SCIPInterface, SatInterface, GurobiInterface, GLOPInterface, and BopInterface.

Definition at line 1757 of file linear_solver.h.

◆ InvalidateSolutionSynchronization()

void InvalidateSolutionSynchronization ( )
protected

Definition at line 1929 of file linear_solver.cc.

◆ IsContinuous()

virtual bool IsContinuous ( ) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ IsLP()

virtual bool IsLP ( ) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ IsMIP()

virtual bool IsMIP ( ) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ iterations()

virtual int64_t iterations ( ) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ last_variable_index()

int last_variable_index ( ) const
inline

Definition at line 1714 of file linear_solver.h.

◆ NextSolution()

virtual bool NextSolution ( )
inlinevirtual

Reimplemented in SCIPInterface, and GurobiInterface.

Definition at line 1760 of file linear_solver.h.

◆ nodes()

virtual int64_t nodes ( ) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ objective_value()

double objective_value ( ) const

Definition at line 1906 of file linear_solver.cc.

◆ quiet()

bool quiet ( ) const
inline

Definition at line 1730 of file linear_solver.h.

◆ Reset()

virtual void Reset ( )
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ ResetExtractionInformation()

void ResetExtractionInformation ( )
protected

Definition at line 1876 of file linear_solver.cc.

◆ result_status()

MPSolver::ResultStatus result_status ( ) const
inline

Definition at line 1735 of file linear_solver.h.

◆ row_status()

virtual MPSolver::BasisStatus row_status ( int  constraint_index) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ set_constraint_as_extracted()

void set_constraint_as_extracted ( int  ct_index,
bool  extracted 
)
inline

Definition at line 1725 of file linear_solver.h.

◆ set_quiet()

void set_quiet ( bool  quiet_value)
inline

Definition at line 1732 of file linear_solver.h.

◆ set_variable_as_extracted()

void set_variable_as_extracted ( int  var_index,
bool  extracted 
)
inline

Definition at line 1719 of file linear_solver.h.

◆ SetCallback()

virtual void SetCallback ( MPCallback *  mp_callback)
inlinevirtual

Reimplemented in SCIPInterface, and GurobiInterface.

Definition at line 1763 of file linear_solver.h.

◆ SetCoefficient()

virtual void SetCoefficient ( MPConstraint *const  constraint,
const MPVariable *const  variable,
double  new_value,
double  old_value 
)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ SetCommonParameters()

void SetCommonParameters ( const MPSolverParameters &  param)
protected

Definition at line 1944 of file linear_solver.cc.

◆ SetConstraintBounds()

virtual void SetConstraintBounds ( int  index,
double  lb,
double  ub 
)
pure virtual

Implemented in SCIPInterface, GurobiInterface, CLPInterface, CBCInterface, SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetDoubleParamToUnsupportedValue()

void SetDoubleParamToUnsupportedValue ( MPSolverParameters::DoubleParam  param,
double  value 
)
protected

Definition at line 1980 of file linear_solver.cc.

◆ SetDualTolerance()

virtual void SetDualTolerance ( double  value)
protectedpure virtual

Implemented in SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetIntegerParamToUnsupportedValue()

void SetIntegerParamToUnsupportedValue ( MPSolverParameters::IntegerParam  param,
int  value 
)
protectedvirtual

Definition at line 1985 of file linear_solver.cc.

◆ SetLpAlgorithm()

virtual void SetLpAlgorithm ( int  value)
protectedpure virtual

Implemented in SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetMIPParameters()

void SetMIPParameters ( const MPSolverParameters &  param)
protected

Definition at line 1965 of file linear_solver.cc.

◆ SetNumThreads()

absl::Status SetNumThreads ( int  num_threads)
protectedvirtual

Reimplemented in SatInterface, PdlpInterface, and CBCInterface.

Definition at line 1991 of file linear_solver.cc.

◆ SetObjectiveCoefficient()

virtual void SetObjectiveCoefficient ( const MPVariable *const  variable,
double  coefficient 
)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ SetObjectiveOffset()

virtual void SetObjectiveOffset ( double  value)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CBCInterface, BopInterface, and CLPInterface.

◆ SetOptimizationDirection()

virtual void SetOptimizationDirection ( bool  maximize)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ SetParameters()

virtual void SetParameters ( const MPSolverParameters &  param)
protectedpure virtual

Implemented in SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetPresolveMode()

virtual void SetPresolveMode ( int  value)
protectedpure virtual

Implemented in SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetPrimalTolerance()

virtual void SetPrimalTolerance ( double  value)
protectedpure virtual

Implemented in SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetRelativeMipGap()

virtual void SetRelativeMipGap ( double  value)
protectedpure virtual

Implemented in SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetScalingMode()

virtual void SetScalingMode ( int  value)
protectedpure virtual

Implemented in SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetSolverSpecificParametersAsString()

bool SetSolverSpecificParametersAsString ( const std::string &  parameters)
protectedvirtual

Reimplemented in SatInterface, PdlpInterface, GLOPInterface, and BopInterface.

Definition at line 1996 of file linear_solver.cc.

◆ SetStartingLpBasis()

virtual void SetStartingLpBasis ( const std::vector< MPSolver::BasisStatus > &  variable_statuses,
const std::vector< MPSolver::BasisStatus > &  constraint_statuses 
)
inlinevirtual

Reimplemented in GLOPInterface.

Definition at line 1751 of file linear_solver.h.

◆ SetUnsupportedDoubleParam()

void SetUnsupportedDoubleParam ( MPSolverParameters::DoubleParam  param)
protected

Definition at line 1972 of file linear_solver.cc.

◆ SetUnsupportedIntegerParam()

void SetUnsupportedIntegerParam ( MPSolverParameters::IntegerParam  param)
protectedvirtual

Definition at line 1976 of file linear_solver.cc.

◆ SetVariableBounds()

virtual void SetVariableBounds ( int  index,
double  lb,
double  ub 
)
pure virtual

Implemented in SCIPInterface, GurobiInterface, CLPInterface, CBCInterface, SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ SetVariableInteger()

virtual void SetVariableInteger ( int  index,
bool  integer 
)
pure virtual

Implemented in SCIPInterface, GurobiInterface, CLPInterface, CBCInterface, SatInterface, PdlpInterface, KnapsackInterface, GLOPInterface, and BopInterface.

◆ Solve()

virtual MPSolver::ResultStatus Solve ( const MPSolverParameters &  param)
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ SolverVersion()

virtual std::string SolverVersion ( ) const
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ SupportsCallbacks()

virtual bool SupportsCallbacks ( ) const
inlinevirtual

Reimplemented in SCIPInterface, and GurobiInterface.

Definition at line 1767 of file linear_solver.h.

◆ underlying_solver()

virtual void* underlying_solver ( )
pure virtual

Implemented in SCIPInterface, SatInterface, PdlpInterface, KnapsackInterface, GurobiInterface, GLOPInterface, CLPInterface, CBCInterface, and BopInterface.

◆ variable_is_extracted()

bool variable_is_extracted ( int  var_index) const
inline

Definition at line 1716 of file linear_solver.h.

◆ Write()

void Write ( const std::string &  filename)
virtual

Reimplemented in GurobiInterface.

Definition at line 1844 of file linear_solver.cc.

Member Data Documentation

◆ best_objective_bound_

double best_objective_bound_
protected

Definition at line 1794 of file linear_solver.h.

◆ kDummyVariableIndex

const int kDummyVariableIndex = 0
staticprotected

Definition at line 1801 of file linear_solver.h.

◆ kUnknownNumberOfIterations

constexpr int64_t kUnknownNumberOfIterations = -1
staticconstexpr

Definition at line 1589 of file linear_solver.h.

◆ kUnknownNumberOfNodes

constexpr int64_t kUnknownNumberOfNodes = -1
staticconstexpr

Definition at line 1592 of file linear_solver.h.

◆ last_constraint_index_

int last_constraint_index_
protected

Definition at line 1786 of file linear_solver.h.

◆ last_variable_index_

int last_variable_index_
protected

Definition at line 1788 of file linear_solver.h.

◆ maximize_

bool maximize_
protected

Definition at line 1783 of file linear_solver.h.

◆ objective_value_

double objective_value_
protected

Definition at line 1791 of file linear_solver.h.

◆ quiet_

bool quiet_
protected

Definition at line 1797 of file linear_solver.h.

◆ result_status_

MPSolver::ResultStatus result_status_
protected

Definition at line 1781 of file linear_solver.h.

◆ solver_

MPSolver* const solver_
protected

Definition at line 1776 of file linear_solver.h.

◆ sync_status_

SynchronizationStatus sync_status_
protected

Definition at line 1778 of file linear_solver.h.

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