Scippy

SCIP

Solving Constraint Integer Programs

objconshdlr.cpp File Reference

Detailed Description

C++ wrapper for constraint handlers.

Author
Tobias Achterberg

Definition in file objconshdlr.cpp.

#include <cassert>
#include "objconshdlr.h"

Go to the source code of this file.

Functions

static SCIP_DECL_CONSHDLRCOPY (conshdlrCopyObj)
 
static SCIP_DECL_CONSFREE (consFreeObj)
 
static SCIP_DECL_CONSINIT (consInitObj)
 
static SCIP_DECL_CONSEXIT (consExitObj)
 
static SCIP_DECL_CONSINITPRE (consInitpreObj)
 
static SCIP_DECL_CONSEXITPRE (consExitpreObj)
 
static SCIP_DECL_CONSINITSOL (consInitsolObj)
 
static SCIP_DECL_CONSEXITSOL (consExitsolObj)
 
static SCIP_DECL_CONSDELETE (consDeleteObj)
 
static SCIP_DECL_CONSTRANS (consTransObj)
 
static SCIP_DECL_CONSINITLP (consInitlpObj)
 
static SCIP_DECL_CONSSEPALP (consSepalpObj)
 
static SCIP_DECL_CONSSEPASOL (consSepasolObj)
 
static SCIP_DECL_CONSENFOLP (consEnfolpObj)
 
static SCIP_DECL_CONSENFORELAX (consEnforelaxObj)
 
static SCIP_DECL_CONSENFOPS (consEnfopsObj)
 
static SCIP_DECL_CONSCHECK (consCheckObj)
 
static SCIP_DECL_CONSPROP (consPropObj)
 
static SCIP_DECL_CONSPRESOL (consPresolObj)
 
static SCIP_DECL_CONSRESPROP (consRespropObj)
 
static SCIP_DECL_CONSLOCK (consLockObj)
 
static SCIP_DECL_CONSACTIVE (consActiveObj)
 
static SCIP_DECL_CONSDEACTIVE (consDeactiveObj)
 
static SCIP_DECL_CONSENABLE (consEnableObj)
 
static SCIP_DECL_CONSDISABLE (consDisableObj)
 
static SCIP_DECL_CONSDELVARS (consDelVarsObj)
 
static SCIP_DECL_CONSPRINT (consPrintObj)
 
static SCIP_DECL_CONSCOPY (consCopyObj)
 
static SCIP_DECL_CONSPARSE (consParseObj)
 
static SCIP_DECL_CONSGETVARS (consGetVarsObj)
 
static SCIP_DECL_CONSGETNVARS (consGetNVarsObj)
 
static SCIP_DECL_CONSGETDIVEBDCHGS (consGetDiveBdChgsObj)
 
static SCIP_DECL_CONSGETPERMSYMGRAPH (consGetPermsymGraph)
 
static SCIP_DECL_CONSGETSIGNEDPERMSYMGRAPH (consGetSignedPermsymGraph)
 
SCIP_RETCODE SCIPincludeObjConshdlr (SCIP *scip, scip::ObjConshdlr *objconshdlr, SCIP_Bool deleteobject)
 
scip::ObjConshdlrSCIPfindObjConshdlr (SCIP *scip, const char *name)
 
scip::ObjConshdlrSCIPgetObjConshdlr (SCIP *scip, SCIP_CONSHDLR *conshdlr)
 

Function Documentation

◆ SCIP_DECL_CONSHDLRCOPY()

static SCIP_DECL_CONSHDLRCOPY ( conshdlrCopyObj  )
static

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

Definition at line 62 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPconshdlrGetData(), SCIPincludeObjConshdlr(), and TRUE.

◆ SCIP_DECL_CONSFREE()

static SCIP_DECL_CONSFREE ( consFreeObj  )
static

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

Definition at line 87 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPconshdlrGetData(), and SCIPconshdlrSetData().

◆ SCIP_DECL_CONSINIT()

static SCIP_DECL_CONSINIT ( consInitObj  )
static

initialization method of constraint handler (called after problem was transformed)

Definition at line 113 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSEXIT()

static SCIP_DECL_CONSEXIT ( consExitObj  )
static

deinitialization method of constraint handler (called before transformed problem is freed)

Definition at line 131 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSINITPRE()

static SCIP_DECL_CONSINITPRE ( consInitpreObj  )
static

presolving initialization method of constraint handler (called when presolving is about to begin)

Definition at line 148 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSEXITPRE()

static SCIP_DECL_CONSEXITPRE ( consExitpreObj  )
static

presolving deinitialization method of constraint handler (called after presolving has been finished)

Definition at line 165 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSINITSOL()

static SCIP_DECL_CONSINITSOL ( consInitsolObj  )
static

solving process initialization method of constraint handler (called when branch and bound process is about to begin)

Definition at line 182 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSEXITSOL()

static SCIP_DECL_CONSEXITSOL ( consExitsolObj  )
static

solving process deinitialization method of constraint handler (called before branch and bound process data is freed)

Definition at line 199 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSDELETE()

static SCIP_DECL_CONSDELETE ( consDeleteObj  )
static

frees specific constraint data

Definition at line 216 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSTRANS()

static SCIP_DECL_CONSTRANS ( consTransObj  )
static

transforms constraint data into data belonging to the transformed problem

Definition at line 233 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSINITLP()

static SCIP_DECL_CONSINITLP ( consInitlpObj  )
static

LP initialization method of constraint handler

Definition at line 250 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSSEPALP()

static SCIP_DECL_CONSSEPALP ( consSepalpObj  )
static

separation method of constraint handler for LP solutions

Definition at line 267 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSSEPASOL()

static SCIP_DECL_CONSSEPASOL ( consSepasolObj  )
static

separation method of constraint handler for arbitrary primal solutions

Definition at line 284 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSENFOLP()

static SCIP_DECL_CONSENFOLP ( consEnfolpObj  )
static

constraint enforcing method of constraint handler for LP solutions

Definition at line 301 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSENFORELAX()

static SCIP_DECL_CONSENFORELAX ( consEnforelaxObj  )
static

constraint enforcing method of constraint handler for relaxation solutions

Definition at line 318 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSENFOPS()

static SCIP_DECL_CONSENFOPS ( consEnfopsObj  )
static

constraint enforcing method of constraint handler for pseudo solutions

Definition at line 335 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSCHECK()

static SCIP_DECL_CONSCHECK ( consCheckObj  )
static

feasibility check method of constraint handler for primal solutions

Definition at line 353 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSPROP()

static SCIP_DECL_CONSPROP ( consPropObj  )
static

domain propagation method of constraint handler

Definition at line 371 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSPRESOL()

static SCIP_DECL_CONSPRESOL ( consPresolObj  )
static

presolving method of constraint handler

Definition at line 388 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSRESPROP()

static SCIP_DECL_CONSRESPROP ( consRespropObj  )
static

propagation conflict resolving method of constraint handler

Definition at line 409 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSLOCK()

static SCIP_DECL_CONSLOCK ( consLockObj  )
static

variable rounding lock method of constraint handler

Definition at line 427 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSACTIVE()

static SCIP_DECL_CONSACTIVE ( consActiveObj  )
static

constraint activation notification method of constraint handler

Definition at line 444 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSDEACTIVE()

static SCIP_DECL_CONSDEACTIVE ( consDeactiveObj  )
static

constraint deactivation notification method of constraint handler

Definition at line 461 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSENABLE()

static SCIP_DECL_CONSENABLE ( consEnableObj  )
static

constraint enabling notification method of constraint handler

Definition at line 478 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSDISABLE()

static SCIP_DECL_CONSDISABLE ( consDisableObj  )
static

constraint disabling notification method of constraint handler

Definition at line 495 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSDELVARS()

static SCIP_DECL_CONSDELVARS ( consDelVarsObj  )
static

variable deletion method of constraint handler

Definition at line 511 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSPRINT()

static SCIP_DECL_CONSPRINT ( consPrintObj  )
static

constraint display method of constraint handler

Definition at line 527 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSCOPY()

static SCIP_DECL_CONSCOPY ( consCopyObj  )
static

constraint copying method of constraint handler

Definition at line 543 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSPARSE()

static SCIP_DECL_CONSPARSE ( consParseObj  )
static

constraint parsing method of constraint handler

Definition at line 560 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSGETVARS()

static SCIP_DECL_CONSGETVARS ( consGetVarsObj  )
static

constraint method of constraint handler which returns the variables (if possible)

Definition at line 577 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSGETNVARS()

static SCIP_DECL_CONSGETNVARS ( consGetNVarsObj  )
static

constraint method of constraint handler which returns the number of variables (if possible)

Definition at line 593 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSGETDIVEBDCHGS()

static SCIP_DECL_CONSGETDIVEBDCHGS ( consGetDiveBdChgsObj  )
static

constraint handler method to suggest dive bound changes during the generic diving algorithm

Definition at line 609 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSGETPERMSYMGRAPH()

static SCIP_DECL_CONSGETPERMSYMGRAPH ( consGetPermsymGraph  )
static

constraint handler method which returns the permutation symmetry detection graph of a constraint (if possible)

Definition at line 625 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIP_DECL_CONSGETSIGNEDPERMSYMGRAPH()

static SCIP_DECL_CONSGETSIGNEDPERMSYMGRAPH ( consGetSignedPermsymGraph  )
static

constraint handler method which returns the signed permutation symmetry detection graph of a constraint (if possible)

Definition at line 641 of file objconshdlr.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPconshdlrGetData().

◆ SCIPincludeObjConshdlr()

SCIP_RETCODE SCIPincludeObjConshdlr ( SCIP scip,
scip::ObjConshdlr objconshdlr,
SCIP_Bool  deleteobject 
)

◆ SCIPfindObjConshdlr()

scip::ObjConshdlr * SCIPfindObjConshdlr ( SCIP scip,
const char *  name 
)

returns the conshdlr object of the given name, or 0 if not existing

Parameters
scipSCIP data structure
namename of constraint handler

Definition at line 702 of file objconshdlr.cpp.

References NULL, SCIPconshdlrGetData(), and SCIPfindConshdlr().

◆ SCIPgetObjConshdlr()

scip::ObjConshdlr * SCIPgetObjConshdlr ( SCIP scip,
SCIP_CONSHDLR conshdlr 
)

returns the conshdlr object for the given constraint handler

Parameters
scipSCIP data structure
conshdlrconstraint handler

Definition at line 721 of file objconshdlr.cpp.

References NULL, and SCIPconshdlrGetData().