Scippy

UG

Ubiquity Generator framework

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ScipDiffParamSet Class Referenceabstract

#include <scipDiffParamSet.h>

+ Inheritance diagram for ScipDiffParamSet:

Public Member Functions

 ScipDiffParamSet ()
 
 ScipDiffParamSet (SCIP *scip)
 
virtual ~ScipDiffParamSet ()
 
void setParametersInScip (SCIP *scip)
 
int nDiffParams ()
 
bool doesContainRealParam (char *string)
 
std::string toString ()
 
virtual int bcast (UG::ParaComm *comm, int root)=0
 
virtual int send (UG::ParaComm *comm, int destination)=0
 
virtual int receive (UG::ParaComm *comm, int source)=0
 

Protected Member Functions

void allocateMemoty ()
 

Protected Attributes

int numBoolParams
 
size_t boolParamNamesSize
 
char * boolParamNames
 
unsigned int * boolParamValues
 
int numIntParams
 
size_t intParamNamesSize
 
char * intParamNames
 
int * intParamValues
 
int numLongintParams
 
size_t longintParamNamesSize
 
char * longintParamNames
 
long long * longintParamValues
 
int numRealParams
 
size_t realParamNamesSize
 
char * realParamNames
 
double * realParamValues
 
int numCharParams
 
size_t charParamNamesSize
 
char * charParamNames
 
char * charParamValues
 
int numStringParams
 
size_t stringParamNamesSize
 
char * stringParamNames
 
size_t stringParamValuesSize
 
char * stringParamValues
 

Detailed Description

ScipDiffParamSet class

Definition at line 51 of file scipDiffParamSet.h.

Constructor & Destructor Documentation

◆ ScipDiffParamSet() [1/2]

ScipDiffParamSet ( )

constructor

Definition at line 89 of file scipDiffParamSet.h.

◆ ScipDiffParamSet() [2/2]

ScipDiffParamSet ( SCIP *  scip)

constructor with scip

get Parameters

count the number of parameters for each type

allocate memory

set names and values for each type

Definition at line 100 of file scipDiffParamSet.cpp.

References ScipDiffParamSet::allocateMemoty(), ScipDiffParamSet::boolParamNames, ScipDiffParamSet::boolParamNamesSize, ScipDiffParamSet::boolParamValues, ScipDiffParamSet::charParamNames, ScipDiffParamSet::charParamNamesSize, ScipDiffParamSet::charParamValues, ScipDiffParamSet::intParamNames, ScipDiffParamSet::intParamNamesSize, ScipDiffParamSet::intParamValues, ScipDiffParamSet::longintParamNames, ScipDiffParamSet::longintParamNamesSize, ScipDiffParamSet::longintParamValues, ScipDiffParamSet::numBoolParams, ScipDiffParamSet::numCharParams, ScipDiffParamSet::numIntParams, ScipDiffParamSet::numLongintParams, ScipDiffParamSet::numRealParams, ScipDiffParamSet::numStringParams, ScipDiffParamSet::realParamNames, ScipDiffParamSet::realParamNamesSize, ScipDiffParamSet::realParamValues, ScipDiffParamSet::stringParamNames, ScipDiffParamSet::stringParamNamesSize, ScipDiffParamSet::stringParamValues, ScipDiffParamSet::stringParamValuesSize, and THROW_LOGICAL_ERROR2.

◆ ~ScipDiffParamSet()

virtual ~ScipDiffParamSet ( )
virtual

destructor

Definition at line 106 of file scipDiffParamSet.h.

References ScipDiffParamSet::boolParamNames, ScipDiffParamSet::boolParamValues, ScipDiffParamSet::charParamNames, ScipDiffParamSet::charParamValues, ScipDiffParamSet::intParamNames, ScipDiffParamSet::intParamValues, ScipDiffParamSet::longintParamNames, ScipDiffParamSet::longintParamValues, ScipDiffParamSet::realParamNames, ScipDiffParamSet::realParamValues, ScipDiffParamSet::setParametersInScip(), ScipDiffParamSet::stringParamNames, and ScipDiffParamSet::stringParamValues.

Member Function Documentation

◆ allocateMemoty()

void allocateMemoty ( )
protected

allocate memory for names and values

Definition at line 46 of file scipDiffParamSet.cpp.

Referenced by ScipDiffParamSetTh::clone(), and ScipDiffParamSet::ScipDiffParamSet().

◆ bcast()

virtual int bcast ( UG::ParaComm *  comm,
int  root 
)
pure virtual

broadcast scipDiffParamSet

Implemented in ScipDiffParamSetTh, and ScipDiffParamSetMpi.

Referenced by ScipDiffParamSet::doesContainRealParam(), and ScipParaSolver::ScipParaSolver().

◆ doesContainRealParam()

bool doesContainRealParam ( char *  string)

check if this parameter setting contains the argument name real parameter or not NOTE: this function is not tested

Definition at line 137 of file scipDiffParamSet.h.

References ScipDiffParamSet::bcast(), comm, ScipDiffParamSet::numRealParams, UG::read(), ScipDiffParamSet::realParamNames, ScipDiffParamSet::receive(), ScipDiffParamSet::send(), and ScipDiffParamSet::toString().

◆ nDiffParams()

int nDiffParams ( )

get number of different parameters between their default values

Definition at line 129 of file scipDiffParamSet.h.

◆ receive()

virtual int receive ( UG::ParaComm *  comm,
int  source 
)
pure virtual

receive scipDiffParamSet from the source rank

Implemented in ScipDiffParamSetTh, and ScipDiffParamSetMpi.

Referenced by ScipDiffParamSet::doesContainRealParam().

◆ send()

virtual int send ( UG::ParaComm *  comm,
int  destination 
)
pure virtual

end scipDiffParamSet to the rank

Implemented in ScipDiffParamSetTh, and ScipDiffParamSetMpi.

Referenced by ScipDiffParamSet::doesContainRealParam().

◆ setParametersInScip()

void setParametersInScip ( SCIP *  scip)

set these parameter values in scip environment

set boolean parameter values in scip environment

set int parameter values in scip environment

set longint parameter values in scip environment

set real parameter values in scip environment

set char parameter values in scip environment

set string parameter values in scip environment

Definition at line 233 of file scipDiffParamSet.cpp.

References ScipDiffParamSet::boolParamNames, ScipDiffParamSet::boolParamNamesSize, ScipDiffParamSet::boolParamValues, ScipDiffParamSet::charParamNames, ScipDiffParamSet::charParamNamesSize, ScipDiffParamSet::charParamValues, ScipDiffParamSet::intParamNames, ScipDiffParamSet::intParamNamesSize, ScipDiffParamSet::intParamValues, ScipDiffParamSet::longintParamNames, ScipDiffParamSet::longintParamNamesSize, ScipDiffParamSet::longintParamValues, ScipDiffParamSet::numBoolParams, ScipDiffParamSet::numCharParams, ScipDiffParamSet::numIntParams, ScipDiffParamSet::numLongintParams, ScipDiffParamSet::numRealParams, ScipDiffParamSet::numStringParams, ScipDiffParamSet::realParamNames, ScipDiffParamSet::realParamNamesSize, ScipDiffParamSet::realParamValues, ScipDiffParamSet::stringParamNames, ScipDiffParamSet::stringParamNamesSize, ScipDiffParamSet::stringParamValues, and ScipDiffParamSet::stringParamValuesSize.

Referenced by ScipParaInstance::createProblem(), ScipParaSolver::createSubproblem(), SCIP_DECL_HASHKEYVAL(), ScipParaSolver::setOriginalNodeSelectionStrategy(), ScipParaSolver::setOriginalRootNodeProcess(), ScipParaSolver::setRacingParams(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ toString()

std::string toString ( )

stringfy DiffParamSet

stringfy boolean parameter values

stringfy int parameter values

stringfy longint parameter values

stringfy real parameter values

stringfy char parameter values

stringfy string parameter values

Definition at line 312 of file scipDiffParamSet.cpp.

References ScipDiffParamSet::boolParamNames, ScipDiffParamSet::boolParamNamesSize, ScipDiffParamSet::boolParamValues, ScipDiffParamSet::charParamNames, ScipDiffParamSet::charParamNamesSize, ScipDiffParamSet::charParamValues, comm, ScipDiffParamSet::intParamNames, ScipDiffParamSet::intParamNamesSize, ScipDiffParamSet::intParamValues, ScipDiffParamSet::longintParamNames, ScipDiffParamSet::longintParamNamesSize, ScipDiffParamSet::longintParamValues, ScipDiffParamSet::numBoolParams, ScipDiffParamSet::numCharParams, ScipDiffParamSet::numIntParams, ScipDiffParamSet::numLongintParams, ScipDiffParamSet::numRealParams, ScipDiffParamSet::numStringParams, UG::read(), ScipDiffParamSet::realParamNames, ScipDiffParamSet::realParamNamesSize, ScipDiffParamSet::realParamValues, ScipDiffParamSet::stringParamNames, ScipDiffParamSet::stringParamNamesSize, ScipDiffParamSet::stringParamValues, and ScipDiffParamSet::stringParamValuesSize.

Referenced by ScipDiffParamSet::doesContainRealParam(), and ScipParaRacingRampUpParamSet::toString().

Member Data Documentation

◆ boolParamNames

char* boolParamNames
protected

boolean parameter names: names are concatenated

Definition at line 55 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ boolParamNamesSize

size_t boolParamNamesSize
protected

size of boolParameterNames area

Definition at line 54 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ boolParamValues

unsigned int* boolParamValues
protected

boolean parameter values

Definition at line 56 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ charParamNames

char* charParamNames
protected

char parameter names: names are concatenated

Definition at line 75 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ charParamNamesSize

size_t charParamNamesSize
protected

size of charParameterNames area

Definition at line 74 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ charParamValues

char* charParamValues
protected

char parameter values

Definition at line 76 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ intParamNames

char* intParamNames
protected

int parameter names: names are concatenated

Definition at line 60 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ intParamNamesSize

size_t intParamNamesSize
protected

size of intParameterNames area

Definition at line 59 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ intParamValues

int* intParamValues
protected

int parameter values

Definition at line 61 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ longintParamNames

char* longintParamNames
protected

longint parameter names: names are concatenated

Definition at line 65 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ longintParamNamesSize

size_t longintParamNamesSize
protected

size of longintParameterNames area

Definition at line 64 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ longintParamValues

long long* longintParamValues
protected

longint parameter values

Definition at line 66 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ numBoolParams

int numBoolParams
protected

the number of bool parameters

Definition at line 53 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ numCharParams

int numCharParams
protected

the number of char parameters

Definition at line 73 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ numIntParams

int numIntParams
protected

the number of int parameters

Definition at line 58 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ numLongintParams

int numLongintParams
protected

the number of longint parameters

Definition at line 63 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ numRealParams

int numRealParams
protected

the number of real parameters

Definition at line 68 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::doesContainRealParam(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ numStringParams

int numStringParams
protected

the number of string parameters

Definition at line 78 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ realParamNames

char* realParamNames
protected

real parameter names: names are concatenated

Definition at line 70 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::doesContainRealParam(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ realParamNamesSize

size_t realParamNamesSize
protected

size of realParameterNames area

Definition at line 69 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ realParamValues

double* realParamValues
protected

real parameter values

Definition at line 71 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ stringParamNames

char* stringParamNames
protected

string parameter names: names are concatenated

Definition at line 80 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ stringParamNamesSize

size_t stringParamNamesSize
protected

size of stringParameterNames area

Definition at line 79 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().

◆ stringParamValues

char* stringParamValues
protected

string parameter values: values are concatenated

Definition at line 82 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), ScipDiffParamSet::toString(), and ScipDiffParamSet::~ScipDiffParamSet().

◆ stringParamValuesSize

size_t stringParamValuesSize
protected

size of stringParameterValues area

Definition at line 81 of file scipDiffParamSet.h.

Referenced by ScipDiffParamSetTh::clone(), ScipDiffParamSet::ScipDiffParamSet(), ScipDiffParamSet::setParametersInScip(), ScipDiffParamSetTh::setValues(), and ScipDiffParamSet::toString().