event_solvingphase.h File Reference

Detailed Description

eventhdlr for solving phase dependent parameter adjustment

Author

Gregor Hendel

this event handler is used to apply dynamic parameter adjustment depending on the progress of the solving process.

Definition in file event_solvingphase.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"

Go to the source code of this file.

Macros
#define	SCIP_SOLVINGPHASEFLAG_NONE   UINT8_C(0x00)
#define	SCIP_SOLVINGPHASEFLAG_RANK1   UINT8_C(0x01)
#define	SCIP_SOLVINGPHASEFLAG_ESTIMATE   UINT8_C(0x02)
#define	SCIP_SOLVINGPHASEFLAG_OPTIMAL   UINT8_C(0x04)
#define	SCIP_SOLVINGPHASEFLAG_LOG   UINT8_C(0x08)

Typedefs
typedef enum SCIP_SolvingPhase	SCIP_SOLVINGPHASE
typedef uint8_t	SCIP_SOLVINGPHASEFLAG

Enumerations
enum	SCIP_SolvingPhase {   SCIP_SOLVINGPHASE_UNINITIALIZED = -1 ,   SCIP_SOLVINGPHASE_FEASIBILITY = 0 ,   SCIP_SOLVINGPHASE_IMPROVEMENT = 1 ,   SCIP_SOLVINGPHASE_PROOF = 2 }

Functions
SCIP_RETCODE	SCIPincludeEventHdlrSolvingphase (SCIP *scip)
SCIP_SOLVINGPHASE	SCIPgetSolvingPhase (SCIP *scip)
SCIP_SOLVINGPHASEFLAG	SCIPgetSolvingPhaseFlags (SCIP *scip)

Macro Definition Documentation

SCIP_SOLVINGPHASEFLAG_NONE

#define SCIP_SOLVINGPHASEFLAG_NONE   UINT8_C(0x00)

transition criteria flags reached by the solvingphase event handler no transition criterion has been reached

Definition at line 58 of file event_solvingphase.h.

SCIP_SOLVINGPHASEFLAG_RANK1

#define SCIP_SOLVINGPHASEFLAG_RANK1   UINT8_C(0x01)

rank-1 node based transition criterion has been reached

Definition at line 59 of file event_solvingphase.h.

SCIP_SOLVINGPHASEFLAG_ESTIMATE

#define SCIP_SOLVINGPHASEFLAG_ESTIMATE   UINT8_C(0x02)

best estimate transition criterion has been reached

Definition at line 60 of file event_solvingphase.h.

SCIP_SOLVINGPHASEFLAG_OPTIMAL

#define SCIP_SOLVINGPHASEFLAG_OPTIMAL   UINT8_C(0x04)

optimal value transition criterion has been reached

Definition at line 61 of file event_solvingphase.h.

SCIP_SOLVINGPHASEFLAG_LOG

#define SCIP_SOLVINGPHASEFLAG_LOG   UINT8_C(0x08)

logarithmic regression transition criterion has been reached

Definition at line 62 of file event_solvingphase.h.

Typedef Documentation

SCIP_SOLVINGPHASE

typedef enum SCIP_SolvingPhase SCIP_SOLVINGPHASE

Definition at line 55 of file event_solvingphase.h.

SCIP_SOLVINGPHASEFLAG

typedef uint8_t SCIP_SOLVINGPHASEFLAG

flag for the solving phases (bit field)

Definition at line 64 of file event_solvingphase.h.

Enumeration Type Documentation

SCIP_SolvingPhase

enum SCIP_SolvingPhase

enumerator to represent the current solving phase

Enumerator
SCIP_SOLVINGPHASE_UNINITIALIZED	solving phase has not been initialized yet
SCIP_SOLVINGPHASE_FEASIBILITY	no solution was found until now
SCIP_SOLVINGPHASE_IMPROVEMENT	current incumbent solution is suboptimal
SCIP_SOLVINGPHASE_PROOF	current incumbent is optimal

Definition at line 48 of file event_solvingphase.h.

Function Documentation

SCIPincludeEventHdlrSolvingphase()

SCIP_RETCODE SCIPincludeEventHdlrSolvingphase

(

SCIP *

scip

)

creates event handler for solving phase event

creates event handler for Solvingphase event

Parameters

scip	SCIP data structure

Definition at line 1510 of file event_solvingphase.c.

References DEFAULT_ENABLED, DEFAULT_FALLBACK, DEFAULT_INTERRUPTOPTIMAL, DEFAULT_LOGREGRESSION_XTYPE, DEFAULT_NODEOFFSET, DEFAULT_SETNAME, DEFAULT_TESTMODE, DEFAULT_TRANSITIONMETHOD, DEFAULT_USEEMPHSETTINGS, DEFAULT_USERESTART1TO2, DEFAULT_USERESTART2TO3, DISP_DESC_NNODESBELOWINC, DISP_DESC_NRANK1NODES, DISP_HEAD_NNODESBELOWINC, DISP_HEAD_NRANK1NODES, DISP_NAME_NNODESBELOWINC, DISP_NAME_NRANK1NODES, DISP_POSI_NNODESBELOWINC, DISP_POSI_NRANK1NODES, DISP_PRIO_NNODESBELOWINC, DISP_PRIO_NRANK1NODES, DISP_STRI_NNODESBELOWINC, DISP_STRI_NRANK1NODES, DISP_WIDT_NNODESBELOWINC, DISP_WIDT_NRANK1NODES, eventCopySolvingphase, EVENTHDLR_DESC, EVENTHDLR_NAME, FALSE, LOGREGRESSION_XTYPES, NULL, SCIP_CALL, SCIP_DISPSTATUS_OFF, SCIP_INVALID, SCIP_LONGINT_MAX, SCIP_OKAY, SCIP_REAL_MAX, SCIP_REAL_MIN, SCIPaddBoolParam(), SCIPaddCharParam(), SCIPaddLongintParam(), SCIPaddRealParam(), SCIPaddStringParam(), SCIPallocBlockMemory, SCIPincludeDisp(), SCIPincludeEventhdlrBasic(), SCIPregressionCreate(), SCIPsetEventhdlrCopy(), SCIPsetEventhdlrExit(), SCIPsetEventhdlrExitsol(), SCIPsetEventhdlrFree(), SCIPsetEventhdlrInit(), SCIPsetEventhdlrInitsol(), and TRANSITIONMETHODS.

Referenced by SCIPincludeDefaultPlugins().

SCIPgetSolvingPhase()

SCIP_SOLVINGPHASE SCIPgetSolvingPhase

(

SCIP *

scip

)

returns the current solving phase tracked by the solvingphase event handler

The phase advances from SCIP_SOLVINGPHASE_FEASIBILITY to SCIP_SOLVINGPHASE_IMPROVEMENT when a solution is found, and to SCIP_SOLVINGPHASE_PROOF when a heuristic transition criterion (see parameter solvingphases/transitionmethod) declares that the incumbent is expected to be optimal and the solver is proving optimality.

The phase is tracked when the event handler is active, i.e. when solvingphases/enabled or solvingphases/testmode is set to TRUE. Otherwise, SCIP_SOLVINGPHASE_UNINITIALIZED is returned.

returns the current solving phase tracked by the solvingphase event handler

Parameters

scip	SCIP data structure

Definition at line 1607 of file event_solvingphase.c.

References EVENTHDLR_NAME, NULL, SCIP_SOLVINGPHASE_UNINITIALIZED, SCIPeventhdlrGetData(), and SCIPfindEventhdlr().

SCIPgetSolvingPhaseFlags()

SCIP_SOLVINGPHASEFLAG SCIPgetSolvingPhaseFlags

(

SCIP *

scip

)

returns the bit field of reached transition criteria

See SCIP_SOLVINGPHASEFLAG_* for the available flags. The flags are tracked whenever the solvingphase event handler is active, i.e. when solvingphases/enabled or solvingphases/testmode is set to TRUE. Otherwise, SCIP_SOLVINGPHASEFLAG_NONE is returned.

returns the bit field of reached transition criteria

Parameters

scip	SCIP data structure

Definition at line 1627 of file event_solvingphase.c.

References EVENTHDLR_NAME, NULL, SCIP_SOLVINGPHASEFLAG_NONE, SCIPeventhdlrGetData(), and SCIPfindEventhdlr().