objrelax.cpp File Reference

Detailed Description

C++ wrapper for relaxation handlers.

Author

Tobias Achterberg

Definition in file objrelax.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_RELAXCOPY (relaxCopyObj)
static	SCIP_DECL_RELAXFREE (relaxFreeObj)
static	SCIP_DECL_RELAXINIT (relaxInitObj)
static	SCIP_DECL_RELAXEXIT (relaxExitObj)
static	SCIP_DECL_RELAXINITSOL (relaxInitsolObj)
static	SCIP_DECL_RELAXEXITSOL (relaxExitsolObj)
static	SCIP_DECL_RELAXEXEC (relaxExecObj)
SCIP_RETCODE	SCIPincludeObjRelax (SCIP *scip, scip::ObjRelax *objrelax, SCIP_Bool deleteobject)
scip::ObjRelax *	SCIPfindObjRelax (SCIP *scip, const char *name)
scip::ObjRelax *	SCIPgetObjRelax (SCIP *scip, SCIP_RELAX *relax)

Function Documentation

SCIP_DECL_RELAXCOPY()

SCIP_DECL_RELAXCOPY ( relaxCopyObj )

static

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

Definition at line 62 of file objrelax.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeObjRelax(), SCIPrelaxGetData(), and TRUE.

SCIP_DECL_RELAXFREE()

SCIP_DECL_RELAXFREE ( relaxFreeObj )

static

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

Definition at line 87 of file objrelax.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPrelaxGetData(), and SCIPrelaxSetData().

SCIP_DECL_RELAXINIT()

SCIP_DECL_RELAXINIT ( relaxInitObj )

static

initialization method of relaxator (called after problem was transformed)

Definition at line 113 of file objrelax.cpp.

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

SCIP_DECL_RELAXEXIT()

SCIP_DECL_RELAXEXIT ( relaxExitObj )

static

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

Definition at line 131 of file objrelax.cpp.

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

SCIP_DECL_RELAXINITSOL()

SCIP_DECL_RELAXINITSOL ( relaxInitsolObj )

static

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

Definition at line 148 of file objrelax.cpp.

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

SCIP_DECL_RELAXEXITSOL()

SCIP_DECL_RELAXEXITSOL ( relaxExitsolObj )

static

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

Definition at line 165 of file objrelax.cpp.

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

SCIP_DECL_RELAXEXEC()

SCIP_DECL_RELAXEXEC ( relaxExecObj )

static

execution method of relaxator

Definition at line 182 of file objrelax.cpp.

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

SCIPincludeObjRelax()

SCIP_RETCODE SCIPincludeObjRelax	(	SCIP *	scip,
		scip::ObjRelax *	objrelax,
		SCIP_Bool	deleteobject )

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

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

Parameters

scip	SCIP data structure
objrelax	relaxator object
deleteobject	should the relaxator object be deleted when relaxator is freed?

Definition at line 204 of file objrelax.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjRelax::scip_desc_, scip::ObjRelax::scip_freq_, scip::ObjRelax::scip_name_, SCIP_OKAY, scip::ObjRelax::scip_priority_, and SCIPincludeRelax().

Referenced by SCIP_DECL_RELAXCOPY().

SCIPfindObjRelax()

scip::ObjRelax * SCIPfindObjRelax	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of relaxator

Definition at line 231 of file objrelax.cpp.

References assert(), NULL, SCIPfindRelax(), and SCIPrelaxGetData().

SCIPgetObjRelax()

scip::ObjRelax * SCIPgetObjRelax	(	SCIP *	scip,
		SCIP_RELAX *	relax )

returns the relax object for the given relaxator

Parameters

scip	SCIP data structure
relax	relaxator

Definition at line 250 of file objrelax.cpp.

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