OR-Tools  9.3
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
GScip

Detailed Description

Definition at line 127 of file gscip.h.

Public Member Functions

 ~GScip ()
 
absl::StatusOr< GScipResult > Solve (const GScipParameters &params=GScipParameters(), const std::string &legacy_params="", GScipMessageHandler message_handler=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 ()
 
bool InterruptSolve ()
 
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)
 

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()

~GScip ( )

Definition at line 321 of file gscip.cc.

Member Function Documentation

◆ AddAndConstraint()

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

Definition at line 463 of file gscip.cc.

◆ AddIndicatorConstraint()

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

Definition at line 426 of file gscip.cc.

◆ AddLinearConstraint()

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

Definition at line 358 of file gscip.cc.

◆ AddLinearConstraintCoef()

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

Definition at line 753 of file gscip.cc.

◆ AddOrConstraint()

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

Definition at line 488 of file gscip.cc.

◆ AddQuadraticConstraint()

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

Definition at line 388 of file gscip.cc.

◆ AddSOS1Constraint()

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

Definition at line 535 of file gscip.cc.

◆ AddSOS2Constraint()

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

Definition at line 562 of file gscip.cc.

◆ AddVariable()

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

Definition at line 326 of file gscip.cc.

◆ CanSafeBulkDelete()

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

Definition at line 646 of file gscip.cc.

◆ constraints()

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

Definition at line 195 of file gscip.h.

◆ ConstraintType()

absl::string_view ConstraintType ( SCIP_CONS *  constraint)

Definition at line 693 of file gscip.cc.

◆ Create()

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

Definition at line 273 of file gscip.cc.

◆ DefaultBoolParamValue()

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

Definition at line 955 of file gscip.cc.

◆ DefaultCharParamValue()

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

Definition at line 987 of file gscip.cc.

◆ DefaultIntParamValue()

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

Definition at line 963 of file gscip.cc.

◆ DefaultLongParamValue()

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

Definition at line 971 of file gscip.cc.

◆ DefaultRealParamValue()

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

Definition at line 979 of file gscip.cc.

◆ DefaultStringParamValue()

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

Definition at line 995 of file gscip.cc.

◆ DeleteConstraint()

absl::Status DeleteConstraint ( SCIP_CONS *  constraint)

Definition at line 737 of file gscip.cc.

◆ DeleteVariable()

absl::Status DeleteVariable ( SCIP_VAR *  var)

Definition at line 636 of file gscip.cc.

◆ InterruptSolve()

bool InterruptSolve ( )

Definition at line 297 of file gscip.cc.

◆ IsConstraintLinear()

bool IsConstraintLinear ( SCIP_CONS *  constraint)

Definition at line 697 of file gscip.cc.

◆ Lb()

double Lb ( SCIP_VAR *  var)

Definition at line 677 of file gscip.cc.

◆ LinearConstraintCoefficients()

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

Definition at line 701 of file gscip.cc.

◆ LinearConstraintLb()

double LinearConstraintLb ( SCIP_CONS *  constraint)

Definition at line 713 of file gscip.cc.

◆ LinearConstraintUb()

double LinearConstraintUb ( SCIP_CONS *  constraint)

Definition at line 717 of file gscip.cc.

◆ LinearConstraintVariables()

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

Definition at line 707 of file gscip.cc.

◆ Name() [1/2]

absl::string_view Name ( SCIP_CONS *  constraint)

Definition at line 721 of file gscip.cc.

◆ Name() [2/2]

absl::string_view Name ( SCIP_VAR *  var)

Definition at line 691 of file gscip.cc.

◆ ObjCoef()

double ObjCoef ( SCIP_VAR *  var)

Definition at line 685 of file gscip.cc.

◆ ObjectiveIsMaximize()

bool ObjectiveIsMaximize ( )

Definition at line 601 of file gscip.cc.

◆ ObjectiveOffset()

double ObjectiveOffset ( )

Definition at line 605 of file gscip.cc.

◆ SafeBulkDelete()

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

Definition at line 657 of file gscip.cc.

◆ scip()

SCIP * scip ( )
inline

Definition at line 343 of file gscip.h.

◆ ScipInf()

double ScipInf ( )

Definition at line 285 of file gscip.cc.

◆ ScipVersion()

std::string ScipVersion ( )
static

Definition at line 291 of file gscip.cc.

◆ SetBranchingPriority()

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

Definition at line 607 of file gscip.cc.

◆ SetLb()

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

Definition at line 612 of file gscip.cc.

◆ SetLinearConstraintCoef()

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

Definition at line 744 of file gscip.cc.

◆ SetLinearConstraintLb()

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

Definition at line 725 of file gscip.cc.

◆ SetLinearConstraintUb()

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

Definition at line 731 of file gscip.cc.

◆ SetMaximize()

absl::Status SetMaximize ( bool  is_maximize)

Definition at line 588 of file gscip.cc.

◆ SetObjCoef()

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

Definition at line 624 of file gscip.cc.

◆ SetObjectiveOffset()

absl::Status SetObjectiveOffset ( double  offset)

Definition at line 594 of file gscip.cc.

◆ SetUb()

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

Definition at line 618 of file gscip.cc.

◆ SetVarType()

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

Definition at line 629 of file gscip.cc.

◆ Solve()

absl::StatusOr< GScipResult > Solve ( const GScipParameters &  params = GScipParameters(),
const std::string &  legacy_params = "",
GScipMessageHandler  message_handler = nullptr 
)

Definition at line 797 of file gscip.cc.

◆ SuggestHint()

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

Definition at line 760 of file gscip.cc.

◆ Ub()

double Ub ( SCIP_VAR *  var)

Definition at line 681 of file gscip.cc.

◆ variables()

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

Definition at line 190 of file gscip.h.

◆ VarType()

GScipVarType VarType ( SCIP_VAR *  var)

Definition at line 687 of file gscip.cc.

Member Data Documentation

◆ kDefaultScipInf

constexpr double kDefaultScipInf = 1e20
staticconstexpr

Definition at line 333 of file gscip.h.

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