objbranchrule.cpp File Reference

Detailed Description

C++ wrapper for branching rules.

Author

Tobias Achterberg

Definition in file objbranchrule.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_BRANCHCOPY (branchCopyObj)
static	SCIP_DECL_BRANCHFREE (branchFreeObj)
static	SCIP_DECL_BRANCHINIT (branchInitObj)
static	SCIP_DECL_BRANCHEXIT (branchExitObj)
static	SCIP_DECL_BRANCHINITSOL (branchInitsolObj)
static	SCIP_DECL_BRANCHEXITSOL (branchExitsolObj)
static	SCIP_DECL_BRANCHEXECLP (branchExeclpObj)
static	SCIP_DECL_BRANCHEXECEXT (branchExecextObj)
static	SCIP_DECL_BRANCHEXECPS (branchExecpsObj)
SCIP_RETCODE	SCIPincludeObjBranchrule (SCIP *scip, scip::ObjBranchrule *objbranchrule, SCIP_Bool deleteobject)
scip::ObjBranchrule *	SCIPfindObjBranchrule (SCIP *scip, const char *name)
scip::ObjBranchrule *	SCIPgetObjBranchrule (SCIP *scip, SCIP_BRANCHRULE *branchrule)

Function Documentation

SCIP_DECL_BRANCHCOPY()

static SCIP_DECL_BRANCHCOPY ( branchCopyObj  )

static

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

Definition at line 62 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPbranchruleGetData(), SCIPincludeObjBranchrule(), and TRUE.

SCIP_DECL_BRANCHFREE()

static SCIP_DECL_BRANCHFREE ( branchFreeObj  )

static

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

Definition at line 87 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPbranchruleGetData(), and SCIPbranchruleSetData().

SCIP_DECL_BRANCHINIT()

static SCIP_DECL_BRANCHINIT ( branchInitObj  )

static

initialization method of branching rule (called after problem was transformed)

Definition at line 113 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPbranchruleGetData().

SCIP_DECL_BRANCHEXIT()

static SCIP_DECL_BRANCHEXIT ( branchExitObj  )

static

deinitialization method of branching rule (called before transformed problem is freed)

Definition at line 131 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPbranchruleGetData().

SCIP_DECL_BRANCHINITSOL()

static SCIP_DECL_BRANCHINITSOL ( branchInitsolObj  )

static

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

Definition at line 148 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPbranchruleGetData().

SCIP_DECL_BRANCHEXITSOL()

static SCIP_DECL_BRANCHEXITSOL ( branchExitsolObj  )

static

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

Definition at line 165 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPbranchruleGetData().

SCIP_DECL_BRANCHEXECLP()

static SCIP_DECL_BRANCHEXECLP ( branchExeclpObj  )

static

branching execution method for fractional LP solutions

Definition at line 182 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPbranchruleGetData().

SCIP_DECL_BRANCHEXECEXT()

static SCIP_DECL_BRANCHEXECEXT ( branchExecextObj  )

static

branching execution method for external candidates

Definition at line 199 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPbranchruleGetData().

SCIP_DECL_BRANCHEXECPS()

static SCIP_DECL_BRANCHEXECPS ( branchExecpsObj  )

static

branching execution method for not completely fixed pseudo solutions

Definition at line 216 of file objbranchrule.cpp.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPbranchruleGetData().

SCIPincludeObjBranchrule()

SCIP_RETCODE SCIPincludeObjBranchrule	(	SCIP *	scip,
		scip::ObjBranchrule *	objbranchrule,
		SCIP_Bool	deleteobject
	)

creates the branching rule for the given branching rule object and includes it in SCIP

Parameters

scip	SCIP data structure
objbranchrule	branching rule object
deleteobject	should the branching rule object be deleted when branching rule is freed?

Definition at line 238 of file objbranchrule.cpp.

References NULL, SCIP_CALL, scip::ObjBranchrule::scip_desc_, scip::ObjBranchrule::scip_maxbounddist_, scip::ObjBranchrule::scip_maxdepth_, scip::ObjBranchrule::scip_name_, SCIP_OKAY, scip::ObjBranchrule::scip_priority_, and SCIPincludeBranchrule().

Referenced by SCIP_DECL_BRANCHCOPY(), and scip::ObjBranchrule::SCIP_DECL_BRANCHEXECPS().

SCIPfindObjBranchrule()

scip::ObjBranchrule* SCIPfindObjBranchrule	(	SCIP *	scip,
		const char *	name
	)

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

Parameters

scip	SCIP data structure
name	name of branching rule

Definition at line 267 of file objbranchrule.cpp.

References NULL, SCIPbranchruleGetData(), and SCIPfindBranchrule().

Referenced by scip::ObjBranchrule::SCIP_DECL_BRANCHEXECPS().

SCIPgetObjBranchrule()

scip::ObjBranchrule* SCIPgetObjBranchrule	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule
	)

returns the branchrule object for the given branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 286 of file objbranchrule.cpp.

References NULL, and SCIPbranchruleGetData().

Referenced by scip::ObjBranchrule::SCIP_DECL_BRANCHEXECPS().