Scippy

SCIP

Solving Constraint Integer Programs

paramset.h File Reference

Detailed Description

internal methods for handling parameter settings

Author
Tobias Achterberg
Timo Berthold

Definition in file paramset.h.

#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_set.h"
#include "scip/type_retcode.h"
#include "scip/type_paramset.h"
#include "scip/pub_paramset.h"
#include "scip/pub_misc.h"

Go to the source code of this file.

Functions

SCIP_RETCODE SCIPparamsetCreate (SCIP_PARAMSET **paramset, BMS_BLKMEM *blkmem)
 
void SCIPparamsetFree (SCIP_PARAMSET **paramset, BMS_BLKMEM *blkmem)
 
SCIP_RETCODE SCIPparamsetAddBool (SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Bool *valueptr, SCIP_Bool isadvanced, SCIP_Bool defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
 
SCIP_RETCODE SCIPparamsetAddInt (SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, int *valueptr, SCIP_Bool isadvanced, int defaultvalue, int minvalue, int maxvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
 
SCIP_RETCODE SCIPparamsetAddLongint (SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Longint *valueptr, SCIP_Bool isadvanced, SCIP_Longint defaultvalue, SCIP_Longint minvalue, SCIP_Longint maxvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
 
SCIP_RETCODE SCIPparamsetAddReal (SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Real *valueptr, SCIP_Bool isadvanced, SCIP_Real defaultvalue, SCIP_Real minvalue, SCIP_Real maxvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
 
SCIP_RETCODE SCIPparamsetAddChar (SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, char *valueptr, SCIP_Bool isadvanced, char defaultvalue, const char *allowedvalues, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
 
SCIP_RETCODE SCIPparamsetAddString (SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, char **valueptr, SCIP_Bool isadvanced, const char *defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
 
SCIP_Bool SCIPparamsetIsFixed (SCIP_PARAMSET *paramset, const char *name)
 
SCIP_PARAMSCIPparamsetGetParam (SCIP_PARAMSET *paramset, const char *name)
 
SCIP_RETCODE SCIPparamsetGetBool (SCIP_PARAMSET *paramset, const char *name, SCIP_Bool *value)
 
SCIP_RETCODE SCIPparamsetGetInt (SCIP_PARAMSET *paramset, const char *name, int *value)
 
SCIP_RETCODE SCIPparamsetGetLongint (SCIP_PARAMSET *paramset, const char *name, SCIP_Longint *value)
 
SCIP_RETCODE SCIPparamsetGetReal (SCIP_PARAMSET *paramset, const char *name, SCIP_Real *value)
 
SCIP_RETCODE SCIPparamsetGetChar (SCIP_PARAMSET *paramset, const char *name, char *value)
 
SCIP_RETCODE SCIPparamsetGetString (SCIP_PARAMSET *paramset, const char *name, char **value)
 
SCIP_RETCODE SCIPparamsetFix (SCIP_PARAMSET *paramset, const char *name, SCIP_Bool fixed)
 
SCIP_RETCODE SCIPparamsetSetBool (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Bool value)
 
SCIP_RETCODE SCIPparamsetSetInt (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, int value)
 
SCIP_RETCODE SCIPparamsetSetLongint (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Longint value)
 
SCIP_RETCODE SCIPparamsetSetReal (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Real value)
 
SCIP_RETCODE SCIPparamsetSetChar (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, char value)
 
SCIP_RETCODE SCIPparamsetSetString (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, const char *value)
 
SCIP_RETCODE SCIPparamsetSetDefaultBool (SCIP_PARAMSET *paramset, const char *name, SCIP_Bool defaultvalue)
 
SCIP_RETCODE SCIPparamsetSetDefaultInt (SCIP_PARAMSET *paramset, const char *name, int defaultvalue)
 
SCIP_RETCODE SCIPparamsetSetDefaultLongint (SCIP_PARAMSET *paramset, const char *name, SCIP_Longint defaultvalue)
 
SCIP_RETCODE SCIPparamsetSetDefaultReal (SCIP_PARAMSET *paramset, const char *name, SCIP_Real defaultvalue)
 
SCIP_RETCODE SCIPparamsetSetDefaultChar (SCIP_PARAMSET *paramset, const char *name, char defaultvalue)
 
SCIP_RETCODE SCIPparamsetSetDefaultString (SCIP_PARAMSET *paramset, const char *name, const char *defaultvalue)
 
SCIP_RETCODE SCIPparamsetRead (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *filename)
 
SCIP_RETCODE SCIPparamsetWrite (SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
 
SCIP_RETCODE SCIPparamsetSetToDefaults (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
 
SCIP_RETCODE SCIPparamsetSetToDefault (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *paramname)
 
SCIP_RETCODE SCIPparamsetSetEmphasis (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMEMPHASIS paramemphasis, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamsetSetToSubscipsOff (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamsetSetHeuristics (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamsetSetPresolving (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamsetSetSeparating (SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
 
SCIP_PARAM ** SCIPparamsetGetParams (SCIP_PARAMSET *paramset)
 
int SCIPparamsetGetNParams (SCIP_PARAMSET *paramset)
 
SCIP_RETCODE SCIPparamsetCopyParams (SCIP_PARAMSET *sourceparamset, SCIP_PARAMSET *targetparamset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
 
SCIP_Bool SCIPparamIsValidBool (SCIP_PARAM *param, SCIP_Bool value)
 
SCIP_Bool SCIPparamIsValidInt (SCIP_PARAM *param, int value)
 
SCIP_Bool SCIPparamIsValidLongint (SCIP_PARAM *param, SCIP_Longint value)
 
SCIP_Bool SCIPparamIsValidReal (SCIP_PARAM *param, SCIP_Real value)
 
SCIP_Bool SCIPparamIsValidChar (SCIP_PARAM *param, const char value)
 
SCIP_Bool SCIPparamIsValidString (SCIP_PARAM *param, const char *value)
 
SCIP_RETCODE SCIPparamSetBool (SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Bool value, SCIP_Bool initialize, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamSetInt (SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, int value, SCIP_Bool initialize, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamSetLongint (SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Longint value, SCIP_Bool initialize, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamSetReal (SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Real value, SCIP_Bool initialize, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamSetChar (SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, char value, SCIP_Bool initialize, SCIP_Bool quiet)
 
SCIP_RETCODE SCIPparamSetString (SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *value, SCIP_Bool initialize, SCIP_Bool quiet)
 
void SCIPparamSetDefaultBool (SCIP_PARAM *param, SCIP_Bool defaultvalue)
 
void SCIPparamSetDefaultInt (SCIP_PARAM *param, int defaultvalue)
 
void SCIPparamSetDefaultLongint (SCIP_PARAM *param, SCIP_Longint defaultvalue)
 
void SCIPparamSetDefaultReal (SCIP_PARAM *param, SCIP_Real defaultvalue)
 
void SCIPparamSetDefaultChar (SCIP_PARAM *param, char defaultvalue)
 
void SCIPparamSetDefaultString (SCIP_PARAM *param, const char *defaultvalue)
 
SCIP_RETCODE SCIPparamSetToDefault (SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
 
SCIP_RETCODE SCIPparamWrite (SCIP_PARAM *param, SCIP_MESSAGEHDLR *messagehdlr, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
 

Function Documentation

◆ SCIPparamsetCreate()

SCIP_RETCODE SCIPparamsetCreate ( SCIP_PARAMSET **  paramset,
BMS_BLKMEM blkmem 
)

creates parameter set

Parameters
paramsetpointer to store the parameter set
blkmemblock memory

Definition at line 1426 of file paramset.c.

References BMSallocMemory, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_HASHSIZE_PARAMS, SCIP_OKAY, and SCIPhashtableCreate().

Referenced by SCIPsetCopyPlugins().

◆ SCIPparamsetFree()

void SCIPparamsetFree ( SCIP_PARAMSET **  paramset,
BMS_BLKMEM blkmem 
)

frees parameter set

Parameters
paramsetpointer to the parameter set
blkmemblock memory

Definition at line 1446 of file paramset.c.

References BMSfreeMemory, BMSfreeMemoryArrayNull, NULL, paramFree(), and SCIPhashtableFree().

◆ SCIPparamsetAddBool()

SCIP_RETCODE SCIPparamsetAddBool ( SCIP_PARAMSET paramset,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
SCIP_Bool valueptr,
SCIP_Bool  isadvanced,
SCIP_Bool  defaultvalue,
SCIP_DECL_PARAMCHGD((*paramchgd))  ,
SCIP_PARAMDATA paramdata 
)

creates a bool parameter, sets it to its default value, and adds it to the parameter set

creates a SCIP_Bool parameter, sets it to its default value, and adds it to the parameter set

Parameters
paramsetparameter set
messagehdlrmessage handler
blkmemblock memory
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
paramdatalocally defined parameter specific data

Definition at line 1499 of file paramset.c.

References NULL, paramCreateBool(), paramsetAdd(), SCIP_CALL, and SCIP_OKAY.

◆ SCIPparamsetAddInt()

SCIP_RETCODE SCIPparamsetAddInt ( SCIP_PARAMSET paramset,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
int *  valueptr,
SCIP_Bool  isadvanced,
int  defaultvalue,
int  minvalue,
int  maxvalue,
SCIP_DECL_PARAMCHGD((*paramchgd))  ,
SCIP_PARAMDATA paramdata 
)

creates a int parameter, sets it to its default value, and adds it to the parameter set

Parameters
paramsetparameter set
messagehdlrmessage handler
blkmemblock memory
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
minvalueminimum value for parameter
maxvaluemaximum value for parameter
paramdatalocally defined parameter specific data

Definition at line 1526 of file paramset.c.

References NULL, paramCreateInt(), paramsetAdd(), SCIP_CALL, and SCIP_OKAY.

◆ SCIPparamsetAddLongint()

SCIP_RETCODE SCIPparamsetAddLongint ( SCIP_PARAMSET paramset,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
SCIP_Longint valueptr,
SCIP_Bool  isadvanced,
SCIP_Longint  defaultvalue,
SCIP_Longint  minvalue,
SCIP_Longint  maxvalue,
SCIP_DECL_PARAMCHGD((*paramchgd))  ,
SCIP_PARAMDATA paramdata 
)

creates a SCIP_Longint parameter, sets it to its default value, and adds it to the parameter set

Parameters
paramsetparameter set
messagehdlrmessage handler
blkmemblock memory
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
minvalueminimum value for parameter
maxvaluemaximum value for parameter
paramdatalocally defined parameter specific data

Definition at line 1556 of file paramset.c.

References NULL, paramCreateLongint(), paramsetAdd(), SCIP_CALL, and SCIP_OKAY.

◆ SCIPparamsetAddReal()

SCIP_RETCODE SCIPparamsetAddReal ( SCIP_PARAMSET paramset,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
SCIP_Real valueptr,
SCIP_Bool  isadvanced,
SCIP_Real  defaultvalue,
SCIP_Real  minvalue,
SCIP_Real  maxvalue,
SCIP_DECL_PARAMCHGD((*paramchgd))  ,
SCIP_PARAMDATA paramdata 
)

creates a SCIP_Real parameter, sets it to its default value, and adds it to the parameter set

Parameters
paramsetparameter set
messagehdlrmessage handler
blkmemblock memory
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
minvalueminimum value for parameter
maxvaluemaximum value for parameter
paramdatalocally defined parameter specific data

Definition at line 1586 of file paramset.c.

References NULL, paramCreateReal(), paramsetAdd(), SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPsetAddBoolParam().

◆ SCIPparamsetAddChar()

SCIP_RETCODE SCIPparamsetAddChar ( SCIP_PARAMSET paramset,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
char *  valueptr,
SCIP_Bool  isadvanced,
char  defaultvalue,
const char *  allowedvalues,
SCIP_DECL_PARAMCHGD((*paramchgd))  ,
SCIP_PARAMDATA paramdata 
)

creates a char parameter, sets it to its default value, and adds it to the parameter set

Parameters
paramsetparameter set
messagehdlrmessage handler
blkmemblock memory
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
allowedvaluesarray with possible parameter values, or NULL if not restricted
paramdatalocally defined parameter specific data

Definition at line 1616 of file paramset.c.

References NULL, paramCreateChar(), paramsetAdd(), SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPsetAddIntParam().

◆ SCIPparamsetAddString()

SCIP_RETCODE SCIPparamsetAddString ( SCIP_PARAMSET paramset,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
char **  valueptr,
SCIP_Bool  isadvanced,
const char *  defaultvalue,
SCIP_DECL_PARAMCHGD((*paramchgd))  ,
SCIP_PARAMDATA paramdata 
)

creates a string parameter, sets it to its default value, and adds it to the parameter set

Parameters
paramsetparameter set
messagehdlrmessage handler
blkmemblock memory
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
paramdatalocally defined parameter specific data

Definition at line 1645 of file paramset.c.

References NULL, paramCreateString(), paramsetAdd(), SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPsetAddLongintParam().

◆ SCIPparamsetIsFixed()

SCIP_Bool SCIPparamsetIsFixed ( SCIP_PARAMSET paramset,
const char *  name 
)

returns whether an existing parameter is fixed

Parameters
paramsetparameter set
namename of the parameter

Definition at line 1690 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, NULL, SCIPABORT, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamIsFixed().

Referenced by SCIPparamsetSetToSubscipsOff(), and SCIPsetAddLongintParam().

◆ SCIPparamsetGetParam()

SCIP_PARAM* SCIPparamsetGetParam ( SCIP_PARAMSET paramset,
const char *  name 
)

returns the pointer to an existing SCIP parameter

Parameters
paramsetparameter set
namename of the parameter

Definition at line 1712 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, and SCIPhashtableRetrieve().

Referenced by SCIPsetAddRealParam().

◆ SCIPparamsetGetBool()

SCIP_RETCODE SCIPparamsetGetBool ( SCIP_PARAMSET paramset,
const char *  name,
SCIP_Bool value 
)

gets the value of an existing SCIP_Bool parameter

Parameters
paramsetparameter set
namename of the parameter
valuepointer to store the parameter

Definition at line 1724 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_BOOL, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamGetBool().

Referenced by SCIPsetAddRealParam().

◆ SCIPparamsetGetInt()

SCIP_RETCODE SCIPparamsetGetInt ( SCIP_PARAMSET paramset,
const char *  name,
int *  value 
)

gets the value of an existing int parameter

Parameters
paramsetparameter set
namename of the parameter
valuepointer to store the parameter

Definition at line 1756 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_INT, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamGetInt().

Referenced by SCIPparamsetSetToSubscipsOff(), and SCIPsetAddCharParam().

◆ SCIPparamsetGetLongint()

SCIP_RETCODE SCIPparamsetGetLongint ( SCIP_PARAMSET paramset,
const char *  name,
SCIP_Longint value 
)

gets the value of an existing SCIP_Longint parameter

Parameters
paramsetparameter set
namename of the parameter
valuepointer to store the parameter

Definition at line 1788 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_LONGINT, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamGetLongint().

◆ SCIPparamsetGetReal()

SCIP_RETCODE SCIPparamsetGetReal ( SCIP_PARAMSET paramset,
const char *  name,
SCIP_Real value 
)

gets the value of an existing SCIP_Real parameter

Parameters
paramsetparameter set
namename of the parameter
valuepointer to store the parameter

Definition at line 1820 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_REAL, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamGetReal().

◆ SCIPparamsetGetChar()

SCIP_RETCODE SCIPparamsetGetChar ( SCIP_PARAMSET paramset,
const char *  name,
char *  value 
)

gets the value of an existing char parameter

Parameters
paramsetparameter set
namename of the parameter
valuepointer to store the parameter

Definition at line 1852 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_CHAR, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamGetChar().

Referenced by SCIPsetIsParamFixed().

◆ SCIPparamsetGetString()

SCIP_RETCODE SCIPparamsetGetString ( SCIP_PARAMSET paramset,
const char *  name,
char **  value 
)

gets the value of an existing string parameter

Parameters
paramsetparameter set
namename of the parameter
valuepointer to store the parameter

Definition at line 1884 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_STRING, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamGetString().

Referenced by SCIPsetGetParam().

◆ SCIPparamsetFix()

SCIP_RETCODE SCIPparamsetFix ( SCIP_PARAMSET paramset,
const char *  name,
SCIP_Bool  fixed 
)

changes the fixing status of an existing parameter

Parameters
paramsetparameter set
namename of the parameter
fixednew fixing status of the parameter

Definition at line 1916 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamSetFixed().

Referenced by SCIPparamsetSetToSubscipsOff(), and SCIPsetGetBoolParam().

◆ SCIPparamsetSetBool()

SCIP_RETCODE SCIPparamsetSetBool ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  name,
SCIP_Bool  value 
)

changes the value of an existing SCIP_Bool parameter

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
namename of the parameter
valuenew value of the parameter

Definition at line 1940 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_CALL, SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_BOOL, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPparamSetBool(), and TRUE.

Referenced by SCIPparamsetCopyParams(), and SCIPsetGetRealParam().

◆ SCIPparamsetSetInt()

SCIP_RETCODE SCIPparamsetSetInt ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  name,
int  value 
)

changes the value of an existing int parameter

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
namename of the parameter
valuenew value of the parameter

Definition at line 1974 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_CALL, SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_INT, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPparamSetInt(), and TRUE.

Referenced by SCIPsetChgBoolParam().

◆ SCIPparamsetSetLongint()

SCIP_RETCODE SCIPparamsetSetLongint ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  name,
SCIP_Longint  value 
)

changes the value of an existing SCIP_Longint parameter

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
namename of the parameter
valuenew value of the parameter

Definition at line 2008 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_CALL, SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_LONGINT, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPparamSetLongint(), and TRUE.

Referenced by SCIPsetChgIntParam().

◆ SCIPparamsetSetReal()

SCIP_RETCODE SCIPparamsetSetReal ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  name,
SCIP_Real  value 
)

changes the value of an existing SCIP_Real parameter

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
namename of the parameter
valuenew value of the parameter

Definition at line 2042 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_CALL, SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_REAL, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPparamSetReal(), and TRUE.

Referenced by SCIPsetSetDefaultIntParam().

◆ SCIPparamsetSetChar()

SCIP_RETCODE SCIPparamsetSetChar ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  name,
char  value 
)

changes the value of an existing char parameter

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
namename of the parameter
valuenew value of the parameter

Definition at line 2076 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_CALL, SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_CHAR, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPparamSetChar(), and TRUE.

Referenced by SCIPsetSetLongintParam().

◆ SCIPparamsetSetString()

SCIP_RETCODE SCIPparamsetSetString ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  name,
const char *  value 
)

changes the value of an existing string parameter

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
namename of the parameter
valuenew value of the parameter

Definition at line 2110 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_CALL, SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_STRING, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPparamSetString(), and TRUE.

Referenced by SCIPsetSetRealParam().

◆ SCIPparamsetSetDefaultBool()

SCIP_RETCODE SCIPparamsetSetDefaultBool ( SCIP_PARAMSET paramset,
const char *  name,
SCIP_Bool  defaultvalue 
)

changes the default value of an existing SCIP_Bool parameter

Parameters
paramsetparameter set
namename of the parameter
defaultvaluenew default value of the parameter

Definition at line 2144 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_BOOL, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamSetDefaultBool().

Referenced by SCIPsetGetCharParam().

◆ SCIPparamsetSetDefaultInt()

SCIP_RETCODE SCIPparamsetSetDefaultInt ( SCIP_PARAMSET paramset,
const char *  name,
int  defaultvalue 
)

changes the default value of an existing int parameter

Parameters
paramsetparameter set
namename of the parameter
defaultvaluenew default value of the parameter

Definition at line 2175 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_INT, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamSetDefaultInt().

Referenced by SCIPsetChgBoolParam().

◆ SCIPparamsetSetDefaultLongint()

SCIP_RETCODE SCIPparamsetSetDefaultLongint ( SCIP_PARAMSET paramset,
const char *  name,
SCIP_Longint  defaultvalue 
)

changes the default value of an existing SCIP_Longint parameter

Parameters
paramsetparameter set
namename of the parameter
defaultvaluenew default value of the parameter

Definition at line 2206 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_LONGINT, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamSetDefaultLongint().

◆ SCIPparamsetSetDefaultReal()

SCIP_RETCODE SCIPparamsetSetDefaultReal ( SCIP_PARAMSET paramset,
const char *  name,
SCIP_Real  defaultvalue 
)

changes the default value of an existing SCIP_Real parameter

Parameters
paramsetparameter set
namename of the parameter
defaultvaluenew default value of the parameter

Definition at line 2237 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_REAL, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamSetDefaultReal().

◆ SCIPparamsetSetDefaultChar()

SCIP_RETCODE SCIPparamsetSetDefaultChar ( SCIP_PARAMSET paramset,
const char *  name,
char  defaultvalue 
)

changes the default value of an existing char parameter

Parameters
paramsetparameter set
namename of the parameter
defaultvaluenew default value of the parameter

Definition at line 2268 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_CHAR, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamSetDefaultChar().

◆ SCIPparamsetSetDefaultString()

SCIP_RETCODE SCIPparamsetSetDefaultString ( SCIP_PARAMSET paramset,
const char *  name,
const char *  defaultvalue 
)

changes the default value of an existing string parameter

Parameters
paramsetparameter set
namename of the parameter
defaultvaluenew default value of the parameter

Definition at line 2299 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, SCIP_Param::paramtype, paramtypeGetName(), SCIP_OKAY, SCIP_PARAMETERUNKNOWN, SCIP_PARAMETERWRONGTYPE, SCIP_PARAMTYPE_STRING, SCIPerrorMessage, SCIPhashtableRetrieve(), and SCIPparamSetDefaultString().

◆ SCIPparamsetRead()

SCIP_RETCODE SCIPparamsetRead ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  filename 
)

reads parameters from a file

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
filenamefile name

Definition at line 2639 of file paramset.c.

References FALSE, NULL, paramsetParse(), SCIP_Bool, SCIP_CALL, SCIP_NOFILE, SCIP_OKAY, SCIP_READERROR, SCIPerrorMessage, and SCIPprintSysError().

Referenced by SCIPsetChgCharParam().

◆ SCIPparamsetWrite()

SCIP_RETCODE SCIPparamsetWrite ( SCIP_PARAMSET paramset,
SCIP_MESSAGEHDLR messagehdlr,
const char *  filename,
SCIP_Bool  comments,
SCIP_Bool  onlychanged 
)

writes all parameters in the parameter set to a file

Parameters
paramsetparameter set
messagehdlrmessage handler
filenamefile name, or NULL for stdout
commentsshould parameter descriptions be written as comments?
onlychangedshould only the parameters been written, that are changed from default?

Definition at line 2689 of file paramset.c.

References FALSE, SCIP_ParamSet::nparams, NULL, SCIP_ParamSet::params, paramWrite(), SCIP_Bool, SCIP_CALL, SCIP_FILECREATEERROR, SCIP_OKAY, SCIP_SUBVERSION, SCIP_VERSION, SCIPerrorMessage, SCIPmessageFPrintInfo(), SCIPmessagehdlrIsQuiet(), SCIPmessagehdlrSetQuiet(), and SCIPprintSysError().

Referenced by SCIPsetChgCharParam().

◆ SCIPparamsetSetToDefaults()

SCIP_RETCODE SCIPparamsetSetToDefaults ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr 
)

installs default values for all parameters

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler

Definition at line 2772 of file paramset.c.

References SCIP_ParamSet::nparams, SCIP_ParamSet::params, SCIP_CALL, SCIP_OKAY, and SCIPparamSetToDefault().

Referenced by SCIPparamsetSetEmphasis(), and SCIPsetChgStringParam().

◆ SCIPparamsetSetToDefault()

SCIP_RETCODE SCIPparamsetSetToDefault ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  paramname 
)

installs default value for a single parameter

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
paramnamename of the parameter

Definition at line 2790 of file paramset.c.

References SCIP_ParamSet::hashtable, NULL, paramname, SCIP_CALL, SCIP_OKAY, SCIPhashtableRetrieve(), and SCIPparamSetToDefault().

Referenced by paramsetSetHeuristicsDefault(), paramsetSetPresolvingDefault(), paramsetSetSeparatingDefault(), and SCIPsetSetCharParam().

◆ SCIPparamsetSetEmphasis()

SCIP_RETCODE SCIPparamsetSetEmphasis ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_PARAMEMPHASIS  paramemphasis,
SCIP_Bool  quiet 
)

sets parameters to

sets parameters to

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
paramemphasisparameter emphasis
quietshould the parameter be set quiet (no output)

Definition at line 3817 of file paramset.c.

References FALSE, h, SCIP_ParamSet::hashtable, NULL, paramname, paramSetBool(), paramSetChar(), paramSetInt(), paramSetReal(), paramsetSetHeuristicsAggressive(), paramsetSetHeuristicsFast(), paramsetSetHeuristicsOff(), paramsetSetPresolvingFast(), paramsetSetSeparatingAggressive(), paramsetSetSeparatingFast(), paramsetSetSeparatingOff(), SCIP_CALL, SCIP_INVALIDCALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIP_PARAMEMPHASIS_BENCHMARK, SCIP_PARAMEMPHASIS_COUNTER, SCIP_PARAMEMPHASIS_CPSOLVER, SCIP_PARAMEMPHASIS_DEFAULT, SCIP_PARAMEMPHASIS_EASYCIP, SCIP_PARAMEMPHASIS_FEASIBILITY, SCIP_PARAMEMPHASIS_HARDLP, SCIP_PARAMEMPHASIS_NUMERICS, SCIP_PARAMEMPHASIS_OPTIMALITY, SCIP_PARAMEMPHASIS_PHASEFEAS, SCIP_PARAMEMPHASIS_PHASEIMPROVE, SCIP_PARAMEMPHASIS_PHASEPROOF, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPheurGetName(), SCIPheurUsesSubscip(), SCIPparamsetSetToDefaults(), SCIPsetFindConshdlr(), SCIPsnprintf(), and TRUE.

Referenced by emphasisParse(), and SCIPsetSetStringParam().

◆ SCIPparamsetSetToSubscipsOff()

SCIP_RETCODE SCIPparamsetSetToSubscipsOff ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_Bool  quiet 
)

sets parameters to deactivate separators and heuristics that use auxiliary SCIP instances; should be called for auxiliary SCIP instances to avoid recursion

Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
quietshould the parameter be set quiet (no output)

Definition at line 4085 of file paramset.c.

References FALSE, NULL, paramname, paramSetInt(), SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPheurGetName(), SCIPheurUsesSubscip(), SCIPmessageFPrintInfo(), SCIPparamsetFix(), SCIPparamsetGetInt(), SCIPparamsetIsFixed(), SCIPsepaGetName(), SCIPsepaUsesSubscip(), SCIPsetFindConshdlr(), SCIPsnprintf(), and TRUE.

Referenced by SCIPsetReadParams().

◆ SCIPparamsetSetHeuristics()

SCIP_RETCODE SCIPparamsetSetHeuristics ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_PARAMSETTING  paramsetting,
SCIP_Bool  quiet 
)

sets heuristic parameters values to

  • SCIP_PARAMSETTING_DEFAULT which are the default values of all heuristic parameters
  • SCIP_PARAMSETTING_FAST such that the time spend for heuristic is decreased
  • SCIP_PARAMSETTING_AGGRESSIVE such that the heuristic are called more aggregative
  • SCIP_PARAMSETTING_OFF which turn off all heuristics

sets heuristic parameters values to

  • SCIP_PARAMSETTING_DEFAULT which are the default values of all heuristic parameters
  • SCIP_PARAMSETTING_FAST such that the time spent on heuristics is decreased
  • SCIP_PARAMSETTING_AGGRESSIVE such that the heuristics are called more aggressively
  • SCIP_PARAMSETTING_OFF which turn off all heuristics
Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
paramsettingparameter settings
quietshould the parameter be set quiet (no output)

Definition at line 4190 of file paramset.c.

References paramsetSetHeuristicsAggressive(), paramsetSetHeuristicsDefault(), paramsetSetHeuristicsFast(), paramsetSetHeuristicsOff(), SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, and SCIPerrorMessage.

Referenced by SCIPsetWriteParams().

◆ SCIPparamsetSetPresolving()

SCIP_RETCODE SCIPparamsetSetPresolving ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_PARAMSETTING  paramsetting,
SCIP_Bool  quiet 
)

sets presolving parameters to

  • SCIP_PARAMSETTING_DEFAULT which are the default values of all presolving parameters
  • SCIP_PARAMSETTING_FAST such that the time spend for presolving is decreased
  • SCIP_PARAMSETTING_AGGRESSIVE such that the presolving is more aggregative
  • SCIP_PARAMSETTING_OFF which turn off all presolving

sets presolving parameters to

  • SCIP_PARAMSETTING_DEFAULT which are the default values of all presolving parameters
  • SCIP_PARAMSETTING_FAST such that the time spent on presolving is decreased
  • SCIP_PARAMSETTING_AGGRESSIVE such that the presolving is more aggressive
  • SCIP_PARAMSETTING_OFF which turn off all presolving
Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
paramsettingparameter settings
quietshould the parameter be set quiet (no output)

Definition at line 4226 of file paramset.c.

References paramsetSetPresolvingAggressive(), paramsetSetPresolvingDefault(), paramsetSetPresolvingFast(), paramsetSetPresolvingOff(), SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, and SCIPerrorMessage.

Referenced by SCIPsetResetParams().

◆ SCIPparamsetSetSeparating()

SCIP_RETCODE SCIPparamsetSetSeparating ( SCIP_PARAMSET paramset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_PARAMSETTING  paramsetting,
SCIP_Bool  quiet 
)

sets separating parameters to

  • SCIP_PARAMSETTING_DEFAULT which are the default values of all separating parameters
  • SCIP_PARAMSETTING_FAST such that the time spend for separating is decreased
  • SCIP_PARAMSETTING_AGGRESSIVE such that the separating is done more aggregative
  • SCIP_PARAMSETTING_OFF which turn off all separating

sets separating parameters to

  • SCIP_PARAMSETTING_DEFAULT which are the default values of all separating parameters
  • SCIP_PARAMSETTING_FAST such that the time spent on separating is decreased
  • SCIP_PARAMSETTING_AGGRESSIVE such that separating is more aggressive
  • SCIP_PARAMSETTING_OFF which turn off all separating
Parameters
paramsetparameter set
setglobal SCIP settings
messagehdlrmessage handler
paramsettingparameter settings
quietshould the parameter be set quiet (no output)

Definition at line 4262 of file paramset.c.

References paramsetSetSeparatingAggressive(), paramsetSetSeparatingDefault(), paramsetSetSeparatingFast(), paramsetSetSeparatingOff(), SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, and SCIPerrorMessage.

Referenced by SCIPsetResetParams().

◆ SCIPparamsetGetParams()

SCIP_PARAM** SCIPparamsetGetParams ( SCIP_PARAMSET paramset)

returns the array of parameters

Parameters
paramsetparameter set

Definition at line 4293 of file paramset.c.

References NULL, and SCIP_ParamSet::params.

Referenced by SCIPsetSetEmphasis().

◆ SCIPparamsetGetNParams()

int SCIPparamsetGetNParams ( SCIP_PARAMSET paramset)

returns the number of parameters in the parameter set

Parameters
paramsetparameter set

Definition at line 4303 of file paramset.c.

References SCIP_ParamSet::nparams, and NULL.

Referenced by SCIPsetSetSubscipsOff().

◆ SCIPparamsetCopyParams()

SCIP_RETCODE SCIPparamsetCopyParams ( SCIP_PARAMSET sourceparamset,
SCIP_PARAMSET targetparamset,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr 
)

copies all parameter values of the source parameter set to the corresponding parameters in the target set

copies all parameter values of the source parameter set to the corresponding parameters in the target set

by default reoptimization is disabled after copying the parameters. if you want to use reoptimization, you have to enable it explicitly.

Parameters
sourceparamsetsource parameter set
targetparamsettarget parameter set
setglobal SCIP settings of target SCIP
messagehdlrmessage handler of target SCIP

Definition at line 4317 of file paramset.c.

References FALSE, SCIP_ParamSet::hashtable, SCIP_Param::name, SCIP_ParamSet::nparams, NULL, paramCopyBool(), paramCopyChar(), paramCopyInt(), paramCopyLongint(), paramCopyReal(), paramCopyString(), paramname, SCIP_ParamSet::params, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_PARAMTYPE_BOOL, SCIP_PARAMTYPE_CHAR, SCIP_PARAMTYPE_INT, SCIP_PARAMTYPE_LONGINT, SCIP_PARAMTYPE_REAL, SCIP_PARAMTYPE_STRING, SCIPerrorMessage, SCIPhashtableRetrieve(), SCIPparamGetName(), SCIPparamGetType(), SCIPparamIsFixed(), SCIPparamSetFixed(), SCIPparamsetSetBool(), SCIPsetChgParamFixed(), SCIPsetIsParamFixed(), and SCIPsetSetReoptimizationParams().

Referenced by SCIPsetCopyPlugins().

◆ SCIPparamIsValidBool()

SCIP_Bool SCIPparamIsValidBool ( SCIP_PARAM param,
SCIP_Bool  value 
)

checks whether value of SCIP_Bool parameter is valid

checks whether value of bool parameter is valid

Parameters
paramparameter
valuevalue to check

Definition at line 4422 of file paramset.c.

References FALSE, NULL, and TRUE.

Referenced by SCIPisBoolParamValid().

◆ SCIPparamIsValidInt()

SCIP_Bool SCIPparamIsValidInt ( SCIP_PARAM param,
int  value 
)

checks whether value of integer parameter is valid

Parameters
paramparameter
valuevalue to check

Definition at line 4432 of file paramset.c.

References SCIP_Param::data, SCIP_Param::intparam, SCIP_IntParam::minvalue, and NULL.

Referenced by SCIPisIntParamValid().

◆ SCIPparamIsValidLongint()

SCIP_Bool SCIPparamIsValidLongint ( SCIP_PARAM param,
SCIP_Longint  value 
)

checks whether value of SCIP_Longint parameter is valid

Parameters
paramparameter
valuevalue to check

Definition at line 4443 of file paramset.c.

References SCIP_Param::data, SCIP_Param::longintparam, SCIP_LongintParam::minvalue, and NULL.

Referenced by SCIPisLongintParamValid().

◆ SCIPparamIsValidReal()

SCIP_Bool SCIPparamIsValidReal ( SCIP_PARAM param,
SCIP_Real  value 
)

checks whether value of SCIP_Real parameter is valid

Parameters
paramparameter
valuevalue to check

Definition at line 4454 of file paramset.c.

References SCIP_Param::data, SCIP_RealParam::minvalue, NULL, and SCIP_Param::realparam.

Referenced by SCIPisRealParamValid().

◆ SCIPparamIsValidChar()

SCIP_Bool SCIPparamIsValidChar ( SCIP_PARAM param,
const char  value 
)

checks whether value of char parameter is valid

Parameters
paramparameter
valuevalue to check

Definition at line 4465 of file paramset.c.

References SCIP_CharParam::allowedvalues, SCIP_Param::charparam, SCIP_Param::data, FALSE, NULL, and TRUE.

Referenced by SCIPisCharParamValid().

◆ SCIPparamIsValidString()

SCIP_Bool SCIPparamIsValidString ( SCIP_PARAM param,
const char *  value 
)

checks whether value of string parameter is valid

Parameters
paramparameter
valuevalue to check

Definition at line 4491 of file paramset.c.

References FALSE, NULL, and TRUE.

Referenced by SCIPisStringParamValid().

◆ SCIPparamSetBool()

SCIP_RETCODE SCIPparamSetBool ( SCIP_PARAM param,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_Bool  value,
SCIP_Bool  initialize,
SCIP_Bool  quiet 
)

sets value of SCIP_Bool parameter

Parameters
paramparameter
setglobal SCIP settings, or NULL if param change method should not be called
messagehdlrmessage handler
valuenew value of the parameter
initializeis this the initialization of the parameter?
quietshould the parameter be set quiet (no output)

Definition at line 4509 of file paramset.c.

References SCIP_Param::boolparam, SCIP_BoolParam::curvalue, SCIP_Param::data, FALSE, NULL, paramTestBool(), paramTestFixed(), paramWrite(), SCIP_Bool, SCIP_CALL, SCIP_CALL_QUIET, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIPparamGetBool(), TRUE, and SCIP_BoolParam::valueptr.

Referenced by paramCopyBool(), paramCreateBool(), paramParseBool(), paramSetBool(), SCIPparamsetSetBool(), and SCIPparamSetToDefault().

◆ SCIPparamSetInt()

SCIP_RETCODE SCIPparamSetInt ( SCIP_PARAM param,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
int  value,
SCIP_Bool  initialize,
SCIP_Bool  quiet 
)

sets value of int parameter

Parameters
paramparameter
setglobal SCIP settings, or NULL if param change method should not be called
messagehdlrmessage handler
valuenew value of the parameter
initializeis this the initialization of the parameter?
quietshould the parameter be set quiet (no output)

Definition at line 4571 of file paramset.c.

References SCIP_IntParam::curvalue, SCIP_Param::data, FALSE, SCIP_Param::intparam, NULL, paramTestFixed(), paramTestInt(), paramWrite(), SCIP_CALL, SCIP_CALL_QUIET, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIPparamGetInt(), TRUE, and SCIP_IntParam::valueptr.

Referenced by paramCopyInt(), paramCreateInt(), paramParseInt(), paramSetInt(), SCIPparamsetSetInt(), SCIPparamSetToDefault(), and SCIPsetGetStringParam().

◆ SCIPparamSetLongint()

SCIP_RETCODE SCIPparamSetLongint ( SCIP_PARAM param,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_Longint  value,
SCIP_Bool  initialize,
SCIP_Bool  quiet 
)

sets value of SCIP_Longint parameter

Parameters
paramparameter
setglobal SCIP settings, or NULL if param change method should not be called
messagehdlrmessage handler
valuenew value of the parameter
initializeis this the initialization of the parameter?
quietshould the parameter be set quiet (no output)

Definition at line 4633 of file paramset.c.

References SCIP_LongintParam::curvalue, SCIP_Param::data, FALSE, SCIP_Param::longintparam, NULL, paramTestFixed(), paramTestLongint(), paramWrite(), SCIP_CALL, SCIP_CALL_QUIET, SCIP_Longint, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIPparamGetLongint(), TRUE, and SCIP_LongintParam::valueptr.

Referenced by paramCopyLongint(), paramCreateLongint(), paramParseLongint(), paramSetLongint(), SCIPparamsetSetLongint(), and SCIPparamSetToDefault().

◆ SCIPparamSetReal()

SCIP_RETCODE SCIPparamSetReal ( SCIP_PARAM param,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_Real  value,
SCIP_Bool  initialize,
SCIP_Bool  quiet 
)

sets value of SCIP_Real parameter

Parameters
paramparameter
setglobal SCIP settings, or NULL if param change method should not be called
messagehdlrmessage handler
valuenew value of the parameter
initializeis this the initialization of the parameter?
quietshould the parameter be set quiet (no output)

Definition at line 4695 of file paramset.c.

References SCIP_RealParam::curvalue, SCIP_Param::data, FALSE, MAX, NULL, paramTestFixed(), paramTestReal(), paramWrite(), SCIP_Param::realparam, SCIP_CALL, SCIP_CALL_QUIET, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIP_Real, SCIP_REAL_MAX, SCIP_REAL_MIN, SCIPparamGetReal(), TRUE, and SCIP_RealParam::valueptr.

Referenced by paramCopyReal(), paramCreateReal(), paramParseReal(), paramSetReal(), SCIPparamsetSetReal(), and SCIPparamSetToDefault().

◆ SCIPparamSetChar()

SCIP_RETCODE SCIPparamSetChar ( SCIP_PARAM param,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
char  value,
SCIP_Bool  initialize,
SCIP_Bool  quiet 
)

sets value of char parameter

Parameters
paramparameter
setglobal SCIP settings, or NULL if param change method should not be called
messagehdlrmessage handler
valuenew value of the parameter
initializeis this the initialization of the parameter?
quietshould the parameter be set quiet (no output)

Definition at line 4759 of file paramset.c.

References SCIP_Param::charparam, SCIP_CharParam::curvalue, SCIP_Param::data, FALSE, NULL, paramTestChar(), paramTestFixed(), paramWrite(), SCIP_CALL, SCIP_CALL_QUIET, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIPparamGetChar(), TRUE, and SCIP_CharParam::valueptr.

Referenced by paramCopyChar(), paramCreateChar(), paramParseChar(), paramSetChar(), SCIPparamsetSetChar(), SCIPparamSetToDefault(), and SCIPsetChgLongintParam().

◆ SCIPparamSetString()

SCIP_RETCODE SCIPparamSetString ( SCIP_PARAM param,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  value,
SCIP_Bool  initialize,
SCIP_Bool  quiet 
)

sets value of string parameter

Parameters
paramparameter
setglobal SCIP settings, or NULL if param change method should not be called
messagehdlrmessage handler
valuenew value of the parameter
initializeis this the initialization of the parameter?
quietshould the parameter be set quiet (no output)

Definition at line 4820 of file paramset.c.

References BMSduplicateMemoryArray, BMSfreeMemoryArrayNull, SCIP_StringParam::curvalue, SCIP_Param::data, FALSE, NULL, paramTestFixed(), paramTestString(), paramWrite(), SCIP_ALLOC, SCIP_CALL, SCIP_CALL_QUIET, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIP_Param::stringparam, TRUE, and SCIP_StringParam::valueptr.

Referenced by paramCopyString(), paramCreateString(), paramParseString(), SCIPparamsetSetString(), SCIPparamSetToDefault(), and SCIPsetChgRealParam().

◆ SCIPparamSetDefaultBool()

void SCIPparamSetDefaultBool ( SCIP_PARAM param,
SCIP_Bool  defaultvalue 
)

sets default value of SCIP_Bool parameter

changes default value of SCIP_Bool parameter

Parameters
paramparameter
defaultvaluenew default value

Definition at line 4891 of file paramset.c.

References SCIP_Param::boolparam, SCIP_Param::data, SCIP_BoolParam::defaultvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_BOOL.

Referenced by SCIPparamsetSetDefaultBool().

◆ SCIPparamSetDefaultInt()

void SCIPparamSetDefaultInt ( SCIP_PARAM param,
int  defaultvalue 
)

sets default value of int parameter

changes default value of int parameter

Parameters
paramparameter
defaultvaluenew default value

Definition at line 4903 of file paramset.c.

References SCIP_Param::data, SCIP_IntParam::defaultvalue, SCIP_Param::intparam, SCIP_IntParam::maxvalue, SCIP_IntParam::minvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_INT.

Referenced by SCIPparamsetSetDefaultInt().

◆ SCIPparamSetDefaultLongint()

void SCIPparamSetDefaultLongint ( SCIP_PARAM param,
SCIP_Longint  defaultvalue 
)

sets default value of SCIP_Longint parameter

Parameters
paramparameter
defaultvaluenew default value

Definition at line 4917 of file paramset.c.

References SCIP_Param::data, SCIP_LongintParam::defaultvalue, SCIP_Param::longintparam, SCIP_LongintParam::maxvalue, SCIP_LongintParam::minvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_LONGINT.

Referenced by SCIPparamsetSetDefaultLongint().

◆ SCIPparamSetDefaultReal()

void SCIPparamSetDefaultReal ( SCIP_PARAM param,
SCIP_Real  defaultvalue 
)

sets default value of SCIP_Real parameter

Parameters
paramparameter
defaultvaluenew default value

Definition at line 4931 of file paramset.c.

References SCIP_Param::data, SCIP_RealParam::defaultvalue, SCIP_RealParam::maxvalue, SCIP_RealParam::minvalue, NULL, SCIP_Param::paramtype, SCIP_Param::realparam, and SCIP_PARAMTYPE_REAL.

Referenced by SCIPparamsetSetDefaultReal().

◆ SCIPparamSetDefaultChar()

void SCIPparamSetDefaultChar ( SCIP_PARAM param,
char  defaultvalue 
)

sets default value of char parameter

Parameters
paramparameter
defaultvaluenew default value

Definition at line 4945 of file paramset.c.

References SCIP_Param::charparam, SCIP_Param::data, SCIP_CharParam::defaultvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_CHAR.

Referenced by SCIPparamsetSetDefaultChar().

◆ SCIPparamSetDefaultString()

void SCIPparamSetDefaultString ( SCIP_PARAM param,
const char *  defaultvalue 
)

sets default value of string parameter

Parameters
paramparameter
defaultvaluenew default value

Definition at line 4957 of file paramset.c.

References BMSduplicateMemoryArray, BMSfreeMemoryArray, SCIP_Param::data, SCIP_StringParam::defaultvalue, NULL, SCIP_Param::paramtype, SCIP_ALLOC_ABORT, SCIP_PARAMTYPE_STRING, and SCIP_Param::stringparam.

Referenced by SCIPparamsetSetDefaultString().

◆ SCIPparamSetToDefault()

◆ SCIPparamWrite()

SCIP_RETCODE SCIPparamWrite ( SCIP_PARAM param,
SCIP_MESSAGEHDLR messagehdlr,
const char *  filename,
SCIP_Bool  comments,
SCIP_Bool  onlychanged 
)

writes a single parameter to a file

Parameters
paramparameter
messagehdlrmessage handler
filenamefile name, or NULL for stdout
commentsshould parameter descriptions be written as comments?
onlychangedshould only the parameters been written, that are changed from default?

Definition at line 5021 of file paramset.c.

References NULL, paramWrite(), SCIP_CALL, SCIP_FILECREATEERROR, SCIP_OKAY, SCIPerrorMessage, and SCIPprintSysError().

Referenced by SCIPwriteParam().