Google OR-Tools v9.15
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
operations_research::GScip Class Reference

Detailed Description

Definition at line 140 of file gscip.h.

#include <gscip.h>

Classes

class  Interrupter

Public Member Functions

 ~GScip ()
absl::StatusOr< GScipResult > Solve (const GScipParameters &params=GScipParameters(), GScipMessageHandler message_handler=nullptr, const Interrupter *interrupter=nullptr)
absl::Status SetMaximize (bool is_maximize)
absl::Status SetObjectiveOffset (double offset)
absl::StatusOr< SCIP_VAR * > AddVariable (double lb, double ub, double obj_coef, GScipVarType var_type, const std::string &var_name="", const GScipVariableOptions &options=DefaultGScipVariableOptions())
absl::StatusOr< SCIP_CONS * > AddLinearConstraint (const GScipLinearRange &range, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
bool ObjectiveIsMaximize ()
double ObjectiveOffset ()
double Lb (SCIP_VAR *var)
double Ub (SCIP_VAR *var)
double ObjCoef (SCIP_VAR *var)
GScipVarType VarType (SCIP_VAR *var)
absl::string_view Name (SCIP_VAR *var)
const absl::flat_hash_set< SCIP_VAR * > & variables ()
absl::string_view Name (SCIP_CONS *constraint)
bool IsConstraintLinear (SCIP_CONS *constraint)
const absl::flat_hash_set< SCIP_CONS * > & constraints ()
absl::Span< const double > LinearConstraintCoefficients (SCIP_CONS *constraint)
absl::Span< SCIP_VAR *const > LinearConstraintVariables (SCIP_CONS *constraint)
double LinearConstraintLb (SCIP_CONS *constraint)
double LinearConstraintUb (SCIP_CONS *constraint)
absl::Status SetLb (SCIP_VAR *var, double lb)
absl::Status SetUb (SCIP_VAR *var, double ub)
absl::Status SetObjCoef (SCIP_VAR *var, double obj_coef)
absl::Status SetVarType (SCIP_VAR *var, GScipVarType var_type)
absl::Status DeleteVariable (SCIP_VAR *var)
absl::Status CanSafeBulkDelete (const absl::flat_hash_set< SCIP_VAR * > &vars)
absl::Status SafeBulkDelete (const absl::flat_hash_set< SCIP_VAR * > &vars)
absl::Status SetLinearConstraintLb (SCIP_CONS *constraint, double lb)
absl::Status SetLinearConstraintUb (SCIP_CONS *constraint, double ub)
absl::Status SetLinearConstraintCoef (SCIP_CONS *constraint, SCIP_VAR *var, double value)
absl::Status AddLinearConstraintCoef (SCIP_CONS *constraint, SCIP_VAR *var, double value)
absl::Status DeleteConstraint (SCIP_CONS *constraint)
absl::StatusOr< SCIP_CONS * > AddIndicatorConstraint (const GScipIndicatorConstraint &indicator_constraint, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
absl::StatusOr< SCIP_CONS * > AddQuadraticConstraint (const GScipQuadraticRange &range, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
absl::StatusOr< SCIP_CONS * > AddAndConstraint (const GScipLogicalConstraintData &logical_data, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
absl::StatusOr< SCIP_CONS * > AddOrConstraint (const GScipLogicalConstraintData &logical_data, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
absl::StatusOr< SCIP_CONS * > AddSOS1Constraint (const GScipSOSData &sos_data, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
absl::StatusOr< SCIP_CONS * > AddSOS2Constraint (const GScipSOSData &sos_data, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
absl::string_view ConstraintType (SCIP_CONS *constraint)
absl::StatusOr< GScipHintResult > SuggestHint (const GScipSolution &partial_solution)
absl::Status SetBranchingPriority (SCIP_VAR *var, int priority)
double ScipInf ()
SCIP * scip ()
absl::StatusOr< bool > DefaultBoolParamValue (const std::string &parameter_name)
absl::StatusOr< int > DefaultIntParamValue (const std::string &parameter_name)
absl::StatusOr< int64_t > DefaultLongParamValue (const std::string &parameter_name)
absl::StatusOr< double > DefaultRealParamValue (const std::string &parameter_name)
absl::StatusOr< char > DefaultCharParamValue (const std::string &parameter_name)
absl::StatusOr< std::string > DefaultStringParamValue (const std::string &parameter_name)
bool InErrorState ()
void InterruptSolveFromCallbackOnCallbackError (absl::Status error_status)
template<typename ConsHandler, typename ConsData>
absl::StatusOr< SCIP_CONS * > AddConstraintForHandler (ConsHandler *handler, ConsData *data, const std::string &name="", const GScipConstraintOptions &options=DefaultGScipConstraintOptions())
absl::StatusOr< double > ScipInfClamp (double d)
double ScipInfUnclamp (double d)

Static Public Member Functions

static absl::StatusOr< std::unique_ptr< GScip > > Create (const std::string &problem_name)
static std::string ScipVersion ()

Static Public Attributes

static constexpr double kDefaultScipInf = 1e20

Constructor & Destructor Documentation

◆ ~GScip()

operations_research::GScip::~GScip ( )

Definition at line 425 of file gscip.cc.

Member Function Documentation

◆ AddAndConstraint()

absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddAndConstraint ( const GScipLogicalConstraintData & logical_data,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )

Definition at line 589 of file gscip.cc.

◆ AddConstraintForHandler()

template<typename ConsHandler, typename ConsData>
absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddConstraintForHandler ( ConsHandler * handler,
ConsData * data,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )
inline

Definition at line 694 of file gscip.h.

◆ AddIndicatorConstraint()

absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddIndicatorConstraint ( const GScipIndicatorConstraint & indicator_constraint,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )

Definition at line 548 of file gscip.cc.

◆ AddLinearConstraint()

absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddLinearConstraint ( const GScipLinearRange & range,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )

Definition at line 466 of file gscip.cc.

◆ AddLinearConstraintCoef()

absl::Status operations_research::GScip::AddLinearConstraintCoef ( SCIP_CONS * constraint,
SCIP_VAR * var,
double value )

Definition at line 888 of file gscip.cc.

◆ AddOrConstraint()

absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddOrConstraint ( const GScipLogicalConstraintData & logical_data,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )

Definition at line 614 of file gscip.cc.

◆ AddQuadraticConstraint()

absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddQuadraticConstraint ( const GScipQuadraticRange & range,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )

Definition at line 500 of file gscip.cc.

◆ AddSOS1Constraint()

absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddSOS1Constraint ( const GScipSOSData & sos_data,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )

Definition at line 661 of file gscip.cc.

◆ AddSOS2Constraint()

absl::StatusOr< SCIP_CONS * > operations_research::GScip::AddSOS2Constraint ( const GScipSOSData & sos_data,
const std::string & name = "",
const GScipConstraintOptions & options = DefaultGScipConstraintOptions() )

Definition at line 688 of file gscip.cc.

◆ AddVariable()

absl::StatusOr< SCIP_VAR * > operations_research::GScip::AddVariable ( double lb,
double ub,
double obj_coef,
GScipVarType var_type,
const std::string & var_name = "",
const GScipVariableOptions & options = DefaultGScipVariableOptions() )

Definition at line 430 of file gscip.cc.

◆ CanSafeBulkDelete()

absl::Status operations_research::GScip::CanSafeBulkDelete ( const absl::flat_hash_set< SCIP_VAR * > & vars)

Definition at line 774 of file gscip.cc.

◆ constraints()

const absl::flat_hash_set< SCIP_CONS * > & operations_research::GScip::constraints ( )
inline

Definition at line 250 of file gscip.h.

◆ ConstraintType()

absl::string_view operations_research::GScip::ConstraintType ( SCIP_CONS * constraint)

Definition at line 827 of file gscip.cc.

◆ Create()

absl::StatusOr< std::unique_ptr< GScip > > operations_research::GScip::Create ( const std::string & problem_name)
static

Definition at line 362 of file gscip.cc.

◆ DefaultBoolParamValue()

absl::StatusOr< bool > operations_research::GScip::DefaultBoolParamValue ( const std::string & parameter_name)

Definition at line 1118 of file gscip.cc.

◆ DefaultCharParamValue()

absl::StatusOr< char > operations_research::GScip::DefaultCharParamValue ( const std::string & parameter_name)

Definition at line 1150 of file gscip.cc.

◆ DefaultIntParamValue()

absl::StatusOr< int > operations_research::GScip::DefaultIntParamValue ( const std::string & parameter_name)

Definition at line 1126 of file gscip.cc.

◆ DefaultLongParamValue()

absl::StatusOr< int64_t > operations_research::GScip::DefaultLongParamValue ( const std::string & parameter_name)

Definition at line 1134 of file gscip.cc.

◆ DefaultRealParamValue()

absl::StatusOr< double > operations_research::GScip::DefaultRealParamValue ( const std::string & parameter_name)

Definition at line 1142 of file gscip.cc.

◆ DefaultStringParamValue()

absl::StatusOr< std::string > operations_research::GScip::DefaultStringParamValue ( const std::string & parameter_name)

Definition at line 1158 of file gscip.cc.

◆ DeleteConstraint()

absl::Status operations_research::GScip::DeleteConstraint ( SCIP_CONS * constraint)

Definition at line 871 of file gscip.cc.

◆ DeleteVariable()

absl::Status operations_research::GScip::DeleteVariable ( SCIP_VAR * var)

Definition at line 764 of file gscip.cc.

◆ InErrorState()

bool operations_research::GScip::InErrorState ( )

Definition at line 1201 of file gscip.cc.

◆ InterruptSolveFromCallbackOnCallbackError()

void operations_research::GScip::InterruptSolveFromCallbackOnCallbackError ( absl::Status error_status)

Definition at line 390 of file gscip.cc.

◆ IsConstraintLinear()

bool operations_research::GScip::IsConstraintLinear ( SCIP_CONS * constraint)

Definition at line 831 of file gscip.cc.

◆ Lb()

double operations_research::GScip::Lb ( SCIP_VAR * var)

Definition at line 811 of file gscip.cc.

◆ LinearConstraintCoefficients()

absl::Span< const double > operations_research::GScip::LinearConstraintCoefficients ( SCIP_CONS * constraint)

Definition at line 835 of file gscip.cc.

◆ LinearConstraintLb()

double operations_research::GScip::LinearConstraintLb ( SCIP_CONS * constraint)

Definition at line 847 of file gscip.cc.

◆ LinearConstraintUb()

double operations_research::GScip::LinearConstraintUb ( SCIP_CONS * constraint)

Definition at line 851 of file gscip.cc.

◆ LinearConstraintVariables()

absl::Span< SCIP_VAR *const > operations_research::GScip::LinearConstraintVariables ( SCIP_CONS * constraint)

Definition at line 841 of file gscip.cc.

◆ Name() [1/2]

absl::string_view operations_research::GScip::Name ( SCIP_CONS * constraint)

Definition at line 855 of file gscip.cc.

◆ Name() [2/2]

absl::string_view operations_research::GScip::Name ( SCIP_VAR * var)

Definition at line 825 of file gscip.cc.

◆ ObjCoef()

double operations_research::GScip::ObjCoef ( SCIP_VAR * var)

Definition at line 819 of file gscip.cc.

◆ ObjectiveIsMaximize()

bool operations_research::GScip::ObjectiveIsMaximize ( )

Definition at line 728 of file gscip.cc.

◆ ObjectiveOffset()

double operations_research::GScip::ObjectiveOffset ( )

Definition at line 732 of file gscip.cc.

◆ SafeBulkDelete()

absl::Status operations_research::GScip::SafeBulkDelete ( const absl::flat_hash_set< SCIP_VAR * > & vars)

Definition at line 788 of file gscip.cc.

◆ scip()

SCIP * operations_research::GScip::scip ( )
inline

Definition at line 403 of file gscip.h.

◆ ScipInf()

double operations_research::GScip::ScipInf ( )

Definition at line 378 of file gscip.cc.

◆ ScipInfClamp()

absl::StatusOr< double > operations_research::GScip::ScipInfClamp ( double d)

Definition at line 1166 of file gscip.cc.

◆ ScipInfUnclamp()

double operations_research::GScip::ScipInfUnclamp ( double d)

Definition at line 1183 of file gscip.cc.

◆ ScipVersion()

std::string operations_research::GScip::ScipVersion ( )
static

Definition at line 384 of file gscip.cc.

◆ SetBranchingPriority()

absl::Status operations_research::GScip::SetBranchingPriority ( SCIP_VAR * var,
int priority )

Definition at line 734 of file gscip.cc.

◆ SetLb()

absl::Status operations_research::GScip::SetLb ( SCIP_VAR * var,
double lb )

Definition at line 739 of file gscip.cc.

◆ SetLinearConstraintCoef()

absl::Status operations_research::GScip::SetLinearConstraintCoef ( SCIP_CONS * constraint,
SCIP_VAR * var,
double value )

Definition at line 878 of file gscip.cc.

◆ SetLinearConstraintLb()

absl::Status operations_research::GScip::SetLinearConstraintLb ( SCIP_CONS * constraint,
double lb )

Definition at line 859 of file gscip.cc.

◆ SetLinearConstraintUb()

absl::Status operations_research::GScip::SetLinearConstraintUb ( SCIP_CONS * constraint,
double ub )

Definition at line 865 of file gscip.cc.

◆ SetMaximize()

absl::Status operations_research::GScip::SetMaximize ( bool is_maximize)

Definition at line 714 of file gscip.cc.

◆ SetObjCoef()

absl::Status operations_research::GScip::SetObjCoef ( SCIP_VAR * var,
double obj_coef )

Definition at line 751 of file gscip.cc.

◆ SetObjectiveOffset()

absl::Status operations_research::GScip::SetObjectiveOffset ( double offset)

Definition at line 720 of file gscip.cc.

◆ SetUb()

absl::Status operations_research::GScip::SetUb ( SCIP_VAR * var,
double ub )

Definition at line 745 of file gscip.cc.

◆ SetVarType()

absl::Status operations_research::GScip::SetVarType ( SCIP_VAR * var,
GScipVarType var_type )

Definition at line 757 of file gscip.cc.

◆ Solve()

absl::StatusOr< GScipResult > operations_research::GScip::Solve ( const GScipParameters & params = GScipParameters(),
GScipMessageHandler message_handler = nullptr,
const Interrupter * interrupter = nullptr )

Definition at line 933 of file gscip.cc.

◆ SuggestHint()

absl::StatusOr< GScipHintResult > operations_research::GScip::SuggestHint ( const GScipSolution & partial_solution)

Definition at line 896 of file gscip.cc.

◆ Ub()

double operations_research::GScip::Ub ( SCIP_VAR * var)

Definition at line 815 of file gscip.cc.

◆ variables()

const absl::flat_hash_set< SCIP_VAR * > & operations_research::GScip::variables ( )
inline

Definition at line 245 of file gscip.h.

◆ VarType()

GScipVarType operations_research::GScip::VarType ( SCIP_VAR * var)

Definition at line 821 of file gscip.cc.

Member Data Documentation

◆ kDefaultScipInf

double operations_research::GScip::kDefaultScipInf = 1e20
staticconstexpr

Definition at line 400 of file gscip.h.

The documentation for this class was generated from the following files:
  • ortools/math_opt/solvers/gscip/gscip.h
  • ortools/math_opt/solvers/gscip/gscip.cc