vbc.c File Reference

Detailed Description

methods for VBC Tool output

Author

Tobias Achterberg

Definition in file vbc.c.

#include <stdio.h>
#include <assert.h>
#include "blockmemshell/memory.h"
#include "scip/set.h"
#include "scip/stat.h"
#include "scip/clock.h"
#include "scip/var.h"
#include "scip/tree.h"
#include "scip/vbc.h"
#include "scip/struct_vbc.h"

Go to the source code of this file.

Functions
static void	getBranchInfo (SCIP_NODE *node, SCIP_VAR **var, SCIP_BOUNDTYPE *boundtype, SCIP_Real *bound)
SCIP_RETCODE	SCIPvbcCreate (SCIP_VBC **vbc, SCIP_MESSAGEHDLR *messagehdlr)
void	SCIPvbcFree (SCIP_VBC **vbc)
SCIP_RETCODE	SCIPvbcInit (SCIP_VBC *vbc, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
void	SCIPvbcExit (SCIP_VBC *vbc, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
static void	printTime (SCIP_VBC *vbc, SCIP_STAT *stat)
SCIP_RETCODE	SCIPvbcNewChild (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node)
SCIP_RETCODE	SCIPvbcUpdateChild (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node)
static void	vbcSetColor (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node, SCIP_VBCCOLOR color)
void	SCIPvbcSolvedNode (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node)
void	SCIPvbcCutoffNode (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node)
void	SCIPvbcFoundConflict (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node)
void	SCIPvbcMarkedRepropagateNode (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node)
void	SCIPvbcRepropagatedNode (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_NODE *node)
void	SCIPvbcFoundSolution (SCIP_VBC *vbc, SCIP_SET *set, SCIP_STAT *stat, SCIP_NODE *node)
void	SCIPvbcLowerbound (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_Real lowerbound)
void	SCIPvbcUpperbound (SCIP_VBC *vbc, SCIP_STAT *stat, SCIP_Real upperbound)

Function Documentation

static void getBranchInfo ( SCIP_NODE *  node, SCIP_VAR **  var, SCIP_BOUNDTYPE *  boundtype, SCIP_Real *  bound  )

static

returns the branching variable of the node, or NULL

Parameters

node	node
var	pointer to store the branching variable
boundtype	pointer to store the branching type: lower or upper bound
bound	pointer to store the new bound of the branching variable

Definition at line 38 of file vbc.c.

References SCIP_DomChgBound::boundchgs, SCIP_BoundChg::boundtype, SCIP_Node::domchg, SCIP_DomChg::domchgbound, SCIP_DomChgBound::nboundchgs, SCIP_BoundChg::newbound, NULL, SCIP_BOUNDTYPE_LOWER, and SCIP_BoundChg::var.

Referenced by SCIPvbcCutoffNode(), SCIPvbcNewChild(), SCIPvbcSolvedNode(), and SCIPvbcUpdateChild().

SCIP_RETCODE SCIPvbcCreate	(	SCIP_VBC **	vbc,
		SCIP_MESSAGEHDLR *	messagehdlr
	)

creates VBC Tool data structure

Parameters

vbc	pointer to store the VBC information
messagehdlr	message handler

Definition at line 65 of file vbc.c.

References BMSallocMemory, FALSE, SCIP_Vbc::messagehdlr, NULL, SCIP_ALLOC, SCIP_OKAY, and SCIP_VBCCOLOR_NONE.

Referenced by SCIPstatCreate().

void SCIPvbcFree

(

SCIP_VBC **

vbc

)

frees VBC Tool data structure

Parameters

vbc	pointer to store the VBC information

Definition at line 84 of file vbc.c.

References BMSfreeMemory, and NULL.

Referenced by SCIPstatFree().

SCIP_RETCODE SCIPvbcInit	(	SCIP_VBC *	vbc,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr
	)

initializes VBC information and creates a file for VBC output

Parameters

vbc	VBC information
blkmem	block memory
set	global SCIP settings
messagehdlr	message handler

Definition at line 97 of file vbc.c.

References SCIP_Vbc::file, SCIP_Vbc::lastcolor, SCIP_Vbc::lastnode, SCIP_Vbc::messagehdlr, SCIP_Vbc::nodenum, NULL, SCIP_CALL, SCIP_FILECREATEERROR, SCIP_HASHSIZE_VBC, SCIP_OKAY, SCIP_VBCCOLOR_NONE, SCIP_VERBLEVEL_NORMAL, SCIPerrorMessage, SCIPhashmapCreate(), SCIPmessageFPrintInfo(), SCIPmessagePrintVerbInfo(), SCIPprintSysError(), SCIP_Vbc::timestep, and SCIP_Vbc::userealtime.

Referenced by initSolve().

void SCIPvbcExit	(	SCIP_VBC *	vbc,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr
	)

closes the VBC output file

Parameters

vbc	VBC information
set	global SCIP settings
messagehdlr	message handler

Definition at line 138 of file vbc.c.

References SCIP_Vbc::file, SCIP_Vbc::nodenum, NULL, SCIP_VERBLEVEL_FULL, SCIPhashmapFree(), and SCIPmessagePrintVerbInfo().

Referenced by freeSolve().

static void printTime ( SCIP_VBC *  vbc, SCIP_STAT *  stat  )

static

prints current solution time to VBC output file

Parameters

vbc	VBC information
stat	problem statistics

Definition at line 160 of file vbc.c.

References SCIP_Vbc::file, SCIP_Vbc::messagehdlr, NULL, SCIP_Longint, SCIPclockGetTime(), SCIPmessageFPrintInfo(), SCIP_Stat::solvingtime, SCIP_Vbc::timestep, and SCIP_Vbc::userealtime.

Referenced by SCIPvbcCutoffNode(), SCIPvbcLowerbound(), SCIPvbcNewChild(), SCIPvbcSolvedNode(), SCIPvbcUpdateChild(), SCIPvbcUpperbound(), and vbcSetColor().

SCIP_RETCODE SCIPvbcNewChild	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

creates a new node entry in the VBC output file

Parameters

vbc	VBC information
stat	problem statistics
node	new node, that was created

Definition at line 197 of file vbc.c.

References SCIP_Vbc::file, getBranchInfo(), SCIP_Vbc::messagehdlr, SCIP_Stat::ncreatednodesrun, SCIP_Vbc::nodenum, NULL, SCIP_Node::parent, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_CALL, SCIP_INVALIDDATA, SCIP_Longint, SCIP_NODETYPE_PROBINGNODE, SCIP_OKAY, SCIP_Real, SCIP_VBCCOLOR_UNSOLVED, SCIPerrorMessage, SCIPhashmapGetImage(), SCIPhashmapInsert(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPvarGetLbLocal(), SCIPvarGetName(), and SCIPvarGetUbLocal().

Referenced by SCIPnodeCreateChild().

SCIP_RETCODE SCIPvbcUpdateChild	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

updates a node entry in the VBC output file

Parameters

vbc	VBC information
stat	problem statistics
node	new node, that was created

Definition at line 259 of file vbc.c.

References SCIP_Vbc::file, getBranchInfo(), SCIP_Vbc::messagehdlr, SCIP_Vbc::nodenum, NULL, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_NODETYPE_PROBINGNODE, SCIP_OKAY, SCIP_Real, SCIPhashmapGetImage(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPvarGetLbLocal(), SCIPvarGetName(), and SCIPvarGetUbLocal().

Referenced by SCIPtreeBranchVar(), SCIPtreeBranchVarHole(), and SCIPtreeBranchVarNary().

static void vbcSetColor ( SCIP_VBC *  vbc, SCIP_STAT *  stat, SCIP_NODE *  node, SCIP_VBCCOLOR  color  )

static

changes the color of the node to the given color

Parameters

vbc	VBC information
stat	problem statistics
node	node to change color for
color	new color of node, or SCIP_VBCCOLOR_NONE

Definition at line 308 of file vbc.c.

References SCIP_Vbc::file, SCIP_Vbc::lastcolor, SCIP_Vbc::lastnode, SCIP_Vbc::messagehdlr, SCIP_Vbc::nodenum, NULL, printTime(), SCIP_VBCCOLOR_NONE, SCIPhashmapGetImage(), and SCIPmessageFPrintInfo().

Referenced by SCIPvbcCutoffNode(), SCIPvbcFoundConflict(), SCIPvbcFoundSolution(), SCIPvbcMarkedRepropagateNode(), SCIPvbcRepropagatedNode(), and SCIPvbcSolvedNode().

void SCIPvbcSolvedNode	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

changes the color of the node to the color of solved nodes

Parameters

vbc	VBC information
stat	problem statistics
node	node, that was solved

Definition at line 332 of file vbc.c.

References SCIP_Vbc::file, getBranchInfo(), SCIP_Vbc::messagehdlr, SCIP_Stat::nnodes, SCIP_Vbc::nodenum, NULL, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_NODETYPE_PROBINGNODE, SCIP_Real, SCIP_VBCCOLOR_SOLVED, SCIPhashmapGetImage(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPvarGetLbLocal(), SCIPvarGetName(), SCIPvarGetUbLocal(), and vbcSetColor().

Referenced by SCIPsolveCIP().

void SCIPvbcCutoffNode	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

changes the color of the node to the color of cutoff nodes

Parameters

vbc	VBC information
stat	problem statistics
node	node, that was cut off

Definition at line 381 of file vbc.c.

References SCIP_Vbc::file, getBranchInfo(), SCIP_Vbc::messagehdlr, SCIP_Stat::nnodes, SCIP_Vbc::nodenum, NULL, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_NODETYPE_PROBINGNODE, SCIP_Real, SCIP_VBCCOLOR_CUTOFF, SCIPhashmapGetImage(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPvarGetLbLocal(), SCIPvarGetName(), SCIPvarGetUbLocal(), and vbcSetColor().

Referenced by nodeToLeaf(), SCIPnodeCutoff(), SCIPnodepqBound(), SCIPsolveCIP(), and SCIPtreeCutoff().

void SCIPvbcFoundConflict	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

changes the color of the node to the color of nodes where a conflict constraint was found

Parameters

vbc	VBC information
stat	problem statistics
node	node, where the conflict was found

Definition at line 430 of file vbc.c.

References NULL, SCIP_NODETYPE_PROBINGNODE, SCIP_VBCCOLOR_CONFLICT, SCIPnodeGetType(), and vbcSetColor().

Referenced by SCIPconflictFlushConss().

void SCIPvbcMarkedRepropagateNode	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

changes the color of the node to the color of nodes that were marked to be repropagated

Parameters

vbc	VBC information
stat	problem statistics
node	node, that was marked to be repropagated

Definition at line 446 of file vbc.c.

References NULL, SCIP_NODETYPE_PROBINGNODE, SCIP_VBCCOLOR_MARKREPROP, SCIPnodeGetNumber(), SCIPnodeGetType(), and vbcSetColor().

Referenced by SCIPnodePropagateAgain().

void SCIPvbcRepropagatedNode	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

changes the color of the node to the color of repropagated nodes

Parameters

vbc	VBC information
stat	problem statistics
node	node, that was repropagated

Definition at line 465 of file vbc.c.

References NULL, SCIP_NODETYPE_PROBINGNODE, SCIP_VBCCOLOR_REPROP, SCIPnodeGetType(), and vbcSetColor().

Referenced by nodeRepropagate().

void SCIPvbcFoundSolution	(	SCIP_VBC *	vbc,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_NODE *	node
	)

changes the color of the node to the color of nodes with a primal solution

Parameters

vbc	VBC information
set	global SCIP settings
stat	problem statistics
node	node where the solution was found, or NULL

Definition at line 481 of file vbc.c.

References NULL, SCIP_NODETYPE_PROBINGNODE, SCIP_VBCCOLOR_SOLUTION, SCIPnodeGetType(), and vbcSetColor().

Referenced by primalAddSol().

void SCIPvbcLowerbound	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_Real	lowerbound
	)

outputs a new global lower bound to the VBC output file

Parameters

vbc	VBC information
stat	problem statistics
lowerbound	new lower bound

Definition at line 499 of file vbc.c.

References SCIP_Vbc::file, SCIP_Vbc::messagehdlr, NULL, printTime(), and SCIPmessageFPrintInfo().

void SCIPvbcUpperbound	(	SCIP_VBC *	vbc,
		SCIP_STAT *	stat,
		SCIP_Real	upperbound
	)

outputs a new global upper bound to the VBC output file

Parameters

vbc	VBC information
stat	problem statistics
upperbound	new upper bound

Definition at line 516 of file vbc.c.

References SCIP_Vbc::file, SCIP_Vbc::messagehdlr, NULL, printTime(), and SCIPmessageFPrintInfo().

Referenced by primalSetUpperbound().