Detailed Description

C++ wrapper for the Benders' decomposition plugins.

Author: Stephen J. Maher

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

Functions
static	SCIP_DECL_BENDERSCOPY (bendersCopyObj)
static	SCIP_DECL_BENDERSFREE (bendersFreeObj)
static	SCIP_DECL_BENDERSINIT (bendersInitObj)
static	SCIP_DECL_BENDERSEXIT (bendersExitObj)
static	SCIP_DECL_BENDERSINITPRE (bendersInitpreObj)
static	SCIP_DECL_BENDERSEXITPRE (bendersExitpreObj)
static	SCIP_DECL_BENDERSINITSOL (bendersInitsolObj)
static	SCIP_DECL_BENDERSEXITSOL (bendersExitsolObj)
static	SCIP_DECL_BENDERSCREATESUB (bendersCreatesubObj)
static	SCIP_DECL_BENDERSPRESUBSOLVE (bendersPresubsolveObj)
static	SCIP_DECL_BENDERSSOLVESUBCONVEX (bendersSolvesubconvexObj)
static	SCIP_DECL_BENDERSSOLVESUB (bendersSolvesubObj)
static	SCIP_DECL_BENDERSPOSTSOLVE (bendersPostsolveObj)
static	SCIP_DECL_BENDERSFREESUB (bendersFreesubObj)
static	SCIP_DECL_BENDERSGETVAR (bendersGetvarObj)
SCIP_RETCODE	SCIPincludeObjBenders (SCIP scip, scip::ObjBenders objbenders, SCIP_Bool deleteobject)
scip::ObjBenders *	SCIPfindObjBenders (SCIP scip, const char name)
scip::ObjBenders *	SCIPgetObjBenders (SCIP scip, SCIP_BENDERS benders)

Function Documentation

◆ SCIP_DECL_BENDERSCOPY()

SCIP_DECL_BENDERSCOPY ( bendersCopyObj )

static

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

Definition at line 62 of file objbenders.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPbendersGetData(), SCIPincludeObjBenders(), and TRUE.

◆ SCIP_DECL_BENDERSFREE()

SCIP_DECL_BENDERSFREE ( bendersFreeObj )

static

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

Definition at line 87 of file objbenders.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPbendersGetData(), and SCIPbendersSetData().

◆ SCIP_DECL_BENDERSINIT()

SCIP_DECL_BENDERSINIT ( bendersInitObj )

static

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

Definition at line 113 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSEXIT()

SCIP_DECL_BENDERSEXIT ( bendersExitObj )

static

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

Definition at line 131 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSINITPRE()

SCIP_DECL_BENDERSINITPRE ( bendersInitpreObj )

static

presolving initialization method of Benders' decomposition (called when presolving is about to begin)

Definition at line 148 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSEXITPRE()

SCIP_DECL_BENDERSEXITPRE ( bendersExitpreObj )

static

presolving deinitialization method of Benders' decomposition (called after presolving has been finished)

Definition at line 165 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSINITSOL()

SCIP_DECL_BENDERSINITSOL ( bendersInitsolObj )

static

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

Definition at line 182 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSEXITSOL()

SCIP_DECL_BENDERSEXITSOL ( bendersExitsolObj )

static

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

Definition at line 199 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSCREATESUB()

SCIP_DECL_BENDERSCREATESUB ( bendersCreatesubObj )

static

method that is called to create the subproblem and register it with the Benders' decomposition structure.

Definition at line 216 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSPRESUBSOLVE()

SCIP_DECL_BENDERSPRESUBSOLVE ( bendersPresubsolveObj )

static

methods called prior to solving the subproblems

Definition at line 233 of file objbenders.cpp.

References assert(), NULL, result, SCIP_CALL, SCIP_OKAY, SCIPbendersGetData(), and sol.

◆ SCIP_DECL_BENDERSSOLVESUBCONVEX()

SCIP_DECL_BENDERSSOLVESUBCONVEX ( bendersSolvesubconvexObj )

static

method called to solve the convex relaxation of an individual subproblem of the Benders' decomposition

Definition at line 251 of file objbenders.cpp.

References assert(), NULL, result, SCIP_CALL, SCIP_OKAY, SCIPbendersGetData(), and sol.

◆ SCIP_DECL_BENDERSSOLVESUB()

SCIP_DECL_BENDERSSOLVESUB ( bendersSolvesubObj )

static

method called to solve an individual subproblem of the Benders' decomposition

Definition at line 269 of file objbenders.cpp.

References assert(), NULL, result, SCIP_CALL, SCIP_OKAY, SCIPbendersGetData(), and sol.

◆ SCIP_DECL_BENDERSPOSTSOLVE()

SCIP_DECL_BENDERSPOSTSOLVE ( bendersPostsolveObj )

static

method called after the subproblems are solved in the Benders' decomposition algorithm

Definition at line 286 of file objbenders.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPbendersGetData(), and sol.

◆ SCIP_DECL_BENDERSFREESUB()

SCIP_DECL_BENDERSFREESUB ( bendersFreesubObj )

static

frees an individual subproblem. Called in each iteration of the Benders' decomposition algorithm

Definition at line 304 of file objbenders.cpp.

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

◆ SCIP_DECL_BENDERSGETVAR()

SCIP_DECL_BENDERSGETVAR ( bendersGetvarObj )

static

callback method to retrieve the master (subproblem) variable corresponding to the input subproblem (master) variable

Definition at line 321 of file objbenders.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPbendersGetData(), and var.

◆ SCIPincludeObjBenders()

SCIP_RETCODE SCIPincludeObjBenders	(	SCIP *	scip,
		scip::ObjBenders *	objbenders,
		SCIP_Bool	deleteobject )

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

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

The user is responsible of deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyBenders* mybenders = new MyBenders(...); SCIP_CALL( SCIPincludeObjBenders(scip, &mybenders, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mybenders; // delete benders AFTER SCIPfree() !
The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjBenders(scip, new MyBenders(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyBenders is called here

Parameters

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

Definition at line 344 of file objbenders.cpp.

References assert(), NULL, scip::ObjBenders::scip_, SCIP_Bool, SCIP_CALL, scip::ObjBenders::scip_cutlp_, scip::ObjBenders::scip_cutpseudo_, scip::ObjBenders::scip_cutrelax_, scip::ObjBenders::scip_desc_, scip::ObjBenders::scip_name_, SCIP_OKAY, scip::ObjBenders::scip_priority_, scip::ObjBenders::scip_shareauxvars_, and SCIPincludeBenders().

Referenced by SCIP_DECL_BENDERSCOPY().

◆ SCIPfindObjBenders()

scip::ObjBenders * SCIPfindObjBenders	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of Benders' decomposition

Definition at line 373 of file objbenders.cpp.

References assert(), NULL, SCIPbendersGetData(), and SCIPfindBenders().

◆ SCIPgetObjBenders()

scip::ObjBenders * SCIPgetObjBenders	(	SCIP *	scip,
		SCIP_BENDERS *	benders )

returns the benders object for the given Benders' decomposition

returns the benders object for the given constraint handler

Parameters

scip	SCIP data structure
benders	Benders' decomposition

Definition at line 392 of file objbenders.cpp.

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

Referenced by SCIP_DECL_BENDERSCUTCOPY().

Detailed Description

Functions

Function Documentation

◆ SCIP_DECL_BENDERSCOPY()

◆ SCIP_DECL_BENDERSFREE()

◆ SCIP_DECL_BENDERSINIT()

◆ SCIP_DECL_BENDERSEXIT()

◆ SCIP_DECL_BENDERSINITPRE()

◆ SCIP_DECL_BENDERSEXITPRE()

◆ SCIP_DECL_BENDERSINITSOL()

◆ SCIP_DECL_BENDERSEXITSOL()

◆ SCIP_DECL_BENDERSCREATESUB()

◆ SCIP_DECL_BENDERSPRESUBSOLVE()

◆ SCIP_DECL_BENDERSSOLVESUBCONVEX()

◆ SCIP_DECL_BENDERSSOLVESUB()

◆ SCIP_DECL_BENDERSPOSTSOLVE()

◆ SCIP_DECL_BENDERSFREESUB()

◆ SCIP_DECL_BENDERSGETVAR()

◆ SCIPincludeObjBenders()

◆ SCIPfindObjBenders()

◆ SCIPgetObjBenders()