tsp::ProbDataTSP Class Reference

Detailed Description

SCIP user problem data for TSP

Definition at line 33 of file ProbDataTSP.h.

#include <ProbDataTSP.h>

Collaboration diagram for tsp::ProbDataTSP:

Public Member Functions
	ProbDataTSP (GRAPH *g)
virtual	~ProbDataTSP ()
virtual SCIP_RETCODE	scip_copy (SCIP *scip, SCIP *sourcescip, SCIP_HASHMAP *varmap, SCIP_HASHMAP *consmap, ObjProbData **objprobdata, SCIP_Bool global, SCIP_RESULT *result)
virtual SCIP_RETCODE	scip_delorig (SCIP *scip)
virtual SCIP_RETCODE	scip_deltrans (SCIP *scip)
virtual SCIP_RETCODE	scip_trans (SCIP *scip, ObjProbData **objprobdata, SCIP_Bool *deleteobject)
GRAPH *	getGraph ()

Constructor & Destructor Documentation

tsp::ProbDataTSP::ProbDataTSP ( GRAPH *  g )

inline

default constructor

Parameters

g	graph data

Definition at line 40 of file ProbDataTSP.h.

References capture_graph().

virtual tsp::ProbDataTSP::~ProbDataTSP ( )

inlinevirtual

destructor

Definition at line 49 of file ProbDataTSP.h.

References release_graph(), scip_copy(), scip_delorig(), scip_deltrans(), and scip_trans().

Member Function Documentation

GRAPH* tsp::ProbDataTSP::getGraph ( )

inline

Definition at line 111 of file ProbDataTSP.h.

Referenced by SCIP_DECL_CONSCOPY(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEURINIT(), and SCIP_DECL_HEURINITSOL().

SCIP_RETCODE ProbDataTSP::scip_copy ( SCIP *  scip, SCIP *  sourcescip, SCIP_HASHMAP *  varmap, SCIP_HASHMAP *  consmap, ObjProbData **  objprobdata, SCIP_Bool  global, SCIP_RESULT *  result  )

virtual

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

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

Parameters

scip	SCIP data structure
sourcescip	source SCIP main data structure
varmap	a hashmap which stores the mapping of source variables to corresponding target variables
consmap	a hashmap which stores the mapping of source contraints to corresponding target constraints
objprobdata	pointer to store the copied problem data object
global	create a global or a local copy?
result	pointer to store the result of the call

Definition at line 116 of file ProbDataTSP.cpp.

References copy_graph(), Graph::edges, Graph::nedges, release_graph(), and GraphEdge::var.

Referenced by ~ProbDataTSP().

SCIP_RETCODE ProbDataTSP::scip_delorig ( SCIP *  scip )

virtual

destructor of user problem data to free original user data (called when original problem is freed)

If the "deleteobject" flag in the SCIPcreateObjProb() method was set to TRUE, this method is not needed, because all the work to delete the user problem data can be done in the destructor of the user problem data object. If the "deleteobject" flag was set to FALSE, and the user problem data object stays alive after the SCIP problem is freed, this method should delete all the problem specific data that is no longer needed.

Parameters

scip	SCIP data structure

Definition at line 180 of file ProbDataTSP.cpp.

References release_graph().

Referenced by ~ProbDataTSP().

SCIP_RETCODE ProbDataTSP::scip_deltrans ( SCIP *  scip )

virtual

destructor of user problem data to free transformed user data (called when transformed problem is freed)

If the "*deleteobject" flag in the scip_trans() method was set to TRUE, this method is not needed, because all the work to delete the user problem data can be done in the destructor of the user problem data object. If the "*deleteobject" flag was set to FALSE, and the user problem data object stays alive after the SCIP problem is freed, this method should delete all the problem specific data that is no longer needed.

destructor of user problem data to free original user data (called when original problem is freed)

If the "deleteobject" flag in the SCIPcreateObjProb() method was set to TRUE, this method is not needed, because all the work to delete the user problem data can be done in the destructor of the user problem data object. If the "deleteobject" flag was set to FALSE, and the user problem data object stays alive after the SCIP problem is freed, this method should delete all the problem specific data that is no longer needed.

Parameters

scip	SCIP data structure

Definition at line 201 of file ProbDataTSP.cpp.

References release_graph().

Referenced by ~ProbDataTSP().

SCIP_RETCODE ProbDataTSP::scip_trans ( SCIP *  scip, ObjProbData **  objprobdata, SCIP_Bool *  deleteobject  )

virtual

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

The user has two possibilities to implement this method:

1. Return the pointer to the original problem data object (this) as pointer to the transformed problem data object. The user may modify some internal attributes, but he has to make sure, that these modifications are reversed in the scip_deltrans() method, such that the original problem data is restored. In this case, he should set *deleteobject to FALSE, because the problem data must not be destructed by SCIP after the solving process is terminated.
2. Call the copy constructor of the problem data object and return the created copy as transformed problem data object. In this case, he probably wants to set *deleteobject to TRUE, thus letting SCIP call the destructor of the object if the transformed problem data is no longer needed.

Parameters

scip	SCIP data structure
objprobdata	pointer to store the transformed problem data object
deleteobject	pointer to store whether SCIP should delete the object after solving

Definition at line 227 of file ProbDataTSP.cpp.

References copy_graph(), Graph::edges, Graph::nedges, release_graph(), and GraphEdge::var.

Referenced by ~ProbDataTSP().