objcutsel.cpp File Reference

Detailed Description

C++ wrapper for cut selectors.

Author

Felipe Serrano

Mark Turner

Definition in file objcutsel.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_CUTSELCOPY (cutselCopyObj)
static	SCIP_DECL_CUTSELFREE (cutselFreeObj)
static	SCIP_DECL_CUTSELINIT (cutselInitObj)
static	SCIP_DECL_CUTSELEXIT (cutselExitObj)
static	SCIP_DECL_CUTSELINITSOL (cutselInitsolObj)
static	SCIP_DECL_CUTSELEXITSOL (cutselExitsolObj)
static	SCIP_DECL_CUTSELSELECT (cutselSelectObj)
SCIP_RETCODE	SCIPincludeObjCutsel (SCIP *scip, scip::ObjCutsel *objcutsel, SCIP_Bool deleteobject)
scip::ObjCutsel *	SCIPfindObjCutsel (SCIP *scip, const char *name)
scip::ObjCutsel *	SCIPgetObjCutsel (SCIP *scip, SCIP_CUTSEL *cutsel)

Function Documentation

SCIP_DECL_CUTSELCOPY()

SCIP_DECL_CUTSELCOPY ( cutselCopyObj )

static

copy method for cut selector plugins (called when SCIP copies plugins)

Definition at line 63 of file objcutsel.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPcutselGetData(), SCIPincludeObjCutsel(), and TRUE.

SCIP_DECL_CUTSELFREE()

SCIP_DECL_CUTSELFREE ( cutselFreeObj )

static

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

Definition at line 88 of file objcutsel.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPcutselGetData(), and SCIPcutselSetData().

SCIP_DECL_CUTSELINIT()

SCIP_DECL_CUTSELINIT ( cutselInitObj )

static

initialization method of cut selector (called after problem was transformed)

Definition at line 114 of file objcutsel.cpp.

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

SCIP_DECL_CUTSELEXIT()

SCIP_DECL_CUTSELEXIT ( cutselExitObj )

static

deinitialization method of cut selector (called before transformed problem is freed)

Definition at line 132 of file objcutsel.cpp.

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

SCIP_DECL_CUTSELINITSOL()

SCIP_DECL_CUTSELINITSOL ( cutselInitsolObj )

static

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

Definition at line 149 of file objcutsel.cpp.

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

SCIP_DECL_CUTSELEXITSOL()

SCIP_DECL_CUTSELEXITSOL ( cutselExitsolObj )

static

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

Definition at line 166 of file objcutsel.cpp.

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

SCIP_DECL_CUTSELSELECT()

SCIP_DECL_CUTSELSELECT ( cutselSelectObj )

static

cut selection method of cut selector

Definition at line 183 of file objcutsel.cpp.

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

SCIPincludeObjCutsel()

SCIP_RETCODE SCIPincludeObjCutsel	(	SCIP *	scip,
		scip::ObjCutsel *	objcutsel,
		SCIP_Bool	deleteobject )

creates the cut selector for the given cut selector object and includes it in SCIP

creates the cut selector for the given cut selector object and includes it in SCIP

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

1. The user is responsible for deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyCutsel* mycutsel = new MyCutsel(...); SCIP_CALL( SCIPincludeObjCutsel(scip, &mycutsel, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mycutsel; // delete cutsel AFTER SCIPfree() !
2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjCutsel(scip, new MyCutsel(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyCutsel is called here

Parameters

scip	SCIP data structure
objcutsel	cut selector object
deleteobject	should the cut selector object be deleted when cut selector is freed?

Definition at line 206 of file objcutsel.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjCutsel::scip_desc_, scip::ObjCutsel::scip_name_, SCIP_OKAY, scip::ObjCutsel::scip_priority_, and SCIPincludeCutsel().

Referenced by SCIP_DECL_CUTSELCOPY().

SCIPfindObjCutsel()

scip::ObjCutsel * SCIPfindObjCutsel	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of cut selector

Definition at line 234 of file objcutsel.cpp.

References assert(), NULL, SCIPcutselGetData(), and SCIPfindCutsel().

SCIPgetObjCutsel()

scip::ObjCutsel * SCIPgetObjCutsel	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel )

returns the cutsel object for the given cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector

Definition at line 253 of file objcutsel.cpp.

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