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

Detailed Description

Definition at line 64 of file scip_interface.cc.

Public Types

enum  SynchronizationStatus { MUST_RELOAD , MODEL_SYNCHRONIZED , SOLUTION_SYNCHRONIZED }
 

Public Member Functions

 SCIPInterface (MPSolver *solver)
 
 ~SCIPInterface () override
 
void SetOptimizationDirection (bool maximize) override
 
MPSolver::ResultStatus Solve (const MPSolverParameters &param) override
 
std::optional< MPSolutionResponse > DirectlySolveProto (const MPModelRequest &request, std::atomic< bool > *interrupt) override
 
void Reset () override
 
void SetVariableBounds (int var_index, double lb, double ub) override
 
void SetVariableInteger (int var_index, bool integer) override
 
void SetConstraintBounds (int row_index, double lb, double ub) override
 
void AddRowConstraint (MPConstraint *ct) override
 
bool AddIndicatorConstraint (MPConstraint *ct) override
 
void AddVariable (MPVariable *var) override
 
void SetCoefficient (MPConstraint *constraint, const MPVariable *variable, double new_value, double old_value) override
 
void ClearConstraint (MPConstraint *constraint) override
 
void SetObjectiveCoefficient (const MPVariable *variable, double coefficient) override
 
void SetObjectiveOffset (double value) override
 
void ClearObjective () override
 
void BranchingPriorityChangedForVariable (int var_index) override
 
int64_t iterations () const override
 
int64_t nodes () const override
 
MPSolver::BasisStatus row_status (int constraint_index) const override
 
MPSolver::BasisStatus column_status (int variable_index) const override
 
bool IsContinuous () const override
 
bool IsLP () const override
 
bool IsMIP () const override
 
void ExtractNewVariables () override
 
void ExtractNewConstraints () override
 
void ExtractObjective () override
 
std::string SolverVersion () const override
 
bool InterruptSolve () override
 
void * underlying_solver () override
 
bool NextSolution () override
 
void SetCallback (MPCallback *mp_callback) override
 
bool SupportsCallbacks () const override
 
virtual void Write (const std::string &filename)
 
double best_objective_bound () const
 
double objective_value () const
 
bool CheckSolutionIsSynchronized () const
 
virtual bool CheckSolutionExists () const
 
bool CheckSolutionIsSynchronizedAndExists () const
 
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 double ComputeExactConditionNumber () const
 
virtual void SetStartingLpBasis (const std::vector< MPSolver::BasisStatus > &variable_statuses, const std::vector< MPSolver::BasisStatus > &constraint_statuses)
 

Static Public Attributes

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

Protected Member Functions

void ExtractModel ()
 
void ResetExtractionInformation ()
 
void InvalidateSolutionSynchronization ()
 
void SetCommonParameters (const MPSolverParameters &param)
 
void SetMIPParameters (const MPSolverParameters &param)
 
void SetUnsupportedDoubleParam (MPSolverParameters::DoubleParam param)
 
void SetDoubleParamToUnsupportedValue (MPSolverParameters::DoubleParam param, double value)
 

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
inherited
Enumerator
MUST_RELOAD 
MODEL_SYNCHRONIZED 
SOLUTION_SYNCHRONIZED 

Definition at line 1574 of file linear_solver.h.

Constructor & Destructor Documentation

◆ SCIPInterface()

SCIPInterface ( MPSolver *  solver)
explicit

Definition at line 252 of file scip_interface.cc.

◆ ~SCIPInterface()

~SCIPInterface ( )
override

Definition at line 257 of file scip_interface.cc.

Member Function Documentation

◆ AddIndicatorConstraint()

bool AddIndicatorConstraint ( MPConstraint *  ct)
overridevirtual

Reimplemented from MPSolverInterface.

Definition at line 491 of file scip_interface.cc.

◆ AddRowConstraint()

void AddRowConstraint ( MPConstraint *  ct)
overridevirtual

Implements MPSolverInterface.

Definition at line 487 of file scip_interface.cc.

◆ AddVariable()

void AddVariable ( MPVariable *  var)
overridevirtual

Implements MPSolverInterface.

Definition at line 496 of file scip_interface.cc.

◆ best_objective_bound()

double best_objective_bound ( ) const
inherited

Definition at line 1911 of file linear_solver.cc.

◆ BranchingPriorityChangedForVariable()

void BranchingPriorityChangedForVariable ( int  var_index)
overridevirtual

Reimplemented from MPSolverInterface.

Definition at line 475 of file scip_interface.cc.

◆ CheckSolutionExists()

bool CheckSolutionExists ( ) const
virtualinherited

Definition at line 1896 of file linear_solver.cc.

◆ CheckSolutionIsSynchronized()

bool CheckSolutionIsSynchronized ( ) const
inherited

Definition at line 1884 of file linear_solver.cc.

◆ CheckSolutionIsSynchronizedAndExists()

bool CheckSolutionIsSynchronizedAndExists ( ) const
inlineinherited

Definition at line 1696 of file linear_solver.h.

◆ ClearConstraint()

void ClearConstraint ( MPConstraint *  constraint)
overridevirtual

Implements MPSolverInterface.

Definition at line 421 of file scip_interface.cc.

◆ ClearObjective()

void ClearObjective ( )
overridevirtual

Implements MPSolverInterface.

Definition at line 451 of file scip_interface.cc.

◆ column_status()

MPSolver::BasisStatus column_status ( int  variable_index) const
inlineoverridevirtual

Implements MPSolverInterface.

Definition at line 97 of file scip_interface.cc.

◆ ComputeExactConditionNumber()

double ComputeExactConditionNumber ( ) const
virtualinherited

Reimplemented in GurobiInterface.

Definition at line 1935 of file linear_solver.cc.

◆ constraint_is_extracted()

bool constraint_is_extracted ( int  ct_index) const
inlineinherited

Definition at line 1722 of file linear_solver.h.

◆ DirectlySolveProto()

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

Reimplemented from MPSolverInterface.

Definition at line 865 of file scip_interface.cc.

◆ ExtractModel()

void ExtractModel ( )
protectedinherited

Definition at line 1848 of file linear_solver.cc.

◆ ExtractNewConstraints()

void ExtractNewConstraints ( )
overridevirtual

Implements MPSolverInterface.

Definition at line 543 of file scip_interface.cc.

◆ ExtractNewVariables()

void ExtractNewVariables ( )
overridevirtual

Implements MPSolverInterface.

Definition at line 498 of file scip_interface.cc.

◆ ExtractObjective()

void ExtractObjective ( )
overridevirtual

Implements MPSolverInterface.

Definition at line 643 of file scip_interface.cc.

◆ InterruptSolve()

bool InterruptSolve ( )
inlineoverridevirtual

Reimplemented from MPSolverInterface.

Definition at line 116 of file scip_interface.cc.

◆ InvalidateSolutionSynchronization()

void InvalidateSolutionSynchronization ( )
protectedinherited

Definition at line 1929 of file linear_solver.cc.

◆ IsContinuous()

bool IsContinuous ( ) const
inlineoverridevirtual

Implements MPSolverInterface.

Definition at line 102 of file scip_interface.cc.

◆ IsLP()

bool IsLP ( ) const
inlineoverridevirtual

Implements MPSolverInterface.

Definition at line 103 of file scip_interface.cc.

◆ IsMIP()

bool IsMIP ( ) const
inlineoverridevirtual

Implements MPSolverInterface.

Definition at line 104 of file scip_interface.cc.

◆ iterations()

int64_t iterations ( ) const
overridevirtual

Implements MPSolverInterface.

Definition at line 904 of file scip_interface.cc.

◆ last_variable_index()

int last_variable_index ( ) const
inlineinherited

Definition at line 1714 of file linear_solver.h.

◆ NextSolution()

bool NextSolution ( )
overridevirtual

Reimplemented from MPSolverInterface.

Definition at line 890 of file scip_interface.cc.

◆ nodes()

int64_t nodes ( ) const
overridevirtual

Implements MPSolverInterface.

Definition at line 911 of file scip_interface.cc.

◆ objective_value()

double objective_value ( ) const
inherited

Definition at line 1906 of file linear_solver.cc.

◆ quiet()

bool quiet ( ) const
inlineinherited

Definition at line 1730 of file linear_solver.h.

◆ Reset()

void Reset ( )
overridevirtual

Implements MPSolverInterface.

Definition at line 259 of file scip_interface.cc.

◆ ResetExtractionInformation()

void ResetExtractionInformation ( )
protectedinherited

Definition at line 1876 of file linear_solver.cc.

◆ result_status()

MPSolver::ResultStatus result_status ( ) const
inlineinherited

Definition at line 1735 of file linear_solver.h.

◆ row_status()

MPSolver::BasisStatus row_status ( int  constraint_index) const
inlineoverridevirtual

Implements MPSolverInterface.

Definition at line 93 of file scip_interface.cc.

◆ set_constraint_as_extracted()

void set_constraint_as_extracted ( int  ct_index,
bool  extracted 
)
inlineinherited

Definition at line 1725 of file linear_solver.h.

◆ set_quiet()

void set_quiet ( bool  quiet_value)
inlineinherited

Definition at line 1732 of file linear_solver.h.

◆ set_variable_as_extracted()

void set_variable_as_extracted ( int  var_index,
bool  extracted 
)
inlineinherited

Definition at line 1719 of file linear_solver.h.

◆ SetCallback()

void SetCallback ( MPCallback *  mp_callback)
overridevirtual

Reimplemented from MPSolverInterface.

Definition at line 1151 of file scip_interface.cc.

◆ SetCoefficient()

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

Implements MPSolverInterface.

Definition at line 396 of file scip_interface.cc.

◆ SetCommonParameters()

void SetCommonParameters ( const MPSolverParameters &  param)
protectedinherited

Definition at line 1944 of file linear_solver.cc.

◆ SetConstraintBounds()

void SetConstraintBounds ( int  row_index,
double  lb,
double  ub 
)
overridevirtual

Implements MPSolverInterface.

Definition at line 380 of file scip_interface.cc.

◆ SetDoubleParamToUnsupportedValue()

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

Definition at line 1980 of file linear_solver.cc.

◆ SetMIPParameters()

void SetMIPParameters ( const MPSolverParameters &  param)
protectedinherited

Definition at line 1965 of file linear_solver.cc.

◆ SetObjectiveCoefficient()

void SetObjectiveCoefficient ( const MPVariable *  variable,
double  coefficient 
)
overridevirtual

Implements MPSolverInterface.

Definition at line 440 of file scip_interface.cc.

◆ SetObjectiveOffset()

void SetObjectiveOffset ( double  value)
overridevirtual

Implements MPSolverInterface.

Definition at line 446 of file scip_interface.cc.

◆ SetOptimizationDirection()

void SetOptimizationDirection ( bool  maximize)
overridevirtual

Implements MPSolverInterface.

Definition at line 335 of file scip_interface.cc.

◆ SetStartingLpBasis()

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

Reimplemented in GLOPInterface.

Definition at line 1751 of file linear_solver.h.

◆ SetUnsupportedDoubleParam()

void SetUnsupportedDoubleParam ( MPSolverParameters::DoubleParam  param)
protectedinherited

Definition at line 1972 of file linear_solver.cc.

◆ SetVariableBounds()

void SetVariableBounds ( int  var_index,
double  lb,
double  ub 
)
overridevirtual

Implements MPSolverInterface.

Definition at line 343 of file scip_interface.cc.

◆ SetVariableInteger()

void SetVariableInteger ( int  var_index,
bool  integer 
)
overridevirtual

Implements MPSolverInterface.

Definition at line 359 of file scip_interface.cc.

◆ Solve()

MPSolver::ResultStatus Solve ( const MPSolverParameters &  param)
overridevirtual

Implements MPSolverInterface.

Definition at line 676 of file scip_interface.cc.

◆ SolverVersion()

std::string SolverVersion ( ) const
inlineoverridevirtual

Implements MPSolverInterface.

Definition at line 110 of file scip_interface.cc.

◆ SupportsCallbacks()

bool SupportsCallbacks ( ) const
inlineoverridevirtual

Reimplemented from MPSolverInterface.

Definition at line 153 of file scip_interface.cc.

◆ underlying_solver()

void* underlying_solver ( )
inlineoverridevirtual

Implements MPSolverInterface.

Definition at line 126 of file scip_interface.cc.

◆ variable_is_extracted()

bool variable_is_extracted ( int  var_index) const
inlineinherited

Definition at line 1716 of file linear_solver.h.

◆ Write()

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

Reimplemented in GurobiInterface.

Definition at line 1844 of file linear_solver.cc.

Member Data Documentation

◆ best_objective_bound_

double best_objective_bound_
protectedinherited

Definition at line 1794 of file linear_solver.h.

◆ kDummyVariableIndex

const int kDummyVariableIndex = 0
staticprotectedinherited

Definition at line 1801 of file linear_solver.h.

◆ kUnknownNumberOfIterations

constexpr int64_t kUnknownNumberOfIterations = -1
staticconstexprinherited

Definition at line 1589 of file linear_solver.h.

◆ kUnknownNumberOfNodes

constexpr int64_t kUnknownNumberOfNodes = -1
staticconstexprinherited

Definition at line 1592 of file linear_solver.h.

◆ last_constraint_index_

int last_constraint_index_
protectedinherited

Definition at line 1786 of file linear_solver.h.

◆ last_variable_index_

int last_variable_index_
protectedinherited

Definition at line 1788 of file linear_solver.h.

◆ maximize_

bool maximize_
protectedinherited

Definition at line 1783 of file linear_solver.h.

◆ objective_value_

double objective_value_
protectedinherited

Definition at line 1791 of file linear_solver.h.

◆ quiet_

bool quiet_
protectedinherited

Definition at line 1797 of file linear_solver.h.

◆ result_status_

MPSolver::ResultStatus result_status_
protectedinherited

Definition at line 1781 of file linear_solver.h.

◆ solver_

MPSolver* const solver_
protectedinherited

Definition at line 1776 of file linear_solver.h.

◆ sync_status_

SynchronizationStatus sync_status_
protectedinherited

Definition at line 1778 of file linear_solver.h.

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