SCIP Doxygen Documentation
Loading...
Searching...
No Matches
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::ObjProp * SCIPfindObjProp (SCIP *scip, const char *name)
scip::ObjProp * SCIPgetObjProp (SCIP *scip, SCIP_PROP *prop)

Function Documentation

◆ SCIP_DECL_PROPCOPY()

SCIP_DECL_PROPCOPY ( propCopyObj )
static

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

Definition at line 62 of file objprop.cpp.

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

◆ SCIP_DECL_PROPFREE()

SCIP_DECL_PROPFREE ( propFreeObj )
static

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

Definition at line 87 of file objprop.cpp.

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

◆ SCIP_DECL_PROPINIT()

SCIP_DECL_PROPINIT ( propInitObj )
static

initialization method of propagator (called after problem was transformed)

Definition at line 113 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXIT()

SCIP_DECL_PROPEXIT ( propExitObj )
static

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

Definition at line 131 of file objprop.cpp.

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

◆ SCIP_DECL_PROPINITPRE()

SCIP_DECL_PROPINITPRE ( propInitpreObj )
static

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

Definition at line 148 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXITPRE()

SCIP_DECL_PROPEXITPRE ( propExitpreObj )
static

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

Definition at line 165 of file objprop.cpp.

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

◆ SCIP_DECL_PROPINITSOL()

SCIP_DECL_PROPINITSOL ( propInitsolObj )
static

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

Definition at line 182 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXITSOL()

SCIP_DECL_PROPEXITSOL ( propExitsolObj )
static

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

Definition at line 199 of file objprop.cpp.

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

◆ SCIP_DECL_PROPPRESOL()

SCIP_DECL_PROPPRESOL ( propPresolObj )
static

presolving method of propagator

Definition at line 216 of file objprop.cpp.

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

◆ SCIP_DECL_PROPEXEC()

SCIP_DECL_PROPEXEC ( propExecObj )
static

execution method of propagator

Definition at line 237 of file objprop.cpp.

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

◆ SCIP_DECL_PROPRESPROP()

SCIP_DECL_PROPRESPROP ( propRespropObj )
static

propagation conflict resolving method of propagator

Definition at line 254 of file objprop.cpp.

References assert(), NULL, result, 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

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

The method should be called in one of the following ways:

  1. The user is responsible of deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyProp* myprop = new MyProp(...); SCIP_CALL( SCIPincludeObjProp(scip, &myprop, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete myprop; // delete prop AFTER SCIPfree() !
  2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjProp(scip, new MyProp(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyProp is called here
Parameters
scipSCIP data structure
objproppropagator object
deleteobjectshould the propagator object be deleted when propagator is freed?

Definition at line 276 of file objprop.cpp.

References assert(), NULL, SCIP_Bool, 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().

◆ 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 304 of file objprop.cpp.

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

◆ 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 323 of file objprop.cpp.

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