objsepa.cpp File Reference

Detailed Description

C++ wrapper for cut separators.

Author

Tobias Achterberg

Definition in file objsepa.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_SEPACOPY (sepaCopyObj)
static	SCIP_DECL_SEPAFREE (sepaFreeObj)
static	SCIP_DECL_SEPAINIT (sepaInitObj)
static	SCIP_DECL_SEPAEXIT (sepaExitObj)
static	SCIP_DECL_SEPAINITSOL (sepaInitsolObj)
static	SCIP_DECL_SEPAEXITSOL (sepaExitsolObj)
static	SCIP_DECL_SEPAEXECLP (sepaExeclpObj)
static	SCIP_DECL_SEPAEXECSOL (sepaExecsolObj)
SCIP_RETCODE	SCIPincludeObjSepa (SCIP *scip, scip::ObjSepa *objsepa, SCIP_Bool deleteobject)
scip::ObjSepa *	SCIPfindObjSepa (SCIP *scip, const char *name)
scip::ObjSepa *	SCIPgetObjSepa (SCIP *scip, SCIP_SEPA *sepa)

Function Documentation

SCIP_DECL_SEPACOPY()

SCIP_DECL_SEPACOPY ( sepaCopyObj )

static

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

Definition at line 61 of file objsepa.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeObjSepa(), SCIPsepaGetData(), sepadata, and TRUE.

SCIP_DECL_SEPAFREE()

SCIP_DECL_SEPAFREE ( sepaFreeObj )

static

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

Definition at line 86 of file objsepa.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPsepaGetData(), SCIPsepaSetData(), and sepadata.

SCIP_DECL_SEPAINIT()

SCIP_DECL_SEPAINIT ( sepaInitObj )

static

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

Definition at line 112 of file objsepa.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPsepaGetData(), and sepadata.

SCIP_DECL_SEPAEXIT()

SCIP_DECL_SEPAEXIT ( sepaExitObj )

static

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

Definition at line 130 of file objsepa.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPsepaGetData(), and sepadata.

SCIP_DECL_SEPAINITSOL()

SCIP_DECL_SEPAINITSOL ( sepaInitsolObj )

static

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

Definition at line 147 of file objsepa.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPsepaGetData(), and sepadata.

SCIP_DECL_SEPAEXITSOL()

SCIP_DECL_SEPAEXITSOL ( sepaExitsolObj )

static

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

Definition at line 164 of file objsepa.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPsepaGetData(), and sepadata.

SCIP_DECL_SEPAEXECLP()

SCIP_DECL_SEPAEXECLP ( sepaExeclpObj )

static

LP solution separation method of separator

Definition at line 181 of file objsepa.cpp.

References assert(), depth, NULL, result, SCIP_CALL, SCIP_OKAY, SCIPsepaGetData(), and sepadata.

SCIP_DECL_SEPAEXECSOL()

SCIP_DECL_SEPAEXECSOL ( sepaExecsolObj )

static

arbitrary primal solution separation method of separator

Definition at line 198 of file objsepa.cpp.

References assert(), depth, NULL, result, SCIP_CALL, SCIP_OKAY, SCIPsepaGetData(), sepadata, and sol.

SCIPincludeObjSepa()

SCIP_RETCODE SCIPincludeObjSepa	(	SCIP *	scip,
		scip::ObjSepa *	objsepa,
		SCIP_Bool	deleteobject )

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

creates the cut separator for the given cut separator 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) ); ... MySepa* mysepa = new MySepa(...); SCIP_CALL( SCIPincludeObjSepa(scip, &mysepa, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mysepa; // delete sepa AFTER SCIPfree() !
2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjSepa(scip, new MySepa(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MySepa is called here

Parameters

scip	SCIP data structure
objsepa	cut separator object
deleteobject	should the cut separator object be deleted when cut separator is freed?

Definition at line 220 of file objsepa.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjSepa::scip_delay_, scip::ObjSepa::scip_desc_, scip::ObjSepa::scip_freq_, scip::ObjSepa::scip_maxbounddist_, scip::ObjSepa::scip_name_, SCIP_OKAY, scip::ObjSepa::scip_priority_, scip::ObjSepa::scip_usessubscip_, SCIPincludeSepa(), and sepadata.

Referenced by SCIP_DECL_SEPACOPY().

SCIPfindObjSepa()

scip::ObjSepa * SCIPfindObjSepa	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of cut separator

Definition at line 247 of file objsepa.cpp.

References assert(), NULL, SCIPfindSepa(), SCIPsepaGetData(), and sepadata.

SCIPgetObjSepa()

scip::ObjSepa * SCIPgetObjSepa	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

returns the sepa object for the given cut separator

Parameters

scip	SCIP data structure
sepa	cut separator

Definition at line 266 of file objsepa.cpp.

References assert(), NULL, SCIPsepaGetData(), and sepadata.