Detailed Description

C++ wrapper for the Benders' decomposition cut plugins.

Author: Stephen J. Maher

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

Functions
static	SCIP_DECL_BENDERSCUTCOPY (benderscutCopyObj)

static	SCIP_DECL_BENDERSCUTFREE (benderscutFreeObj)

static	SCIP_DECL_BENDERSCUTINIT (benderscutInitObj)

static	SCIP_DECL_BENDERSCUTEXIT (benderscutExitObj)

static	SCIP_DECL_BENDERSCUTINITSOL (benderscutInitsolObj)

static	SCIP_DECL_BENDERSCUTEXITSOL (benderscutExitsolObj)

static	SCIP_DECL_BENDERSCUTEXEC (benderscutExecObj)

SCIP_RETCODE	SCIPincludeObjBenderscut (SCIP scip, scip::ObjBenders objbenders, scip::ObjBenderscut *objbenderscut, SCIP_Bool deleteobject)

scip::ObjBenderscut *	SCIPfindObjBenderscut (scip::ObjBenders objbenders, const char name)

scip::ObjBenderscut *	SCIPgetObjBenderscut (SCIP scip, SCIP_BENDERSCUT benderscut)

Function Documentation

◆ SCIP_DECL_BENDERSCUTCOPY()

static SCIP_DECL_BENDERSCUTCOPY ( benderscutCopyObj )

static

copy method for Benders' decomposition cuts (called when SCIP copies plugins)

Definition at line 62 of file objbenderscut.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPbenderscutGetData(), SCIPgetObjBenders(), SCIPincludeObjBenderscut(), and TRUE.

◆ SCIP_DECL_BENDERSCUTFREE()

static SCIP_DECL_BENDERSCUTFREE ( benderscutFreeObj )

static

destructor of Benders' decomposition cut to free user data (called when SCIP is exiting)

Definition at line 87 of file objbenderscut.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPbenderscutGetData(), and SCIPbenderscutSetData().

◆ SCIP_DECL_BENDERSCUTINIT()

static SCIP_DECL_BENDERSCUTINIT ( benderscutInitObj )

static

initialization method of Benders' decomposition cut (called after problem was transformed)

Definition at line 113 of file objbenderscut.cpp.

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

◆ SCIP_DECL_BENDERSCUTEXIT()

static SCIP_DECL_BENDERSCUTEXIT ( benderscutExitObj )

static

deinitialization method of Benders' decomposition cut (called before transformed problem is freed)

Definition at line 131 of file objbenderscut.cpp.

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

◆ SCIP_DECL_BENDERSCUTINITSOL()

static SCIP_DECL_BENDERSCUTINITSOL ( benderscutInitsolObj )

static

solving process initialization method of Benders' decomposition cut (called when branch and bound process is about to begin)

Definition at line 148 of file objbenderscut.cpp.

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

◆ SCIP_DECL_BENDERSCUTEXITSOL()

static SCIP_DECL_BENDERSCUTEXITSOL ( benderscutExitsolObj )

static

solving process deinitialization method of Benders' decomposition cut (called before branch and bound process data is freed)

Definition at line 165 of file objbenderscut.cpp.

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

◆ SCIP_DECL_BENDERSCUTEXEC()

static SCIP_DECL_BENDERSCUTEXEC ( benderscutExecObj )

static

execution method of the Benders' decomposition cuts

Definition at line 182 of file objbenderscut.cpp.

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

◆ SCIPincludeObjBenderscut()

SCIP_RETCODE SCIPincludeObjBenderscut	(	SCIP *	scip,
		scip::ObjBenders *	objbenders,
		scip::ObjBenderscut *	objbenderscut,
		SCIP_Bool	deleteobject
	)

creates the Benders' decomposition cut for the given Benders' decomposition cut object and includes it in SCIP

Parameters

scip	SCIP data structure
objbenders	Benders' decomposition object
objbenderscut	Benders' decomposition cut object
deleteobject	should the Benders' decomposition cut object be deleted when benderscut is freed?

Definition at line 205 of file objbenderscut.cpp.

References NULL, scip::ObjBenderscut::scip_, SCIP_CALL, scip::ObjBenderscut::scip_desc_, scip::ObjBenderscut::scip_islpcut_, scip::ObjBenders::scip_name_, scip::ObjBenderscut::scip_name_, SCIP_OKAY, scip::ObjBenderscut::scip_priority_, SCIPfindBenders(), and SCIPincludeBenderscut().