Scippy

SCIP

Solving Constraint Integer Programs

objprop.cpp File Reference

Detailed Description

C++ wrapper for propagators.

Author
Tobias Achterberg

Definition in file objprop.cpp.

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

Go to the source code of this file.

Functions

static SCIP_DECL_PROPCOPY (propCopyObj)
 
static SCIP_DECL_PROPFREE (propFreeObj)
 
static SCIP_DECL_PROPINIT (propInitObj)
 
static SCIP_DECL_PROPEXIT (propExitObj)
 
static SCIP_DECL_PROPINITPRE (propInitpreObj)
 
static SCIP_DECL_PROPEXITPRE (propExitpreObj)
 
static SCIP_DECL_PROPINITSOL (propInitsolObj)
 
static SCIP_DECL_PROPEXITSOL (propExitsolObj)
 
static SCIP_DECL_PROPPRESOL (propPresolObj)
 
static SCIP_DECL_PROPEXEC (propExecObj)
 
static SCIP_DECL_PROPRESPROP (propRespropObj)
 
SCIP_RETCODE SCIPincludeObjProp (SCIP *scip, scip::ObjProp *objprop, SCIP_Bool deleteobject)
 
scip::ObjPropSCIPfindObjProp (SCIP *scip, const char *name)
 
scip::ObjPropSCIPgetObjProp (SCIP *scip, SCIP_PROP *prop)
 

Function Documentation

◆ SCIP_DECL_PROPCOPY()

static SCIP_DECL_PROPCOPY ( propCopyObj  )
static

copy method for propagator plugins (called when SCIP copies plugins)

Definition at line 53 of file objprop.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeObjProp(), SCIPpropGetData(), and TRUE.

◆ SCIP_DECL_PROPFREE()

static SCIP_DECL_PROPFREE ( propFreeObj  )
static

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

Definition at line 78 of file objprop.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPpropGetData(), and SCIPpropSetData().

◆ SCIP_DECL_PROPINIT()

static SCIP_DECL_PROPINIT ( propInitObj  )
static

initialization method of propagator (called after problem was transformed)

Definition at line 104 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXIT()

static SCIP_DECL_PROPEXIT ( propExitObj  )
static

deinitialization method of propagator (called before transformed problem is freed)

Definition at line 122 of file objprop.cpp.

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

◆ SCIP_DECL_PROPINITPRE()

static SCIP_DECL_PROPINITPRE ( propInitpreObj  )
static

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

Definition at line 139 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXITPRE()

static SCIP_DECL_PROPEXITPRE ( propExitpreObj  )
static

presolving deinitialization method of propagator (called after presolving has been finished)

Definition at line 156 of file objprop.cpp.

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

◆ SCIP_DECL_PROPINITSOL()

static SCIP_DECL_PROPINITSOL ( propInitsolObj  )
static

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

Definition at line 173 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXITSOL()

static SCIP_DECL_PROPEXITSOL ( propExitsolObj  )
static

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

Definition at line 190 of file objprop.cpp.

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

◆ SCIP_DECL_PROPPRESOL()

static SCIP_DECL_PROPPRESOL ( propPresolObj  )
static

presolving method of propagator

Definition at line 207 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXEC()

static SCIP_DECL_PROPEXEC ( propExecObj  )
static

execution method of propagator

Definition at line 228 of file objprop.cpp.

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

◆ SCIP_DECL_PROPRESPROP()

static SCIP_DECL_PROPRESPROP ( propRespropObj  )
static

propagation conflict resolving method of propagator

Definition at line 245 of file objprop.cpp.

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

◆ SCIPincludeObjProp()

SCIP_RETCODE SCIPincludeObjProp ( SCIP scip,
scip::ObjProp objprop,
SCIP_Bool  deleteobject 
)

creates the propagator for the given propagator object and includes it in SCIP

Parameters
scipSCIP data structure
objproppropagator object
deleteobjectshould the propagator object be deleted when propagator is freed?

Definition at line 267 of file objprop.cpp.

References NULL, SCIP_CALL, scip::ObjProp::scip_delay_, scip::ObjProp::scip_desc_, scip::ObjProp::scip_freq_, scip::ObjProp::scip_name_, SCIP_OKAY, scip::ObjProp::scip_presol_maxrounds_, scip::ObjProp::scip_presol_priority_, scip::ObjProp::scip_presol_timing_, scip::ObjProp::scip_priority_, scip::ObjProp::scip_timingmask_, and SCIPincludeProp().

Referenced by SCIP_DECL_PROPCOPY(), and scip::ObjProp::SCIP_DECL_PROPRESPROP().

◆ SCIPfindObjProp()

scip::ObjProp* SCIPfindObjProp ( SCIP scip,
const char *  name 
)

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

Parameters
scipSCIP data structure
namename of propagator

Definition at line 295 of file objprop.cpp.

References NULL, SCIPfindProp(), and SCIPpropGetData().

Referenced by scip::ObjProp::SCIP_DECL_PROPRESPROP().

◆ SCIPgetObjProp()

scip::ObjProp* SCIPgetObjProp ( SCIP scip,
SCIP_PROP prop 
)

returns the prop object for the given propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 314 of file objprop.cpp.

References NULL, and SCIPpropGetData().

Referenced by scip::ObjProp::SCIP_DECL_PROPRESPROP().