Scippy

SCIP

Solving Constraint Integer Programs

SCIP_Cons Struct Reference

Detailed Description

constraint data structure

Definition at line 37 of file struct_cons.h.

#include <struct_cons.h>

Data Fields

SCIP_Real age
 
char * name
 
SCIP_CONSHDLRconshdlr
 
SCIP_CONSDATAconsdata
 
SCIP_CONStransorigcons
 
SCIP_CONSSETCHGaddconssetchg
 
int addarraypos
 
int consspos
 
int initconsspos
 
int sepaconsspos
 
int enfoconsspos
 
int checkconsspos
 
int propconsspos
 
int nlockspos [NLOCKTYPES]
 
int nlocksneg [NLOCKTYPES]
 
int activedepth
 
int validdepth
 
int nuses
 
unsigned int initial:1
 
unsigned int separate:1
 
unsigned int enforce:1
 
unsigned int check:1
 
unsigned int propagate:1
 
unsigned int sepaenabled:1
 
unsigned int propenabled:1
 
unsigned int local:1
 
unsigned int modifiable:1
 
unsigned int dynamic:1
 
unsigned int removable:1
 
unsigned int stickingatnode:1
 
unsigned int original:1
 
unsigned int deleteconsdata:1
 
unsigned int active:1
 
unsigned int conflict:1
 
unsigned int enabled:1
 
unsigned int obsolete:1
 
unsigned int markpropagate:1
 
unsigned int deleted:1
 
unsigned int update:1
 
unsigned int updateinsert:1
 
unsigned int updateactivate:1
 
unsigned int updatedeactivate:1
 
unsigned int updateenable:1
 
unsigned int updatedisable:1
 
unsigned int updatesepaenable:1
 
unsigned int updatesepadisable:1
 
unsigned int updatepropenable:1
 
unsigned int updatepropdisable:1
 
unsigned int updateobsolete:1
 
unsigned int updatefree:1
 
unsigned int updateactfocus:1
 
unsigned int updatemarkpropagate:1
 
unsigned int updateunmarkpropagate:1
 
unsigned int nupgradelocks:28
 
SCIPscip
 

Field Documentation

◆ age

SCIP_Real SCIP_Cons::age

age of constraint: number of successive times, the constraint was irrelevant

Definition at line 39 of file struct_cons.h.

Referenced by consExceedsAgelimit(), consExceedsObsoleteage(), conshdlrAddUpdateCons(), SCIPconsAddAge(), SCIPconsGetAge(), and SCIPconsResetAge().

◆ name

◆ conshdlr

SCIP_CONSHDLR* SCIP_Cons::conshdlr

constraint handler for this constraint

Definition at line 41 of file struct_cons.h.

Referenced by consExceedsAgelimit(), consExceedsObsoleteage(), conshdlrActivateCons(), conshdlrAddCheckcons(), conshdlrAddCons(), conshdlrAddEnfocons(), conshdlrAddInitcons(), conshdlrAddPropcons(), conshdlrAddSepacons(), conshdlrAddUpdateCons(), conshdlrDeactivateCons(), conshdlrDelCheckcons(), conshdlrDelCons(), conshdlrDelEnfocons(), conshdlrDelInitcons(), conshdlrDelPropcons(), conshdlrDelSepacons(), conshdlrDisableCons(), conshdlrDisableConsPropagation(), conshdlrDisableConsSeparation(), conshdlrEnableCons(), conshdlrEnableConsPropagation(), conshdlrEnableConsSeparation(), conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsActive(), SCIPconsAddAge(), SCIPconsAddLocks(), SCIPconsCheck(), SCIPconsDeactivate(), SCIPconsDeactive(), SCIPconsDelete(), SCIPconsDisable(), SCIPconsDisablePropagation(), SCIPconsDisableSeparation(), SCIPconsEnable(), SCIPconsEnablePropagation(), SCIPconsEnableSeparation(), SCIPconsEnfolp(), SCIPconsEnfops(), SCIPconsEnforelax(), SCIPconsGetHdlr(), SCIPconsGetNVars(), SCIPconsGetVars(), SCIPconsInitlp(), SCIPconsMarkPropagate(), SCIPconsPresol(), SCIPconsPrint(), SCIPconsProp(), SCIPconsResetAge(), SCIPconsResolvePropagation(), SCIPconsResprop(), SCIPconsSepalp(), SCIPconsSepasol(), SCIPconsSetChecked(), SCIPconssetchgApply(), SCIPconssetchgUndo(), SCIPconsSetEnforced(), SCIPconsSetPropagated(), SCIPconsSetSeparated(), SCIPconsTransform(), SCIPconsUnmarkPropagate(), and SCIPreadProb().

◆ consdata

SCIP_CONSDATA* SCIP_Cons::consdata

data for this specific constraint

Definition at line 42 of file struct_cons.h.

Referenced by conshdlrAddUpdateCons(), conshdlrProcessUpdates(), SCIPconsFree(), SCIPconsGetData(), and SCIPconsTransform().

◆ transorigcons

SCIP_CONS* SCIP_Cons::transorigcons

for original constraints: associated transformed constraint or NULL, for transformed constraints: associated original constraint or NULL

Definition at line 43 of file struct_cons.h.

Referenced by SCIPconsGetTransformed(), and SCIPconsTransform().

◆ addconssetchg

SCIP_CONSSETCHG* SCIP_Cons::addconssetchg

constraint change that added constraint to current subproblem, or NULL if constraint is from global problem

Definition at line 45 of file struct_cons.h.

Referenced by conssetchgDelAddedCons(), SCIPconsDelete(), SCIPconsIsInProb(), SCIPconsSetChecked(), SCIPconssetchgAddAddedCons(), SCIPconssetchgApply(), SCIPconssetchgUndo(), SCIPdelCons(), SCIPdelConsLocal(), SCIPprobAddCons(), and SCIPprobDelCons().

◆ addarraypos

int SCIP_Cons::addarraypos

◆ consspos

int SCIP_Cons::consspos

position of constraint in the handler's conss array

Definition at line 48 of file struct_cons.h.

Referenced by conshdlrActivateCons(), conshdlrAddCons(), conshdlrDeactivateCons(), conshdlrDelCons(), and SCIPconsGetPos().

◆ initconsspos

int SCIP_Cons::initconsspos

position of constraint in the handler's initconss array

Definition at line 49 of file struct_cons.h.

Referenced by conshdlrActivateCons(), conshdlrAddInitcons(), conshdlrDeactivateCons(), conshdlrDelInitcons(), SCIPconshdlrInitLP(), SCIPconshdlrInitpre(), and SCIPconsSetInitial().

◆ sepaconsspos

◆ enfoconsspos

int SCIP_Cons::enfoconsspos

◆ checkconsspos

int SCIP_Cons::checkconsspos

position of constraint in the handler's checkconss array

Definition at line 52 of file struct_cons.h.

Referenced by conshdlrActivateCons(), conshdlrAddCheckcons(), conshdlrDeactivateCons(), conshdlrDelCheckcons(), conshdlrMarkConsObsolete(), and conshdlrMarkConsUseful().

◆ propconsspos

◆ nlockspos

int SCIP_Cons::nlockspos[NLOCKTYPES]

◆ nlocksneg

int SCIP_Cons::nlocksneg[NLOCKTYPES]

array of times, the constraint locked vars for the constraint's negation

Definition at line 55 of file struct_cons.h.

Referenced by SCIPconsAddLocks(), SCIPconsGetNLocksNeg(), SCIPconsGetNLocksTypeNeg(), SCIPconsIsLocked(), SCIPconsIsLockedNeg(), SCIPconsIsLockedType(), and SCIPconsIsLockedTypeNeg().

◆ activedepth

int SCIP_Cons::activedepth

depth level of constraint activation (-2: inactive, -1: problem constraint)

Definition at line 56 of file struct_cons.h.

Referenced by conshdlrActivateCons(), conshdlrDeactivateCons(), conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsDeactivate(), and SCIPconsGetActiveDepth().

◆ validdepth

int SCIP_Cons::validdepth

depth level where constraint is valid (-1: equals activedepth)

Definition at line 57 of file struct_cons.h.

Referenced by SCIPaddConsNode(), SCIPconsGetValidDepth(), SCIPconsSetLocal(), and SCIPnodeAddCons().

◆ nuses

int SCIP_Cons::nuses

number of times, this constraint is referenced

Definition at line 58 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsCapture(), and SCIPconsGetNUses().

◆ initial

unsigned int SCIP_Cons::initial

TRUE iff LP relaxation of constraint should be in initial LP, if possible

Definition at line 59 of file struct_cons.h.

Referenced by conshdlrActivateCons(), conshdlrAddInitcons(), SCIPconshdlrInitpre(), SCIPconsIsInitial(), SCIPconsSetInitial(), and SCIPconsTransform().

◆ separate

◆ enforce

unsigned int SCIP_Cons::enforce

◆ check

unsigned int SCIP_Cons::check

◆ propagate

◆ sepaenabled

◆ propenabled

◆ local

unsigned int SCIP_Cons::local

TRUE iff constraint is only valid locally

Definition at line 66 of file struct_cons.h.

Referenced by SCIPconsGetValidDepth(), SCIPconsIsGlobal(), SCIPconsIsLocal(), SCIPconsSetLocal(), and SCIPconsTransform().

◆ modifiable

unsigned int SCIP_Cons::modifiable

TRUE iff constraint is modifiable (subject to column generation)

Definition at line 67 of file struct_cons.h.

Referenced by SCIPconsIsModifiable(), SCIPconsSetModifiable(), and SCIPconsTransform().

◆ dynamic

unsigned int SCIP_Cons::dynamic

TRUE iff constraint is subject to aging

Definition at line 68 of file struct_cons.h.

Referenced by consExceedsAgelimit(), consExceedsObsoleteage(), SCIPconsIsDynamic(), SCIPconsSetDynamic(), and SCIPconsTransform().

◆ removable

unsigned int SCIP_Cons::removable

TRUE iff relaxation should be removed from the LP due to aging or cleanup

Definition at line 69 of file struct_cons.h.

Referenced by SCIPconsIsRemovable(), SCIPconsSetRemovable(), and SCIPconsTransform().

◆ stickingatnode

unsigned int SCIP_Cons::stickingatnode

TRUE iff the node should always be kept at the node where it was added

Definition at line 70 of file struct_cons.h.

Referenced by COLORcreateConsStoreGraph(), SCIPconsIsStickingAtNode(), SCIPconsSetStickingAtNode(), and SCIPconsTransform().

◆ original

◆ deleteconsdata

unsigned int SCIP_Cons::deleteconsdata

TRUE iff constraint data has to be deleted if constraint is freed

Definition at line 72 of file struct_cons.h.

◆ active

unsigned int SCIP_Cons::active

TRUE iff constraint is active in the current node; a constraint is active if it is global and was not removed during presolving or it was added locally (in that case the local flag is TRUE) and the current node belongs to the corresponding sub tree

Definition at line 73 of file struct_cons.h.

Referenced by conshdlrActivateCons(), conshdlrAddCheckcons(), conshdlrAddCons(), conshdlrAddEnfocons(), conshdlrAddInitcons(), conshdlrAddPropcons(), conshdlrAddSepacons(), conshdlrDeactivateCons(), conshdlrDelCheckcons(), conshdlrDelCons(), conshdlrDisableCons(), conshdlrEnableCons(), conshdlrMarkConsObsolete(), conshdlrMarkConsUseful(), conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsDeactivate(), SCIPconsDelete(), SCIPconsDisable(), SCIPconsEnable(), SCIPconsIsActive(), SCIPconsSetChecked(), SCIPconssetchgApply(), SCIPconssetchgUndo(), and SCIPprobDelCons().

◆ conflict

unsigned int SCIP_Cons::conflict

TRUE iff constraint is a conflict

Definition at line 78 of file struct_cons.h.

Referenced by SCIPconsIsConflict(), and SCIPconsMarkConflict().

◆ enabled

◆ obsolete

◆ markpropagate

unsigned int SCIP_Cons::markpropagate

◆ deleted

unsigned int SCIP_Cons::deleted

◆ update

◆ updateinsert

unsigned int SCIP_Cons::updateinsert

TRUE iff constraint has to be inserted in the conss array

Definition at line 84 of file struct_cons.h.

Referenced by conshdlrProcessUpdates().

◆ updateactivate

unsigned int SCIP_Cons::updateactivate

TRUE iff constraint has to be activated in update phase

Definition at line 85 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsAddAge(), SCIPconsDeactivate(), SCIPconsDelete(), SCIPconsDisable(), SCIPconsEnable(), SCIPconsIsActive(), and SCIPconsResetAge().

◆ updatedeactivate

unsigned int SCIP_Cons::updatedeactivate

TRUE iff constraint has to be deactivated in update phase

Definition at line 86 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsDeactivate(), SCIPconsDelete(), SCIPconsEnable(), SCIPconsIsActive(), SCIPconsIsUpdatedeactivate(), and SCIPprobDelCons().

◆ updateenable

unsigned int SCIP_Cons::updateenable

TRUE iff constraint has to be enabled in update phase

Definition at line 87 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsDisable(), SCIPconsEnable(), and SCIPconsIsEnabled().

◆ updatedisable

unsigned int SCIP_Cons::updatedisable

TRUE iff constraint has to be disabled in update phase

Definition at line 88 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsDisable(), SCIPconsEnable(), SCIPconsIsEnabled(), and SCIPnodeDelCons().

◆ updatesepaenable

unsigned int SCIP_Cons::updatesepaenable

TRUE iff constraint's separation has to be enabled in update phase

Definition at line 89 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsDisableSeparation(), SCIPconsEnableSeparation(), and SCIPconsIsSeparationEnabled().

◆ updatesepadisable

unsigned int SCIP_Cons::updatesepadisable

TRUE iff constraint's separation has to be disabled in update phase

Definition at line 90 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsDisableSeparation(), SCIPconsEnableSeparation(), and SCIPconsIsSeparationEnabled().

◆ updatepropenable

unsigned int SCIP_Cons::updatepropenable

TRUE iff constraint's propagation has to be enabled in update phase

Definition at line 91 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsDisablePropagation(), SCIPconsEnablePropagation(), and SCIPconsIsPropagationEnabled().

◆ updatepropdisable

unsigned int SCIP_Cons::updatepropdisable

TRUE iff constraint's propagation has to be disabled in update phase

Definition at line 92 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsDisablePropagation(), SCIPconsEnablePropagation(), and SCIPconsIsPropagationEnabled().

◆ updateobsolete

unsigned int SCIP_Cons::updateobsolete

TRUE iff obsolete status of constraint has to be updated in update phase

Definition at line 93 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsActivate(), SCIPconsAddAge(), SCIPconsIsObsolete(), and SCIPconsResetAge().

◆ updatefree

unsigned int SCIP_Cons::updatefree

TRUE iff constraint has to be freed in update phase

Definition at line 94 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), and SCIPconsActivate().

◆ updateactfocus

unsigned int SCIP_Cons::updateactfocus

TRUE iff delayed constraint activation happened at focus node

Definition at line 95 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), and SCIPconsActivate().

◆ updatemarkpropagate

unsigned int SCIP_Cons::updatemarkpropagate

TRUE iff constraint has to be marked to be propagated in update phase

Definition at line 96 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsIsMarkedPropagate(), SCIPconsMarkPropagate(), and SCIPconsUnmarkPropagate().

◆ updateunmarkpropagate

unsigned int SCIP_Cons::updateunmarkpropagate

TRUE iff constraint has to be unmarked to be propagated in update phase

Definition at line 97 of file struct_cons.h.

Referenced by conshdlrProcessUpdates(), SCIPconsIsMarkedPropagate(), SCIPconsMarkPropagate(), and SCIPconsUnmarkPropagate().

◆ nupgradelocks

unsigned int SCIP_Cons::nupgradelocks

number of times, a constraint is locked against an upgrade (e.g. linear -> logicor), 0 means a constraint can be upgraded

Definition at line 98 of file struct_cons.h.

Referenced by SCIPconsAddUpgradeLocks(), SCIPconsGetNUpgradeLocks(), and SCIPconsTransform().

◆ scip