Scippy

UG

Ubiquity Generator framework

BbParaDiffSubproblem Class Referenceabstract

Class for the difference between instance and subproblem. More...

#include <bbParaDiffSubproblem.h>

Inheritance diagram for BbParaDiffSubproblem:
ParaDiffSubproblem ScipParaDiffSubproblem ScipParaDiffSubproblemMpi ScipParaDiffSubproblemTh

Public Member Functions

 BbParaDiffSubproblem ()
 DO NOT HAVE DATA MEMBER!! More...
 
virtual ~BbParaDiffSubproblem ()
 destractor¥ More...
 
virtual void read (ParaComm *comm, gzstream::igzstream &in, bool onlyBoundChanges)=0
 function to read BbParaDiffSubproblem object from checkpoint file More...
 
virtual int getNBoundChanges ()=0
 get the number of bound changes More...
 
virtual int getFixedVariables (ParaInstance *instance, BbParaFixedVariable **fixedVars)=0
 get the number of fixed variables More...
 
virtual BbParaDiffSubproblemcreateDiffSubproblem (ParaComm *comm, ParaInitiator *initiator, int n, BbParaFixedVariable *fixedVars)=0
 create new BbParaDiffSubproblem object using fixed variables information More...
 
virtual const std::string toStringStat ()
 stringfy statistics of BbParaDiffSubproblem object More...
 
virtual void setWinnerParams (BbParaRacingRampUpParamSet *winerParams)
 set winner racing parameters at warm start racing More...
 
virtual BbParaRacingRampUpParamSetgetWinnerParams ()
 get winner racing parameters at warm start racing More...
 
- Public Member Functions inherited from ParaDiffSubproblem
 ParaDiffSubproblem ()
 DO NOT HAVE DATA MEMBER!! More...
 
virtual ~ParaDiffSubproblem ()
 destractor¥ More...
 
virtual ParaDiffSubproblemclone (ParaComm *comm)=0
 create clone of this object More...
 
virtual int bcast (ParaComm *comm, int root)=0
 broadcast function for ParaDiffSubproblem object More...
 
virtual int send (ParaComm *comm, int dest)=0
 send function for ParaDiffSubproblem object More...
 
virtual int receive (ParaComm *comm, int source)=0
 receive function for ParaDiffSubproblem object More...
 
virtual void write (gzstream::ogzstream &out)=0
 function to write ParaDiffSubproblem object to checkpoint file More...
 
virtual const std::string toString ()=0
 stringfy ParaDiffSubproblem object ( for debugging ) More...
 

Detailed Description

Class for the difference between instance and subproblem.

This class should NOT have any data member.

Definition at line 67 of file bbParaDiffSubproblem.h.

Constructor & Destructor Documentation

◆ BbParaDiffSubproblem()

DO NOT HAVE DATA MEMBER!!

default constructor

Definition at line 79 of file bbParaDiffSubproblem.h.

◆ ~BbParaDiffSubproblem()

virtual ~BbParaDiffSubproblem ( )
virtual

destractor¥

Definition at line 87 of file bbParaDiffSubproblem.h.

Member Function Documentation

◆ createDiffSubproblem()

virtual BbParaDiffSubproblem * createDiffSubproblem ( ParaComm comm,
ParaInitiator initiator,
int  n,
BbParaFixedVariable fixedVars 
)
pure virtual

create new BbParaDiffSubproblem object using fixed variables information

Returns
pointer to BbParaDiffSubproblem object
Parameters
commcommunicator used
initiatorpoint to ParaInitiator object
nthe number of fixed variables
fixedVarsarray of the fixed variables

Implemented in ScipParaDiffSubproblem.

Referenced by BbParaNodesMerger::generateMergeNodesCandidates().

◆ getFixedVariables()

virtual int getFixedVariables ( ParaInstance instance,
BbParaFixedVariable **  fixedVars 
)
pure virtual

get the number of fixed variables

Returns
the number of fixed variables
Parameters
instancepointer to instance object
fixedVarsarray of fixed variables

Implemented in ScipParaDiffSubproblem.

◆ getNBoundChanges()

virtual int getNBoundChanges ( )
pure virtual

get the number of bound changes

Returns
the number of bound changes

Implemented in ScipParaDiffSubproblem.

Referenced by BbParaNodeSortCriterion::operator()(), and BbParaNodeSortCriterionForCleanUp::operator()().

◆ getWinnerParams()

virtual BbParaRacingRampUpParamSet * getWinnerParams ( )
virtual

get winner racing parameters at warm start racing

Returns
winner racing ramp-up parameters

Definition at line 157 of file bbParaDiffSubproblem.h.

◆ read()

virtual void read ( ParaComm comm,
gzstream::igzstream &  in,
bool  onlyBoundChanges 
)
pure virtual

function to read BbParaDiffSubproblem object from checkpoint file

Parameters
commcommunicator used
ingzstream for input
onlyBoundChangesindicate if only bound changes are output or not

Implemented in ScipParaDiffSubproblem.

◆ setWinnerParams()

virtual void setWinnerParams ( BbParaRacingRampUpParamSet winerParams)
virtual

set winner racing parameters at warm start racing

Parameters
winerParamspointer to winner racing ramp-up parameters

Definition at line 146 of file bbParaDiffSubproblem.h.

◆ toStringStat()

virtual const std::string toStringStat ( )
virtual

stringfy statistics of BbParaDiffSubproblem object

Returns
string to show some statistics of this object

Reimplemented in ScipParaDiffSubproblem.

Definition at line 136 of file bbParaDiffSubproblem.h.