Scippy

SCIP

Solving Constraint Integer Programs

SCIP_Branchrule Struct Reference

Detailed Description

branching rule

Definition at line 69 of file struct_branch.h.

#include <struct_branch.h>

Public Member Functions

 SCIP_DECL_BRANCHCOPY ((*branchcopy))
 
 SCIP_DECL_BRANCHFREE ((*branchfree))
 
 SCIP_DECL_BRANCHINIT ((*branchinit))
 
 SCIP_DECL_BRANCHEXIT ((*branchexit))
 
 SCIP_DECL_BRANCHINITSOL ((*branchinitsol))
 
 SCIP_DECL_BRANCHEXITSOL ((*branchexitsol))
 
 SCIP_DECL_BRANCHEXECLP ((*branchexeclp))
 
 SCIP_DECL_BRANCHEXECEXT ((*branchexecext))
 
 SCIP_DECL_BRANCHEXECPS ((*branchexecps))
 

Data Fields

SCIP_Real maxbounddist
 
SCIP_Longint nlpcalls
 
SCIP_Longint nexterncalls
 
SCIP_Longint npseudocalls
 
SCIP_Longint ncutoffs
 
SCIP_Longint ncutsfound
 
SCIP_Longint nconssfound
 
SCIP_Longint ndomredsfound
 
SCIP_Longint nchildren
 
char * name
 
char * desc
 
SCIP_BRANCHRULEDATAbranchruledata
 
SCIP_CLOCKsetuptime
 
SCIP_CLOCKbranchclock
 
int priority
 
int maxdepth
 
SCIP_Bool initialized
 
SCIP_Bool isobjbranchrule
 

Member Function Documentation

◆ SCIP_DECL_BRANCHCOPY()

SCIP_Branchrule::SCIP_DECL_BRANCHCOPY ( branchcopy)

copy method of branching rule or NULL if you don't want to copy your plugin into sub-SCIPs

◆ SCIP_DECL_BRANCHFREE()

SCIP_Branchrule::SCIP_DECL_BRANCHFREE ( branchfree)

destructor of branching rule

◆ SCIP_DECL_BRANCHINIT()

SCIP_Branchrule::SCIP_DECL_BRANCHINIT ( branchinit)

initialize branching rule

◆ SCIP_DECL_BRANCHEXIT()

SCIP_Branchrule::SCIP_DECL_BRANCHEXIT ( branchexit)

deinitialize branching rule

◆ SCIP_DECL_BRANCHINITSOL()

SCIP_Branchrule::SCIP_DECL_BRANCHINITSOL ( branchinitsol)

solving process initialization method of branching rule

◆ SCIP_DECL_BRANCHEXITSOL()

SCIP_Branchrule::SCIP_DECL_BRANCHEXITSOL ( branchexitsol)

solving process deinitialization method of branching rule

◆ SCIP_DECL_BRANCHEXECLP()

SCIP_Branchrule::SCIP_DECL_BRANCHEXECLP ( branchexeclp)

branching execution method for fractional LP solutions

◆ SCIP_DECL_BRANCHEXECEXT()

SCIP_Branchrule::SCIP_DECL_BRANCHEXECEXT ( branchexecext)

branching execution method for external candidates

◆ SCIP_DECL_BRANCHEXECPS()

SCIP_Branchrule::SCIP_DECL_BRANCHEXECPS ( branchexecps)

branching execution method for not completely fixed pseudo solutions

Field Documentation

◆ maxbounddist

SCIP_Real SCIP_Branchrule::maxbounddist

maximal relative distance from current node's dual bound to primal bound compared to best node's dual bound for applying branching rule (0.0: only on current best node, 1.0: on all nodes)

Definition at line 71 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPbranchruleExecPseudoSol(), SCIPbranchruleGetMaxbounddist(), and SCIPbranchruleSetMaxbounddist().

◆ nlpcalls

SCIP_Longint SCIP_Branchrule::nlpcalls

number of times, this branching rule was called on an LP solution

Definition at line 74 of file struct_branch.h.

Referenced by SCIPbranchruleExecLPSol(), SCIPbranchruleGetNLPCalls(), and SCIPbranchruleInit().

◆ nexterncalls

SCIP_Longint SCIP_Branchrule::nexterncalls

number of times, this branching rule was called on external candidates

Definition at line 75 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleGetNExternCalls(), and SCIPbranchruleInit().

◆ npseudocalls

SCIP_Longint SCIP_Branchrule::npseudocalls

number of times, this branching rule was called on a pseudo solution

Definition at line 76 of file struct_branch.h.

Referenced by SCIPbranchruleExecPseudoSol(), SCIPbranchruleGetNPseudoCalls(), and SCIPbranchruleInit().

◆ ncutoffs

SCIP_Longint SCIP_Branchrule::ncutoffs

number of cutoffs found so far by this branching rule

Definition at line 77 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPbranchruleExecPseudoSol(), SCIPbranchruleGetNCutoffs(), and SCIPbranchruleInit().

◆ ncutsfound

SCIP_Longint SCIP_Branchrule::ncutsfound

number of cutting planes found so far by this branching rule

Definition at line 78 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPbranchruleGetNCutsFound(), and SCIPbranchruleInit().

◆ nconssfound

SCIP_Longint SCIP_Branchrule::nconssfound

number of cutting constraints added so far by this branching rule (not counting constraint additions to child nodes used for branching)

Definition at line 79 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPbranchruleExecPseudoSol(), SCIPbranchruleGetNConssFound(), and SCIPbranchruleInit().

◆ ndomredsfound

SCIP_Longint SCIP_Branchrule::ndomredsfound

number of domain reductions found so far by this branching rule

Definition at line 81 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPbranchruleExecPseudoSol(), SCIPbranchruleGetNDomredsFound(), and SCIPbranchruleInit().

◆ nchildren

SCIP_Longint SCIP_Branchrule::nchildren

number of children created so far by this branching rule

Definition at line 82 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPbranchruleExecPseudoSol(), SCIPbranchruleGetNChildren(), and SCIPbranchruleInit().

◆ name

char* SCIP_Branchrule::name

◆ desc

char* SCIP_Branchrule::desc

description of branching rule

Definition at line 84 of file struct_branch.h.

Referenced by SCIPbranchruleGetDesc().

◆ branchruledata

SCIP_BRANCHRULEDATA* SCIP_Branchrule::branchruledata

branching rule data

Definition at line 94 of file struct_branch.h.

Referenced by SCIPbranchruleGetData(), and SCIPbranchruleSetData().

◆ setuptime

SCIP_CLOCK* SCIP_Branchrule::setuptime

time spend for setting up this branchrule for the next stages

Definition at line 95 of file struct_branch.h.

Referenced by SCIPbranchruleEnableOrDisableClocks(), SCIPbranchruleExit(), SCIPbranchruleExitsol(), SCIPbranchruleGetSetupTime(), SCIPbranchruleInit(), and SCIPbranchruleInitsol().

◆ branchclock

◆ priority

int SCIP_Branchrule::priority

priority of the branching rule

Definition at line 97 of file struct_branch.h.

Referenced by SCIPbranchruleGetPriority(), and SCIPbranchruleSetPriority().

◆ maxdepth

int SCIP_Branchrule::maxdepth

maximal depth level, up to which this branching rule should be used (or -1)

Definition at line 98 of file struct_branch.h.

Referenced by SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPbranchruleExecPseudoSol(), SCIPbranchruleGetMaxdepth(), and SCIPbranchruleSetMaxdepth().

◆ initialized

SCIP_Bool SCIP_Branchrule::initialized

is branching rule initialized?

Definition at line 99 of file struct_branch.h.

Referenced by SCIPbranchruleExit(), SCIPbranchruleInit(), and SCIPbranchruleIsInitialized().

◆ isobjbranchrule

SCIP_Bool SCIP_Branchrule::isobjbranchrule

is branching rule an obj branching rule?

Definition at line 100 of file struct_branch.h.