Detailed Description
public methods for handling parameter settings
Definition in file pub_paramset.h.
Go to the source code of this file.
Function Documentation
◆ SCIPparamGetType()
SCIP_EXPORT SCIP_PARAMTYPE SCIPparamGetType | ( | SCIP_PARAM * | param | ) |
returns type of parameter
- Parameters
-
param parameter
Definition at line 640 of file paramset.c.
References NULL, and SCIP_Param::paramtype.
Referenced by checkTransferBoolParam(), paramSetBool(), paramSetChar(), paramSetInt(), paramSetLongint(), paramSetReal(), paramsetSetHeuristicsAggressive(), paramsetSetPresolvingAggressive(), paramsetSetPresolvingFast(), paramsetSetSeparatingAggressive(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), and SCIPparamsetCopyParams().
◆ SCIPparamGetName()
SCIP_EXPORT const char* SCIPparamGetName | ( | SCIP_PARAM * | param | ) |
returns name of parameter
- Parameters
-
param parameter
Definition at line 650 of file paramset.c.
References SCIP_Param::name, and NULL.
Referenced by checkTransferBoolParam(), fixOrUnfixRelevantParameters(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPparamsetCopyParams().
◆ SCIPparamGetDesc()
SCIP_EXPORT const char* SCIPparamGetDesc | ( | SCIP_PARAM * | param | ) |
returns description of parameter
- Parameters
-
param parameter
Definition at line 660 of file paramset.c.
References SCIP_Param::desc, and NULL.
Referenced by addFixParamDialog(), addSetParamDialog(), and SCIP_DECL_DIALOGDESC().
◆ SCIPparamGetData()
SCIP_EXPORT SCIP_PARAMDATA* SCIPparamGetData | ( | SCIP_PARAM * | param | ) |
returns locally defined parameter specific data
- Parameters
-
param parameter
Definition at line 670 of file paramset.c.
References NULL, and SCIP_Param::paramdata.
Referenced by SCIP_DECL_PARAMCHGD().
◆ SCIPparamIsAdvanced()
SCIP_EXPORT SCIP_Bool SCIPparamIsAdvanced | ( | SCIP_PARAM * | param | ) |
returns whether parameter is advanced
- Parameters
-
param parameter
Definition at line 680 of file paramset.c.
References SCIP_Param::isadvanced, and NULL.
Referenced by addFixParamDialog(), addSetParamDialog(), and paramWrite().
◆ SCIPparamIsFixed()
SCIP_EXPORT SCIP_Bool SCIPparamIsFixed | ( | SCIP_PARAM * | param | ) |
returns whether parameter is fixed
- Parameters
-
param parameter
Definition at line 690 of file paramset.c.
References SCIP_Param::isfixed, and NULL.
Referenced by fixOrUnfixRelevantParameters(), paramSetBool(), paramSetChar(), paramSetInt(), paramSetLongint(), paramSetReal(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamsetCopyParams(), SCIPparamsetIsFixed(), and SCIPparamSetToDefault().
◆ SCIPparamSetFixed()
SCIP_EXPORT void SCIPparamSetFixed | ( | SCIP_PARAM * | param, |
SCIP_Bool | fixed | ||
) |
sets fixing status of given parameter
- Parameters
-
param parameter fixed new fixing status of the parameter
Definition at line 4330 of file paramset.c.
References SCIP_Param::isfixed, and NULL.
Referenced by paramsetParse(), SCIP_DECL_DIALOGEXEC(), SCIPparamsetCopyParams(), and SCIPparamsetFix().
◆ SCIPparamGetBool()
SCIP_EXPORT SCIP_Bool SCIPparamGetBool | ( | SCIP_PARAM * | param | ) |
returns value of SCIP_Bool parameter
- Parameters
-
param parameter
Definition at line 700 of file paramset.c.
References SCIP_Param::boolparam, SCIP_BoolParam::curvalue, SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_BOOL, and SCIP_BoolParam::valueptr.
Referenced by paramCopyBool(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PARAMCHGD(), SCIPparamIsDefault(), and SCIPparamsetGetBool().
◆ SCIPparamGetBoolDefault()
SCIP_EXPORT SCIP_Bool SCIPparamGetBoolDefault | ( | SCIP_PARAM * | param | ) |
returns default value of SCIP_Bool parameter
- Parameters
-
param parameter
Definition at line 714 of file paramset.c.
References SCIP_Param::boolparam, SCIP_Param::data, SCIP_BoolParam::defaultvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_BOOL.
Referenced by SCIPparamIsDefault(), and SCIPparamSetToDefault().
◆ SCIPparamGetInt()
SCIP_EXPORT int SCIPparamGetInt | ( | SCIP_PARAM * | param | ) |
returns value of int parameter
- Parameters
-
param parameter
Definition at line 725 of file paramset.c.
References SCIP_IntParam::curvalue, SCIP_Param::data, SCIP_Param::intparam, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_INT, and SCIP_IntParam::valueptr.
Referenced by paramCopyInt(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PARAMCHGD(), SCIPparamIsDefault(), and SCIPparamsetGetInt().
◆ SCIPparamGetIntMin()
SCIP_EXPORT int SCIPparamGetIntMin | ( | SCIP_PARAM * | param | ) |
returns minimal value of int parameter
- Parameters
-
param parameter
Definition at line 739 of file paramset.c.
References SCIP_Param::data, SCIP_Param::intparam, SCIP_IntParam::minvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_INT.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPparamGetIntMax()
SCIP_EXPORT int SCIPparamGetIntMax | ( | SCIP_PARAM * | param | ) |
returns maximal value of int parameter
- Parameters
-
param parameter
Definition at line 750 of file paramset.c.
References SCIP_Param::data, SCIP_Param::intparam, SCIP_IntParam::maxvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_INT.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPparamGetIntDefault()
SCIP_EXPORT int SCIPparamGetIntDefault | ( | SCIP_PARAM * | param | ) |
returns default value of int parameter
- Parameters
-
param parameter
Definition at line 761 of file paramset.c.
References SCIP_Param::data, SCIP_IntParam::defaultvalue, SCIP_Param::intparam, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_INT.
Referenced by paramsetSetHeuristicsAggressive(), paramsetSetPresolvingAggressive(), paramsetSetSeparatingAggressive(), SCIPparamIsDefault(), and SCIPparamSetToDefault().
◆ SCIPparamGetLongint()
SCIP_EXPORT SCIP_Longint SCIPparamGetLongint | ( | SCIP_PARAM * | param | ) |
returns value of SCIP_Longint parameter
- Parameters
-
param parameter
Definition at line 772 of file paramset.c.
References SCIP_LongintParam::curvalue, SCIP_Param::data, SCIP_Param::longintparam, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_LONGINT, and SCIP_LongintParam::valueptr.
Referenced by paramCopyLongint(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamIsDefault(), and SCIPparamsetGetLongint().
◆ SCIPparamGetLongintMin()
SCIP_EXPORT SCIP_Longint SCIPparamGetLongintMin | ( | SCIP_PARAM * | param | ) |
returns minimal value of longint parameter
- Parameters
-
param parameter
Definition at line 786 of file paramset.c.
References SCIP_Param::data, SCIP_Param::longintparam, SCIP_LongintParam::minvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_LONGINT.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPparamGetLongintMax()
SCIP_EXPORT SCIP_Longint SCIPparamGetLongintMax | ( | SCIP_PARAM * | param | ) |
returns maximal value of longint parameter
- Parameters
-
param parameter
Definition at line 797 of file paramset.c.
References SCIP_Param::data, SCIP_Param::longintparam, SCIP_LongintParam::maxvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_LONGINT.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPparamGetLongintDefault()
SCIP_EXPORT SCIP_Longint SCIPparamGetLongintDefault | ( | SCIP_PARAM * | param | ) |
returns default value of SCIP_Longint parameter
- Parameters
-
param parameter
Definition at line 808 of file paramset.c.
References SCIP_Param::data, SCIP_LongintParam::defaultvalue, SCIP_Param::longintparam, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_LONGINT.
Referenced by SCIPparamIsDefault(), and SCIPparamSetToDefault().
◆ SCIPparamGetReal()
SCIP_EXPORT SCIP_Real SCIPparamGetReal | ( | SCIP_PARAM * | param | ) |
returns value of SCIP_Real parameter
- Parameters
-
param parameter
Definition at line 819 of file paramset.c.
References SCIP_RealParam::curvalue, SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_Param::realparam, SCIP_PARAMTYPE_REAL, and SCIP_RealParam::valueptr.
Referenced by calcGrowSize(), paramCopyReal(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PARAMCHGD(), SCIPparamIsDefault(), and SCIPparamsetGetReal().
◆ SCIPparamGetRealMin()
SCIP_EXPORT SCIP_Real SCIPparamGetRealMin | ( | SCIP_PARAM * | param | ) |
returns minimal value of real parameter
- Parameters
-
param parameter
Definition at line 833 of file paramset.c.
References SCIP_Param::data, SCIP_RealParam::minvalue, NULL, SCIP_Param::paramtype, SCIP_Param::realparam, and SCIP_PARAMTYPE_REAL.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPparamGetRealMax()
SCIP_EXPORT SCIP_Real SCIPparamGetRealMax | ( | SCIP_PARAM * | param | ) |
returns maximal value of real parameter
- Parameters
-
param parameter
Definition at line 844 of file paramset.c.
References SCIP_Param::data, SCIP_RealParam::maxvalue, NULL, SCIP_Param::paramtype, SCIP_Param::realparam, and SCIP_PARAMTYPE_REAL.
Referenced by copyMemoryAndTimeLimits(), and SCIP_DECL_DIALOGEXEC().
◆ SCIPparamGetRealDefault()
SCIP_EXPORT SCIP_Real SCIPparamGetRealDefault | ( | SCIP_PARAM * | param | ) |
returns default value of SCIP_Real parameter
- Parameters
-
param parameter
Definition at line 855 of file paramset.c.
References SCIP_Param::data, SCIP_RealParam::defaultvalue, NULL, SCIP_Param::paramtype, SCIP_Param::realparam, and SCIP_PARAMTYPE_REAL.
Referenced by paramsetSetHeuristicsAggressive(), SCIPparamIsDefault(), and SCIPparamSetToDefault().
◆ SCIPparamGetChar()
SCIP_EXPORT char SCIPparamGetChar | ( | SCIP_PARAM * | param | ) |
returns value of char parameter
- Parameters
-
param parameter
Definition at line 866 of file paramset.c.
References SCIP_Param::charparam, SCIP_CharParam::curvalue, SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_CHAR, and SCIP_CharParam::valueptr.
Referenced by paramCopyChar(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamIsDefault(), and SCIPparamsetGetChar().
◆ SCIPparamGetCharAllowedValues()
SCIP_EXPORT char* SCIPparamGetCharAllowedValues | ( | SCIP_PARAM * | param | ) |
returns allowed values of char parameter, or NULL if everything is allowed
- Parameters
-
param parameter
Definition at line 880 of file paramset.c.
References SCIP_CharParam::allowedvalues, SCIP_Param::charparam, SCIP_Param::data, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_CHAR.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPparamGetCharDefault()
SCIP_EXPORT char SCIPparamGetCharDefault | ( | SCIP_PARAM * | param | ) |
returns default value of char parameter
- Parameters
-
param parameter
Definition at line 891 of file paramset.c.
References SCIP_Param::charparam, SCIP_Param::data, SCIP_CharParam::defaultvalue, NULL, SCIP_Param::paramtype, and SCIP_PARAMTYPE_CHAR.
Referenced by SCIPparamIsDefault(), and SCIPparamSetToDefault().
◆ SCIPparamGetString()
SCIP_EXPORT char* SCIPparamGetString | ( | SCIP_PARAM * | param | ) |
returns value of string parameter
- Parameters
-
param parameter
Definition at line 902 of file paramset.c.
References SCIP_StringParam::curvalue, SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_STRING, SCIP_Param::stringparam, and SCIP_StringParam::valueptr.
Referenced by paramCopyString(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamIsDefault(), and SCIPparamsetGetString().
◆ SCIPparamGetStringDefault()
SCIP_EXPORT char* SCIPparamGetStringDefault | ( | SCIP_PARAM * | param | ) |
returns default value of String parameter
- Parameters
-
param parameter
Definition at line 916 of file paramset.c.
References SCIP_Param::data, SCIP_StringParam::defaultvalue, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_STRING, and SCIP_Param::stringparam.
Referenced by SCIPparamIsDefault(), and SCIPparamSetToDefault().
◆ SCIPparamIsDefault()
SCIP_EXPORT SCIP_Bool SCIPparamIsDefault | ( | SCIP_PARAM * | param | ) |
returns whether the parameter is on its default setting
- Parameters
-
param parameter
Definition at line 927 of file paramset.c.
References EPSZ, FALSE, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_BOOL, SCIP_PARAMTYPE_CHAR, SCIP_PARAMTYPE_INT, SCIP_PARAMTYPE_LONGINT, SCIP_PARAMTYPE_REAL, SCIP_PARAMTYPE_STRING, SCIPABORT, SCIPerrorMessage, SCIPparamGetBool(), SCIPparamGetBoolDefault(), SCIPparamGetChar(), SCIPparamGetCharDefault(), SCIPparamGetInt(), SCIPparamGetIntDefault(), SCIPparamGetLongint(), SCIPparamGetLongintDefault(), SCIPparamGetReal(), SCIPparamGetRealDefault(), SCIPparamGetString(), and SCIPparamGetStringDefault().
Referenced by collectNondefaultParams(), and paramWrite().