objnodesel.cpp File Reference

Detailed Description

C++ wrapper for node selectors.

Author

Tobias Achterberg

Definition in file objnodesel.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_NODESELCOPY (nodeselCopyObj)
static	SCIP_DECL_NODESELFREE (nodeselFreeObj)
static	SCIP_DECL_NODESELINIT (nodeselInitObj)
static	SCIP_DECL_NODESELEXIT (nodeselExitObj)
static	SCIP_DECL_NODESELINITSOL (nodeselInitsolObj)
static	SCIP_DECL_NODESELEXITSOL (nodeselExitsolObj)
static	SCIP_DECL_NODESELSELECT (nodeselSelectObj)
static	SCIP_DECL_NODESELCOMP (nodeselCompObj)
SCIP_RETCODE	SCIPincludeObjNodesel (SCIP *scip, scip::ObjNodesel *objnodesel, SCIP_Bool deleteobject)
scip::ObjNodesel *	SCIPfindObjNodesel (SCIP *scip, const char *name)
scip::ObjNodesel *	SCIPgetObjNodesel (SCIP *scip, SCIP_NODESEL *nodesel)

Function Documentation

SCIP_DECL_NODESELCOPY()

SCIP_DECL_NODESELCOPY ( nodeselCopyObj )

static

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

Definition at line 62 of file objnodesel.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeObjNodesel(), SCIPnodeselGetData(), and TRUE.

SCIP_DECL_NODESELFREE()

SCIP_DECL_NODESELFREE ( nodeselFreeObj )

static

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

Definition at line 87 of file objnodesel.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPnodeselGetData(), and SCIPnodeselSetData().

SCIP_DECL_NODESELINIT()

SCIP_DECL_NODESELINIT ( nodeselInitObj )

static

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

Definition at line 113 of file objnodesel.cpp.

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

SCIP_DECL_NODESELEXIT()

SCIP_DECL_NODESELEXIT ( nodeselExitObj )

static

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

Definition at line 131 of file objnodesel.cpp.

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

SCIP_DECL_NODESELINITSOL()

SCIP_DECL_NODESELINITSOL ( nodeselInitsolObj )

static

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

Definition at line 148 of file objnodesel.cpp.

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

SCIP_DECL_NODESELEXITSOL()

SCIP_DECL_NODESELEXITSOL ( nodeselExitsolObj )

static

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

Definition at line 165 of file objnodesel.cpp.

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

SCIP_DECL_NODESELSELECT()

SCIP_DECL_NODESELSELECT ( nodeselSelectObj )

static

node selection method of node selector

Definition at line 182 of file objnodesel.cpp.

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

SCIP_DECL_NODESELCOMP()

SCIP_DECL_NODESELCOMP ( nodeselCompObj )

static

node comparison method of node selector

Definition at line 199 of file objnodesel.cpp.

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

SCIPincludeObjNodesel()

SCIP_RETCODE SCIPincludeObjNodesel	(	SCIP *	scip,
		scip::ObjNodesel *	objnodesel,
		SCIP_Bool	deleteobject )

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

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

Parameters

scip	SCIP data structure
objnodesel	node selector object
deleteobject	should the node selector object be deleted when node selector is freed?

Definition at line 219 of file objnodesel.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjNodesel::scip_desc_, scip::ObjNodesel::scip_memsavepriority_, scip::ObjNodesel::scip_name_, SCIP_OKAY, scip::ObjNodesel::scip_stdpriority_, and SCIPincludeNodesel().

Referenced by SCIP_DECL_NODESELCOPY().

SCIPfindObjNodesel()

scip::ObjNodesel * SCIPfindObjNodesel	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of node selector

Definition at line 247 of file objnodesel.cpp.

References assert(), NULL, SCIPfindNodesel(), and SCIPnodeselGetData().

SCIPgetObjNodesel()

scip::ObjNodesel * SCIPgetObjNodesel	(	SCIP *	scip,
		SCIP_NODESEL *	nodesel )

returns the nodesel object for the given node selector

Parameters

scip	SCIP data structure
nodesel	node selector

Definition at line 266 of file objnodesel.cpp.

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