Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

constraint handler for disjunction constraints

Author
Stefan Heinz
Michael Winkler

Definition in file cons_disjunction.c.

#include "blockmemshell/memory.h"
#include "scip/cons_disjunction.h"
#include "scip/pub_cons.h"
#include "scip/pub_message.h"
#include "scip/pub_tree.h"
#include "scip/scip_branch.h"
#include "scip/scip_cons.h"
#include "scip/scip_copy.h"
#include "scip/scip_general.h"
#include "scip/scip_mem.h"
#include "scip/scip_message.h"
#include "scip/scip_param.h"
#include "scip/scip_prob.h"
#include "scip/scip_probing.h"
#include "scip/scip_sol.h"
#include "scip/scip_solvingstats.h"
#include "scip/scip_tree.h"
#include <string.h>

Go to the source code of this file.

Macros

#define CONSHDLR_NAME   "disjunction"
 
#define CONSHDLR_DESC   "disjunction of constraints (or(cons1, cons2, ..., consn))"
 
#define CONSHDLR_ENFOPRIORITY   -950000
 
#define CONSHDLR_CHECKPRIORITY   -900000
 
#define CONSHDLR_PROPFREQ   -1
 
#define CONSHDLR_EAGERFREQ   100
 
#define CONSHDLR_MAXPREROUNDS   -1
 
#define CONSHDLR_DELAYPROP   FALSE
 
#define CONSHDLR_NEEDSCONS   TRUE
 
#define CONSHDLR_PRESOLTIMING   SCIP_PRESOLTIMING_FAST
 
#define CONSHDLR_PROP_TIMING   SCIP_PROPTIMING_BEFORELP
 
#define DEFAULT_ALWAYSBRANCH   TRUE
 

Functions

static SCIP_RETCODE consdataCreate (SCIP *scip, SCIP_CONSDATA **consdata, SCIP_CONS **conss, int nconss, SCIP_CONS *relaxcons)
 
static SCIP_RETCODE consdataFree (SCIP *scip, SCIP_CONSDATA **consdata)
 
static SCIP_RETCODE consdataAddCons (SCIP *scip, SCIP_CONSDATA *consdata, SCIP_CONS *cons)
 
static SCIP_RETCODE branchCons (SCIP *scip, SCIP_CONS *cons, SCIP_RESULT *result)
 
static SCIP_RETCODE checkCons (SCIP *scip, SCIP_CONS *cons, SCIP_SOL *sol, SCIP_Bool checkintegrality, SCIP_Bool checklprows, SCIP_Bool printreason, SCIP_RESULT *result)
 
static SCIP_RETCODE propagateCons (SCIP *scip, SCIP_CONS *cons, int *ndelconss)
 
static SCIP_RETCODE enforceConstraint (SCIP *scip, SCIP_CONSHDLR *conshdlr, SCIP_CONS **conss, int nconss, SCIP_SOL *sol, SCIP_RESULT *result)
 
static SCIP_DECL_CONSHDLRCOPY (conshdlrCopyDisjunction)
 
static SCIP_DECL_CONSFREE (consFreeDisjunction)
 
static SCIP_DECL_CONSDELETE (consDeleteDisjunction)
 
static SCIP_DECL_CONSTRANS (consTransDisjunction)
 
static SCIP_DECL_CONSINITLP (consInitlpDisjunction)
 
static SCIP_DECL_CONSENFOLP (consEnfolpDisjunction)
 
static SCIP_DECL_CONSENFORELAX (consEnforelaxDisjunction)
 
static SCIP_DECL_CONSENFOPS (consEnfopsDisjunction)
 
static SCIP_DECL_CONSCHECK (consCheckDisjunction)
 
static SCIP_DECL_CONSPROP (consPropDisjunction)
 
static SCIP_DECL_CONSPRESOL (consPresolDisjunction)
 
static SCIP_DECL_CONSLOCK (consLockDisjunction)
 
static SCIP_DECL_CONSPRINT (consPrintDisjunction)
 
static SCIP_DECL_CONSPARSE (consParseDisjunction)
 
static SCIP_DECL_CONSCOPY (consCopyDisjunction)
 
SCIP_RETCODE SCIPincludeConshdlrDisjunction (SCIP *scip)
 
SCIP_RETCODE SCIPcreateConsDisjunction (SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss, SCIP_CONS *relaxcons, SCIP_Bool initial, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic)
 
SCIP_RETCODE SCIPcreateConsBasicDisjunction (SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss, SCIP_CONS *relaxcons)
 
SCIP_RETCODE SCIPaddConsElemDisjunction (SCIP *scip, SCIP_CONS *cons, SCIP_CONS *addcons)
 

Macro Definition Documentation

◆ CONSHDLR_NAME

#define CONSHDLR_NAME   "disjunction"

◆ CONSHDLR_DESC

#define CONSHDLR_DESC   "disjunction of constraints (or(cons1, cons2, ..., consn))"

Definition at line 56 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_ENFOPRIORITY

#define CONSHDLR_ENFOPRIORITY   -950000

priority of the constraint handler for constraint enforcing

Definition at line 57 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_CHECKPRIORITY

#define CONSHDLR_CHECKPRIORITY   -900000

priority of the constraint handler for checking feasibility

Definition at line 58 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_PROPFREQ

#define CONSHDLR_PROPFREQ   -1

frequency for propagating domains; zero means only preprocessing propagation

Definition at line 59 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_EAGERFREQ

#define CONSHDLR_EAGERFREQ   100

frequency for using all instead of only the useful constraints in separation, propagation and enforcement, -1 for no eager evaluations, 0 for first only

Definition at line 60 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_MAXPREROUNDS

#define CONSHDLR_MAXPREROUNDS   -1

maximal number of presolving rounds the constraint handler participates in (-1: no limit)

Definition at line 63 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_DELAYPROP

#define CONSHDLR_DELAYPROP   FALSE

should propagation method be delayed, if other propagators found reductions?

Definition at line 66 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_NEEDSCONS

#define CONSHDLR_NEEDSCONS   TRUE

should the constraint handler be skipped, if no constraints are available?

Definition at line 67 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_PRESOLTIMING

#define CONSHDLR_PRESOLTIMING   SCIP_PRESOLTIMING_FAST

Definition at line 69 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ CONSHDLR_PROP_TIMING

#define CONSHDLR_PROP_TIMING   SCIP_PROPTIMING_BEFORELP

Definition at line 70 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

◆ DEFAULT_ALWAYSBRANCH

#define DEFAULT_ALWAYSBRANCH   TRUE

alawys perform branching if one of the constraints is violated, otherwise only if all integers are fixed

Definition at line 73 of file cons_disjunction.c.

Referenced by SCIPincludeConshdlrDisjunction().

Function Documentation

◆ consdataCreate()

static SCIP_RETCODE consdataCreate ( SCIP scip,
SCIP_CONSDATA **  consdata,
SCIP_CONS **  conss,
int  nconss,
SCIP_CONS relaxcons 
)
static

creates disjunction constraint data, captures initial constraints of disjunction

Parameters
scipSCIP data structure
consdatapointer to constraint data
conssinitial constraint in disjunction
nconssnumber of initial constraints in disjunction
relaxconsa conjunction constraint containing the liner relaxation of the disjunction constraint, or NULL

Definition at line 102 of file cons_disjunction.c.

References consdataFree(), NULL, SCIP_CALL, SCIP_OKAY, SCIPallocBlockMemory, SCIPcaptureCons(), SCIPduplicateBlockMemoryArray, SCIPisTransformed(), SCIPtransformCons(), and SCIPtransformConss().

Referenced by SCIPcreateConsDisjunction().

◆ consdataFree()

static SCIP_RETCODE consdataFree ( SCIP scip,
SCIP_CONSDATA **  consdata 
)
static

frees constraint data and releases all constraints in disjunction

Parameters
scipSCIP data structure
consdatapointer to constraint data

Definition at line 165 of file cons_disjunction.c.

References consdataAddCons(), NULL, SCIP_CALL, SCIP_OKAY, SCIPfreeBlockMemory, SCIPfreeBlockMemoryArrayNull, and SCIPreleaseCons().

Referenced by consdataCreate().

◆ consdataAddCons()

static SCIP_RETCODE consdataAddCons ( SCIP scip,
SCIP_CONSDATA consdata,
SCIP_CONS cons 
)
static

adds constraint to disjunction

Parameters
scipSCIP data structure
consdataconstraint data
consconstraint to add to the disjunction

Definition at line 197 of file cons_disjunction.c.

References branchCons(), NULL, SCIP_CALL, SCIP_OKAY, SCIPcaptureCons(), SCIPensureBlockMemoryArray, SCIPisTransformed(), and SCIPtransformCons().

Referenced by consdataFree(), and SCIPaddConsElemDisjunction().

◆ branchCons()

static SCIP_RETCODE branchCons ( SCIP scip,
SCIP_CONS cons,
SCIP_RESULT result 
)
static

◆ checkCons()

static SCIP_RETCODE checkCons ( SCIP scip,
SCIP_CONS cons,
SCIP_SOL sol,
SCIP_Bool  checkintegrality,
SCIP_Bool  checklprows,
SCIP_Bool  printreason,
SCIP_RESULT result 
)
static

checks disjunction constraints if at least one is feasible

Parameters
scipSCIP data structure
consactive disjunction constraint
solsolution to check
checkintegralityHas integrality to be checked?
checklprowsDo constraints represented by rows in the current LP have to be checked?
printreasonShould the reason for the violation be printed?
resultpointer to store the result

Definition at line 299 of file cons_disjunction.c.

References FALSE, NULL, propagateCons(), SCIP_CALL, SCIP_FEASIBLE, SCIP_INFEASIBLE, SCIP_OKAY, SCIPactivateSolViolationUpdates(), SCIPcheckCons(), SCIPconsGetData(), SCIPconsGetName(), SCIPdeactivateSolViolationUpdates(), SCIPdebug, SCIPinfoMessage(), SCIPprintCons(), and SCIPupdateSolConsViolation().

Referenced by branchCons(), enforceConstraint(), and SCIP_DECL_CONSCHECK().

◆ propagateCons()

static SCIP_RETCODE propagateCons ( SCIP scip,
SCIP_CONS cons,
int *  ndelconss 
)
static

propagation method for disjunction constraint

Parameters
scipSCIP data structure
consdisjunctive constraint
ndelconsspointer to count number of deleted constraints

Definition at line 355 of file cons_disjunction.c.

References enforceConstraint(), NULL, SCIP_CALL, SCIP_OKAY, SCIP_STAGE_PRESOLVING, SCIPconsGetData(), SCIPconsIsActive(), SCIPconsIsChecked(), SCIPconsIsDeleted(), SCIPdelCons(), SCIPdelConsLocal(), SCIPgetNNodes(), SCIPgetStage(), SCIPsetConsChecked(), and TRUE.

Referenced by checkCons(), and SCIP_DECL_CONSPROP().

◆ enforceConstraint()

static SCIP_RETCODE enforceConstraint ( SCIP scip,
SCIP_CONSHDLR conshdlr,
SCIP_CONS **  conss,
int  nconss,
SCIP_SOL sol,
SCIP_RESULT result 
)
static

helper function to enforce constraints

Parameters
scipSCIP data structure
conshdlrconstraint handler
conssconstraints to process
nconssnumber of constraints
solsolution to enforce (NULL for LP solution)
resultpointer to store the result of the enforcing call

Definition at line 418 of file cons_disjunction.c.

References branch(), branchCons(), checkCons(), FALSE, NULL, SCIP_Bool, SCIP_BRANCHED, SCIP_CALL, SCIP_DECL_CONSHDLRCOPY(), SCIP_FEASIBLE, SCIP_INFEASIBLE, SCIP_OKAY, SCIPconshdlrGetData(), and SCIPgetNPseudoBranchCands().

Referenced by propagateCons().

◆ SCIP_DECL_CONSHDLRCOPY()

static SCIP_DECL_CONSHDLRCOPY ( conshdlrCopyDisjunction  )
static

copy method for constraint handler plugins (called when SCIP copies plugins)

Definition at line 458 of file cons_disjunction.c.

Referenced by enforceConstraint().

◆ SCIP_DECL_CONSFREE()

static SCIP_DECL_CONSFREE ( consFreeDisjunction  )
static

destructor of constraint handler to free constraint handler data (called when SCIP is exiting)

Definition at line 474 of file cons_disjunction.c.

◆ SCIP_DECL_CONSDELETE()

static SCIP_DECL_CONSDELETE ( consDeleteDisjunction  )
static

frees specific constraint data

Definition at line 495 of file cons_disjunction.c.

◆ SCIP_DECL_CONSTRANS()

static SCIP_DECL_CONSTRANS ( consTransDisjunction  )
static

transforms constraint data into data belonging to the transformed problem

Definition at line 505 of file cons_disjunction.c.

◆ SCIP_DECL_CONSINITLP()

static SCIP_DECL_CONSINITLP ( consInitlpDisjunction  )
static

LP initialization method of constraint handler

Definition at line 528 of file cons_disjunction.c.

References NULL, SCIP_CALL, SCIP_DECL_CONSENFOLP(), SCIP_OKAY, SCIPaddConsLocal(), SCIPconsGetData(), and SCIPconsIsActive().

◆ SCIP_DECL_CONSENFOLP()

static SCIP_DECL_CONSENFOLP ( consEnfolpDisjunction  )
static

constraint enforcing method of constraint handler for LP solutions

Definition at line 553 of file cons_disjunction.c.

Referenced by SCIP_DECL_CONSINITLP().

◆ SCIP_DECL_CONSENFORELAX()

static SCIP_DECL_CONSENFORELAX ( consEnforelaxDisjunction  )
static

constraint enforcing method of constraint handler for relaxation solutions

Definition at line 563 of file cons_disjunction.c.

◆ SCIP_DECL_CONSENFOPS()

static SCIP_DECL_CONSENFOPS ( consEnfopsDisjunction  )
static

constraint enforcing method of constraint handler for pseudo solutions

Definition at line 573 of file cons_disjunction.c.

◆ SCIP_DECL_CONSCHECK()

static SCIP_DECL_CONSCHECK ( consCheckDisjunction  )
static

feasibility check method of constraint handler for integral solutions

Definition at line 583 of file cons_disjunction.c.

References checkCons(), SCIP_CALL, SCIP_DECL_CONSPROP(), SCIP_FEASIBLE, SCIP_INFEASIBLE, and SCIP_OKAY.

◆ SCIP_DECL_CONSPROP()

static SCIP_DECL_CONSPROP ( consPropDisjunction  )
static

domain propagation method of constraint handler

Definition at line 607 of file cons_disjunction.c.

References propagateCons(), SCIP_CALL, SCIP_DECL_CONSPRESOL(), SCIP_DIDNOTFIND, SCIP_OKAY, and SCIP_REDUCEDDOM.

Referenced by SCIP_DECL_CONSCHECK().

◆ SCIP_DECL_CONSPRESOL()

static SCIP_DECL_CONSPRESOL ( consPresolDisjunction  )
static

presolving method of constraint handler

Definition at line 636 of file cons_disjunction.c.

Referenced by SCIP_DECL_CONSPROP().

◆ SCIP_DECL_CONSLOCK()

static SCIP_DECL_CONSLOCK ( consLockDisjunction  )
static

variable rounding lock method of constraint handler

Definition at line 690 of file cons_disjunction.c.

◆ SCIP_DECL_CONSPRINT()

static SCIP_DECL_CONSPRINT ( consPrintDisjunction  )
static

constraint display method of constraint handler

Definition at line 712 of file cons_disjunction.c.

◆ SCIP_DECL_CONSPARSE()

static SCIP_DECL_CONSPARSE ( consParseDisjunction  )
static

constraint parsing method of constraint handler

Definition at line 747 of file cons_disjunction.c.

◆ SCIP_DECL_CONSCOPY()

static SCIP_DECL_CONSCOPY ( consCopyDisjunction  )
static

constraint copying method of constraint handler

Definition at line 956 of file cons_disjunction.c.