Scippy

UG

Ubiquity Generator framework

ScipParaObjBranchRule Class Reference

#include <scipParaObjBranchRule.h>

+ Inheritance diagram for ScipParaObjBranchRule:

Public Member Functions

 ScipParaObjBranchRule (ScipParaSolver *solver)
 
virtual ~ScipParaObjBranchRule ()
 
virtual SCIP_RETCODE scip_free (SCIP *scip, SCIP_BRANCHRULE *branchrule)
 
virtual SCIP_RETCODE scip_init (SCIP *scip, SCIP_BRANCHRULE *branchrule)
 
virtual SCIP_RETCODE scip_exit (SCIP *scip, SCIP_BRANCHRULE *branchrule)
 
virtual SCIP_RETCODE scip_initsol (SCIP *scip, SCIP_BRANCHRULE *branchrule)
 
virtual SCIP_RETCODE scip_exitsol (SCIP *scip, SCIP_BRANCHRULE *branchrule)
 
virtual SCIP_RETCODE scip_execlp (SCIP *scip, SCIP_BRANCHRULE *branchrule, SCIP_Bool allowaddcons, SCIP_RESULT *result)
 
virtual SCIP_RETCODE scip_execext (SCIP *scip, SCIP_BRANCHRULE *branchrule, SCIP_Bool allowaddcons, SCIP_RESULT *result)
 
virtual SCIP_RETCODE scip_execps (SCIP *scip, SCIP_BRANCHRULE *branchrule, SCIP_Bool allowaddcons, SCIP_RESULT *result)
 

Public Attributes

ScipParaSolverscipParaSolver
 

Detailed Description

C++ wrapper object for branching rules

Definition at line 51 of file scipParaObjBranchRule.h.

Constructor & Destructor Documentation

◆ ScipParaObjBranchRule()

parasolver constructor

Parameters
solverSCIP ParaSolver

Definition at line 60 of file scipParaObjBranchRule.h.

◆ ~ScipParaObjBranchRule()

virtual ~ScipParaObjBranchRule ( )
virtual

destructor

Definition at line 69 of file scipParaObjBranchRule.h.

Member Function Documentation

◆ scip_execext()

virtual SCIP_RETCODE scip_execext ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule,
SCIP_Bool  allowaddcons,
SCIP_RESULT *  result 
)
virtual

branching execution method for external candidates

possible return values for *result (if more than one applies, the first in the list should be used):

  • SCIP_CUTOFF : the current node was detected to be infeasible
  • SCIP_CONSADDED : an additional constraint (e.g. a conflict clause) was generated; this result code must not be returned, if allowaddcons is FALSE
  • SCIP_REDUCEDDOM : a domain was reduced that rendered the current pseudo solution infeasible
  • SCIP_BRANCHED : branching was applied
  • SCIP_DIDNOTRUN : the branching rule was skipped
Parameters
scipSCIP data structure
branchrulethe branching rule itself
allowaddconsshould adding constraints be allowed to avoid a branching?
resultpointer to store the result of the branching call

Definition at line 166 of file scipParaObjBranchRule.h.

◆ scip_execlp()

virtual SCIP_RETCODE scip_execlp ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule,
SCIP_Bool  allowaddcons,
SCIP_RESULT *  result 
)
virtual

branching execution method for fractional LP solutions

possible return values for *result (if more than one applies, the first in the list should be used):

  • SCIP_CUTOFF : the current node was detected to be infeasible
  • SCIP_CONSADDED : an additional constraint (e.g. a conflict clause) was generated; this result code must not be returned, if allowaddcons is FALSE
  • SCIP_REDUCEDDOM : a domain was reduced that rendered the current LP solution infeasible
  • SCIP_SEPARATED : a cutting plane was generated
  • SCIP_BRANCHED : branching was applied
  • SCIP_DIDNOTRUN : the branching rule was skipped

set integer infeaibility statistics

Parameters
scipSCIP data structure
branchrulethe branching rule itself
allowaddconsshould adding constraints be allowed to avoid a branching?
resultpointer to store the result of the branching call

Definition at line 129 of file scipParaObjBranchRule.h.

References BbParaSolver::setII().

◆ scip_execps()

virtual SCIP_RETCODE scip_execps ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule,
SCIP_Bool  allowaddcons,
SCIP_RESULT *  result 
)
virtual

branching execution method for not completely fixed pseudo solutions

possible return values for *result (if more than one applies, the first in the list should be used):

  • SCIP_CUTOFF : the current node was detected to be infeasible
  • SCIP_CONSADDED : an additional constraint (e.g. a conflict clause) was generated; this result code must not be returned, if allowaddcons is FALSE
  • SCIP_REDUCEDDOM : a domain was reduced that rendered the current pseudo solution infeasible
  • SCIP_BRANCHED : branching was applied
  • SCIP_DIDNOTRUN : the branching rule was skipped
Parameters
scipSCIP data structure
branchrulethe branching rule itself
allowaddconsshould adding constraints be allowed to avoid a branching?
resultpointer to store the result of the branching call

Definition at line 188 of file scipParaObjBranchRule.h.

◆ scip_exit()

virtual SCIP_RETCODE scip_exit ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule 
)
virtual

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

Parameters
scipSCIP data structure
branchrulethe branching rule itself

Definition at line 92 of file scipParaObjBranchRule.h.

◆ scip_exitsol()

virtual SCIP_RETCODE scip_exitsol ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule 
)
virtual

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

Parameters
scipSCIP data structure
branchrulethe branching rule itself

Definition at line 110 of file scipParaObjBranchRule.h.

◆ scip_free()

virtual SCIP_RETCODE scip_free ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule 
)
virtual

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

Parameters
scipSCIP data structure
branchrulethe branching rule itself

Definition at line 74 of file scipParaObjBranchRule.h.

◆ scip_init()

virtual SCIP_RETCODE scip_init ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule 
)
virtual

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

Parameters
scipSCIP data structure
branchrulethe branching rule itself

Definition at line 83 of file scipParaObjBranchRule.h.

◆ scip_initsol()

virtual SCIP_RETCODE scip_initsol ( SCIP *  scip,
SCIP_BRANCHRULE *  branchrule 
)
virtual

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

Parameters
scipSCIP data structure
branchrulethe branching rule itself

Definition at line 101 of file scipParaObjBranchRule.h.

Member Data Documentation

◆ scipParaSolver

ScipParaSolver* scipParaSolver

SCIP ParaSolver

Definition at line 57 of file scipParaObjBranchRule.h.