objprobdata.cpp File Reference

Detailed Description

C++ wrapper for user problem data.

Author

Tobias Achterberg

Definition in file objprobdata.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_PROBDELORIG (probDelorigObj)
static	SCIP_DECL_PROBTRANS (probTransObj)
static	SCIP_DECL_PROBDELTRANS (probDeltransObj)
static	SCIP_DECL_PROBINITSOL (probInitsolObj)
static	SCIP_DECL_PROBEXITSOL (probExitsolObj)
static	SCIP_DECL_PROBCOPY (probCopyObj)
SCIP_RETCODE	SCIPcreateObjProb (SCIP *scip, const char *name, scip::ObjProbData *objprobdata, SCIP_Bool deleteobject)
scip::ObjProbData *	SCIPgetObjProbData (SCIP *scip)

Function Documentation

SCIP_DECL_PROBDELORIG()

SCIP_DECL_PROBDELORIG ( probDelorigObj )

static

frees user data of original problem (called when the original problem is freed)

Definition at line 62 of file objprobdata.cpp.

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

SCIP_DECL_PROBTRANS()

SCIP_DECL_PROBTRANS ( probTransObj )

static

creates user data of transformed problem by transforming the original user problem data (called after problem was transformed)

Definition at line 87 of file objprobdata.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_PROBTRANS, and SCIP_OKAY.

SCIP_DECL_PROBDELTRANS()

SCIP_DECL_PROBDELTRANS ( probDeltransObj )

static

frees user data of transformed problem (called when the transformed problem is freed)

Definition at line 111 of file objprobdata.cpp.

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

SCIP_DECL_PROBINITSOL()

SCIP_DECL_PROBINITSOL ( probInitsolObj )

static

solving process initialization method of transformed data (called before the branch and bound process begins)

Definition at line 134 of file objprobdata.cpp.

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

SCIP_DECL_PROBEXITSOL()

SCIP_DECL_PROBEXITSOL ( probExitsolObj )

static

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

Definition at line 148 of file objprobdata.cpp.

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

SCIP_DECL_PROBCOPY()

SCIP_DECL_PROBCOPY ( probCopyObj )

static

copies user data if you want to copy it to a subscip

Definition at line 161 of file objprobdata.cpp.

References assert(), NULL, result, SCIP_CALL, SCIP_DECL_PROBCOPY, SCIP_DIDNOTRUN, SCIP_OKAY, SCIP_SUCCESS, and TRUE.

SCIPcreateObjProb()

SCIP_RETCODE SCIPcreateObjProb	(	SCIP *	scip,
		const char *	name,
		scip::ObjProbData *	objprobdata,
		SCIP_Bool	deleteobject )

creates empty problem, initializes all solving data structures, and sets the user problem data to point to the given user data object

creates empty problem, initializes all solving data structures, and sets the user problem data to point to the given user data object

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

1. The user is responsible of deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyProbData* myprobdata = new MyProbData(...); SCIP_CALL( SCIPcreateObjProb(scip, "probname", &myprobdata, FALSE) ); ... // solve the problem SCIP_CALL( SCIPfreeProb(scip) ); delete myprobdata; // delete probdata AFTER SCIPfreeProb() ! ... SCIP_CALL( SCIPfree(&scip) );
2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfreeProb() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPcreateObjProb(scip, "probname", new MyProbData(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // problem is freed and destructor of MyProbData is called here

Parameters

scip	SCIP data structure
name	problem name
objprobdata	user problem data object
deleteobject	should the user problem data object be deleted when problem is freed?

Definition at line 202 of file objprobdata.cpp.

References SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPcreateObjProb(), and SCIPcreateProb().

Referenced by SCIP_DECL_READERREAD(), and SCIPcreateObjProb().

SCIPgetObjProbData()

scip::ObjProbData * SCIPgetObjProbData

(

SCIP *

scip

)

gets user problem data object Warning! This method should only be called after a problem was created with SCIPcreateObjProb(). Otherwise, a segmentation fault may arise, or an undefined pointer is returned.

Parameters

scip	SCIP data structure

Definition at line 227 of file objprobdata.cpp.

References assert(), NULL, SCIPgetObjProbData(), and SCIPgetProbData().

Referenced by tsp::ProbDataTSP::scip_copy(), SCIP_DECL_CONSCOPY(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEURINIT(), SCIP_DECL_HEURINIT(), SCIP_DECL_HEURINITSOL(), and SCIPgetObjProbData().