Scippy

UG

Ubiquity Generator framework

BbParaDiffSubproblem Class Referenceabstract

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

#include <bbParaDiffSubproblem.h>

+ Inheritance diagram for BbParaDiffSubproblem:

Public Member Functions

 BbParaDiffSubproblem ()
 DO NOT HAVE DATA MEMBER!! More...
 
virtual ~BbParaDiffSubproblem ()
 destractor¥ 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 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()

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(), and BbParaDiffSubproblem::~BbParaDiffSubproblem().

◆ 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.

Referenced by BbParaDiffSubproblem::~BbParaDiffSubproblem().

◆ 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()(), BbParaNodeSortCriterionForCleanUp::operator()(), and BbParaDiffSubproblem::~BbParaDiffSubproblem().

◆ 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.

◆ 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.