Detailed Description
methods for creating output for visualization tools (VBC, BAK)
Definition in file visual.h.
#include "scip/def.h"
#include "scip/type_set.h"
#include "scip/type_sol.h"
#include "scip/type_stat.h"
#include "scip/type_tree.h"
#include "scip/type_visual.h"
Go to the source code of this file.
Function Documentation
◆ SCIPvisualCreate()
SCIP_EXPORT SCIP_RETCODE SCIPvisualCreate | ( | SCIP_VISUAL ** | visual, |
SCIP_MESSAGEHDLR * | messagehdlr | ||
) |
creates visualization data structure
- Parameters
-
visual pointer to store visualization information messagehdlr message handler
Definition at line 76 of file visual.c.
References BMSallocMemory, FALSE, SCIP_Visual::messagehdlr, NULL, SCIP_ALLOC, SCIP_INVALID, SCIP_OKAY, and SCIP_VBCCOLOR_NONE.
Referenced by SCIPstatCreate().
◆ SCIPvisualFree()
SCIP_EXPORT void SCIPvisualFree | ( | SCIP_VISUAL ** | visual | ) |
frees visualization data structure
- Parameters
-
visual pointer to store visualization information
Definition at line 97 of file visual.c.
References BMSfreeMemory, and NULL.
Referenced by SCIPstatFree().
◆ SCIPvisualInit()
SCIP_EXPORT SCIP_RETCODE SCIPvisualInit | ( | SCIP_VISUAL * | visual, |
BMS_BLKMEM * | blkmem, | ||
SCIP_SET * | set, | ||
SCIP_MESSAGEHDLR * | messagehdlr | ||
) |
initializes visualization information and creates a file for visualization output
- Parameters
-
visual visualization information blkmem block memory set global SCIP settings messagehdlr message handler
Definition at line 111 of file visual.c.
References SCIP_Visual::bakfile, SCIP_Visual::lastcolor, SCIP_Visual::lastlowerbound, SCIP_Visual::lastnode, SCIP_Visual::messagehdlr, SCIP_Visual::nodenum, NULL, SCIP_CALL, SCIP_FILECREATEERROR, SCIP_HASHSIZE_VBC, SCIP_OKAY, SCIP_VBCCOLOR_NONE, SCIP_VERBLEVEL_NORMAL, SCIPerrorMessage, SCIPhashmapCreate(), SCIPmessageFPrintInfo(), SCIPmessagePrintVerbInfo(), SCIPprintSysError(), SCIPsetInfinity(), SCIP_Visual::timestep, SCIP_Visual::userealtime, and SCIP_Visual::vbcfile.
Referenced by initSolve().
◆ SCIPvisualExit()
SCIP_EXPORT void SCIPvisualExit | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_MESSAGEHDLR * | messagehdlr | ||
) |
closes the visualization output file
- Parameters
-
visual visualization information set global SCIP settings messagehdlr message handler
Definition at line 180 of file visual.c.
References SCIP_Visual::bakfile, SCIP_Visual::nodenum, NULL, SCIP_VERBLEVEL_FULL, SCIPhashmapFree(), SCIPmessagePrintVerbInfo(), and SCIP_Visual::vbcfile.
Referenced by freeReoptSolve(), and freeSolve().
◆ SCIPvisualNewChild()
SCIP_EXPORT SCIP_RETCODE SCIPvisualNewChild | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_STAT * | stat, | ||
SCIP_NODE * | node | ||
) |
creates a new node entry in the visualization output file
- Parameters
-
visual visualization information set global SCIP settings stat problem statistics node new node, that was created
Definition at line 257 of file visual.c.
References SCIP_Visual::bakfile, getBranchInfo(), SCIP_Visual::messagehdlr, SCIP_Stat::ncreatednodesrun, SCIP_Visual::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, SCIPhashmapGetImageInt(), SCIPhashmapSetImageInt(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPretransformObj(), SCIPvarGetLbLocal(), SCIPvarGetName(), SCIPvarGetUbLocal(), TRUE, and SCIP_Visual::vbcfile.
Referenced by SCIPnodeCreateChild().
◆ SCIPvisualUpdateChild()
SCIP_RETCODE SCIPvisualUpdateChild | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_STAT * | stat, | ||
SCIP_NODE * | node | ||
) |
updates a node entry in the visualization output file
- Parameters
-
visual visualization information set global SCIP settings stat problem statistics node new node, that was created
Definition at line 332 of file visual.c.
References SCIP_Visual::bakfile, FALSE, getBranchInfo(), SCIP_Visual::messagehdlr, SCIP_Visual::nodenum, NULL, SCIP_Node::parent, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_CALL, SCIP_INVALIDDATA, SCIP_LPSOLSTAT_OPTIMAL, SCIP_NODETYPE_CHILD, SCIP_NODETYPE_FOCUSNODE, SCIP_NODETYPE_PROBINGNODE, SCIP_OKAY, SCIP_Real, SCIPerrorMessage, SCIPgetLPBranchCands(), SCIPgetLPSolstat(), SCIPhashmapGetImageInt(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPretransformObj(), SCIPvarGetLbLocal(), SCIPvarGetName(), SCIPvarGetUbLocal(), TRUE, and SCIP_Visual::vbcfile.
Referenced by SCIPtreeBranchVar(), SCIPtreeBranchVarHole(), and SCIPtreeBranchVarNary().
◆ SCIPvisualSolvedNode()
SCIP_EXPORT void SCIPvisualSolvedNode | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_STAT * | stat, | ||
SCIP_NODE * | node | ||
) |
marks node as solved in visualization output file
- Parameters
-
visual visualization information set global SCIP settings stat problem statistics node node, that was solved
Definition at line 464 of file visual.c.
References SCIP_Visual::bakfile, getBranchInfo(), SCIP_Visual::messagehdlr, SCIP_Stat::nnodes, SCIP_Visual::nodenum, NULL, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_NODETYPE_PROBINGNODE, SCIP_Real, SCIP_VBCCOLOR_SOLVED, SCIPhashmapGetImageInt(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPretransformObj(), SCIPvarGetLbLocal(), SCIPvarGetName(), SCIPvarGetUbLocal(), TRUE, SCIP_Visual::vbcfile, and vbcSetColor().
Referenced by SCIPsolveCIP().
◆ SCIPvisualCutoffNode()
SCIP_EXPORT void SCIPvisualCutoffNode | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_STAT * | stat, | ||
SCIP_NODE * | node, | ||
SCIP_Bool | infeasible | ||
) |
changes the color of the node to the color of cutoff nodes
- Parameters
-
visual visualization information set global SCIP settings stat problem statistics node node, that was cut off infeasible whether the node is infeasible (otherwise exceeded the cutoff bound)
Definition at line 524 of file visual.c.
References SCIP_Visual::bakfile, FALSE, getBranchInfo(), SCIP_Visual::messagehdlr, SCIP_Stat::nnodes, SCIP_Visual::nodenum, NULL, SCIP_Node::parent, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_NODETYPE_PROBINGNODE, SCIP_Real, SCIP_VBCCOLOR_CUTOFF, SCIPhashmapGetImageInt(), SCIPmessageFPrintInfo(), SCIPnodeGetDepth(), SCIPnodeGetLowerbound(), SCIPnodeGetType(), SCIPretransformObj(), SCIPvarGetLbLocal(), SCIPvarGetName(), SCIPvarGetUbLocal(), TRUE, SCIP_Visual::vbcfile, and vbcSetColor().
Referenced by nodeToLeaf(), SCIPnodeCutoff(), SCIPnodeFocus(), SCIPnodepqBound(), SCIPsolveCIP(), and SCIPtreeCutoff().
◆ SCIPvisualFoundConflict()
SCIP_EXPORT void SCIPvisualFoundConflict | ( | SCIP_VISUAL * | visual, |
SCIP_STAT * | stat, | ||
SCIP_NODE * | node | ||
) |
changes the color of the node to the color of nodes where a conflict constraint was found
- Parameters
-
visual visualization information stat problem statistics node node, where the conflict was found
Definition at line 603 of file visual.c.
References NULL, SCIP_NODETYPE_PROBINGNODE, SCIP_VBCCOLOR_CONFLICT, SCIPnodeGetType(), and vbcSetColor().
Referenced by SCIPconflictFlushConss().
◆ SCIPvisualMarkedRepropagateNode()
SCIP_EXPORT void SCIPvisualMarkedRepropagateNode | ( | SCIP_VISUAL * | visual, |
SCIP_STAT * | stat, | ||
SCIP_NODE * | node | ||
) |
changes the color of the node to the color of nodes that were marked to be repropagated
- Parameters
-
visual visualization information stat problem statistics node node, that was marked to be repropagated
Definition at line 621 of file visual.c.
References NULL, SCIP_NODETYPE_PROBINGNODE, SCIP_VBCCOLOR_MARKREPROP, SCIPnodeGetNumber(), SCIPnodeGetType(), and vbcSetColor().
Referenced by SCIPnodePropagateAgain().
◆ SCIPvisualRepropagatedNode()
SCIP_EXPORT void SCIPvisualRepropagatedNode | ( | SCIP_VISUAL * | visual, |
SCIP_STAT * | stat, | ||
SCIP_NODE * | node | ||
) |
changes the color of the node to the color of repropagated nodes
- Parameters
-
visual visualization information stat problem statistics node node, that was repropagated
Definition at line 642 of file visual.c.
References NULL, SCIP_NODETYPE_PROBINGNODE, SCIP_VBCCOLOR_REPROP, SCIPnodeGetType(), and vbcSetColor().
Referenced by nodeRepropagate().
◆ SCIPvisualFoundSolution()
SCIP_EXPORT void SCIPvisualFoundSolution | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_STAT * | stat, | ||
SCIP_NODE * | node, | ||
SCIP_Bool | bettersol, | ||
SCIP_SOL * | sol | ||
) |
changes the color of the node to the color of nodes with a primal solution
- Parameters
-
visual visualization information set global SCIP settings stat problem statistics node node where the solution was found, or NULL bettersol the solution was better than the previous ones sol solution that has been found
Definition at line 660 of file visual.c.
References SCIP_Visual::bakfile, FALSE, getBranchInfo(), SCIP_Visual::messagehdlr, SCIP_Visual::nodenum, NULL, SCIP_Node::parent, printTime(), SCIP_BOUNDTYPE_LOWER, SCIP_NODETYPE_PROBINGNODE, SCIP_Real, SCIP_VBCCOLOR_SOLUTION, SCIPgetSolOrigObj(), SCIPgetSolTransObj(), SCIPhashmapGetImageInt(), SCIPmessageFPrintInfo(), SCIPnodeGetParent(), SCIPnodeGetType(), SCIPsolGetHeur(), TRUE, SCIP_Visual::vbcfile, and vbcSetColor().
Referenced by primalAddSol().
◆ SCIPvisualLowerbound()
SCIP_EXPORT void SCIPvisualLowerbound | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_STAT * | stat, | ||
SCIP_Real | lowerbound | ||
) |
outputs a new global lower bound to the visualization output file
- Parameters
-
visual visualization information set global SCIP settings stat problem statistics lowerbound new lower bound
Definition at line 759 of file visual.c.
References SCIP_Visual::lastlowerbound, SCIP_Visual::messagehdlr, NULL, printTime(), SCIP_OBJSENSE_MINIMIZE, SCIPgetObjsense(), SCIPmessageFPrintInfo(), SCIPretransformObj(), SCIPsetIsGT(), SCIPsetIsInfinity(), TRUE, and SCIP_Visual::vbcfile.
Referenced by SCIPnodeUpdateLowerbound().
◆ SCIPvisualUpperbound()
SCIP_EXPORT void SCIPvisualUpperbound | ( | SCIP_VISUAL * | visual, |
SCIP_SET * | set, | ||
SCIP_STAT * | stat, | ||
SCIP_Real | upperbound | ||
) |
outputs a new global upper bound to the visualization output file
- Parameters
-
visual visualization information set global SCIP settings stat problem statistics upperbound new upper bound
Definition at line 796 of file visual.c.
References SCIP_Visual::messagehdlr, NULL, printTime(), SCIP_OBJSENSE_MINIMIZE, SCIPgetObjsense(), SCIPmessageFPrintInfo(), SCIPretransformObj(), TRUE, and SCIP_Visual::vbcfile.
Referenced by primalSetUpperbound().