Detailed Description

public methods for handling parameter settings

Author: Tobias Achterberg

#include "scip/def.h"
#include "scip/type_paramset.h"
#include "scip/type_scip.h"

Functions
SCIP_PARAMTYPE	SCIPparamGetType (SCIP_PARAM *param)
const char *	SCIPparamGetName (SCIP_PARAM *param)
const char *	SCIPparamGetDesc (SCIP_PARAM *param)
SCIP_PARAMDATA *	SCIPparamGetData (SCIP_PARAM *param)
SCIP_Bool	SCIPparamIsAdvanced (SCIP_PARAM *param)
SCIP_Bool	SCIPparamIsFixed (SCIP_PARAM *param)
void	SCIPparamSetFixed (SCIP_PARAM *param, SCIP_Bool fixed)
SCIP_Bool	SCIPparamGetBool (SCIP_PARAM *param)
SCIP_Bool	SCIPparamGetBoolDefault (SCIP_PARAM *param)
int	SCIPparamGetInt (SCIP_PARAM *param)
int	SCIPparamGetIntMin (SCIP_PARAM *param)
int	SCIPparamGetIntMax (SCIP_PARAM *param)
int	SCIPparamGetIntDefault (SCIP_PARAM *param)
SCIP_Longint	SCIPparamGetLongint (SCIP_PARAM *param)
SCIP_Longint	SCIPparamGetLongintMin (SCIP_PARAM *param)
SCIP_Longint	SCIPparamGetLongintMax (SCIP_PARAM *param)
SCIP_Longint	SCIPparamGetLongintDefault (SCIP_PARAM *param)
SCIP_Real	SCIPparamGetReal (SCIP_PARAM *param)
SCIP_Real	SCIPparamGetRealMin (SCIP_PARAM *param)
SCIP_Real	SCIPparamGetRealMax (SCIP_PARAM *param)
SCIP_Real	SCIPparamGetRealDefault (SCIP_PARAM *param)
char	SCIPparamGetChar (SCIP_PARAM *param)
char *	SCIPparamGetCharAllowedValues (SCIP_PARAM *param)
char	SCIPparamGetCharDefault (SCIP_PARAM *param)
char *	SCIPparamGetString (SCIP_PARAM *param)
char *	SCIPparamGetStringDefault (SCIP_PARAM *param)
SCIP_Bool	SCIPparamIsDefault (SCIP_PARAM *param)

Function Documentation

◆ SCIPparamGetType()

SCIP_PARAMTYPE SCIPparamGetType ( SCIP_PARAM * param )

returns type of parameter

Parameters

param parameter

Definition at line 646 of file paramset.c.

References assert(), NULL, SCIP_Param::paramtype, and SCIPparamGetType().

Referenced by checkTransferBoolParam(), paramSetBool(), paramSetChar(), paramSetInt(), paramSetLongint(), paramSetReal(), paramsetSetHeuristicsAggressive(), paramsetSetPresolvingAggressive(), paramsetSetPresolvingFast(), paramsetSetSeparatingAggressive(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamGetType(), and SCIPparamsetCopyParams().

◆ SCIPparamGetName()

const char * SCIPparamGetName ( SCIP_PARAM * param )

returns name of parameter

Parameters

param parameter

Definition at line 656 of file paramset.c.

References assert(), SCIP_Param::name, NULL, and SCIPparamGetName().

Referenced by checkTransferBoolParam(), fixOrUnfixRelevantParameters(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), SCIPparamGetName(), and SCIPparamsetCopyParams().

◆ SCIPparamGetDesc()

const char * SCIPparamGetDesc ( SCIP_PARAM * param )

returns description of parameter

Parameters

param parameter

Definition at line 666 of file paramset.c.

References assert(), SCIP_Param::desc, NULL, and SCIPparamGetDesc().

Referenced by addFixParamDialog(), addSetParamDialog(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGDESC(), and SCIPparamGetDesc().

◆ SCIPparamGetData()

SCIP_PARAMDATA * SCIPparamGetData ( SCIP_PARAM * param )

returns locally defined parameter specific data

Parameters

param parameter

Definition at line 676 of file paramset.c.

References assert(), NULL, SCIP_Param::paramdata, and SCIPparamGetData().

Referenced by SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), and SCIPparamGetData().

◆ SCIPparamIsAdvanced()

SCIP_Bool SCIPparamIsAdvanced ( SCIP_PARAM * param )

returns whether parameter is advanced

Parameters

param parameter

Definition at line 686 of file paramset.c.

References assert(), SCIP_Param::isadvanced, NULL, SCIP_Bool, and SCIPparamIsAdvanced().

Referenced by addFixParamDialog(), addSetParamDialog(), paramWrite(), and SCIPparamIsAdvanced().

◆ SCIPparamIsFixed()

SCIP_Bool SCIPparamIsFixed ( SCIP_PARAM * param )

returns whether parameter is fixed

Parameters

param parameter

Definition at line 696 of file paramset.c.

References assert(), SCIP_Param::isfixed, NULL, SCIP_Bool, and SCIPparamIsFixed().

Referenced by fixOrUnfixRelevantParameters(), paramSetBool(), paramSetChar(), paramSetInt(), paramSetLongint(), paramSetReal(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamIsFixed(), SCIPparamsetCopyParams(), SCIPparamsetIsFixed(), and SCIPparamSetToDefault().

◆ SCIPparamSetFixed()

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 4529 of file paramset.c.

References assert(), SCIP_Param::isfixed, NULL, SCIP_Bool, and SCIPparamSetFixed().

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPparamsetCopyParams(), SCIPparamsetFix(), SCIPparamSetFixed(), and SCIPparamsetSet().

◆ SCIPparamGetBool()

SCIP_Bool SCIPparamGetBool ( SCIP_PARAM * param )

returns value of SCIP_Bool parameter

Parameters

param parameter

Definition at line 706 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_Bool, SCIP_PARAMTYPE_BOOL, and SCIPparamGetBool().

Referenced by paramCopyBool(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PARAMCHGD(), SCIPparamGetBool(), SCIPparamIsDefault(), SCIPparamSetBool(), SCIPparamsetGetBool(), and tryAddOrbitalRedLexRed().

◆ SCIPparamGetBoolDefault()

SCIP_Bool SCIPparamGetBoolDefault ( SCIP_PARAM * param )

returns default value of SCIP_Bool parameter

Parameters

param parameter

Definition at line 720 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_Bool, SCIP_PARAMTYPE_BOOL, and SCIPparamGetBoolDefault().

Referenced by SCIPparamGetBoolDefault(), SCIPparamIsDefault(), and SCIPparamSetToDefault().

◆ SCIPparamGetInt()

int SCIPparamGetInt ( SCIP_PARAM * param )

returns value of int parameter

Parameters

param parameter

Definition at line 731 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_INT, and SCIPparamGetInt().

◆ SCIPparamGetIntMin()

int SCIPparamGetIntMin ( SCIP_PARAM * param )

returns minimal value of int parameter

Parameters

param parameter

Definition at line 745 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_INT, and SCIPparamGetIntMin().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPparamGetIntMin().

◆ SCIPparamGetIntMax()

int SCIPparamGetIntMax ( SCIP_PARAM * param )

returns maximal value of int parameter

Parameters

param parameter

Definition at line 756 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_INT, and SCIPparamGetIntMax().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPparamGetIntMax().

◆ SCIPparamGetIntDefault()

int SCIPparamGetIntDefault ( SCIP_PARAM * param )

returns default value of int parameter

Parameters

param parameter

Definition at line 767 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_INT, and SCIPparamGetIntDefault().

Referenced by paramsetSetHeuristicsAggressive(), paramsetSetPresolvingAggressive(), paramsetSetSeparatingAggressive(), SCIP_DECL_NLPICREATEPROBLEM(), SCIPparamGetIntDefault(), SCIPparamIsDefault(), and SCIPparamSetToDefault().

◆ SCIPparamGetLongint()

SCIP_Longint SCIPparamGetLongint ( SCIP_PARAM * param )

returns value of SCIP_Longint parameter

Parameters

param parameter

Definition at line 778 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_Longint, SCIP_PARAMTYPE_LONGINT, and SCIPparamGetLongint().

Referenced by paramCopyLongint(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamGetLongint(), SCIPparamIsDefault(), SCIPparamsetGetLongint(), and SCIPparamSetLongint().

◆ SCIPparamGetLongintMin()

SCIP_Longint SCIPparamGetLongintMin ( SCIP_PARAM * param )

returns minimal value of longint parameter

Parameters

param parameter

Definition at line 792 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_Longint, SCIP_PARAMTYPE_LONGINT, and SCIPparamGetLongintMin().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPparamGetLongintMin().

◆ SCIPparamGetLongintMax()

SCIP_Longint SCIPparamGetLongintMax ( SCIP_PARAM * param )

returns maximal value of longint parameter

Parameters

param parameter

Definition at line 803 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_Longint, SCIP_PARAMTYPE_LONGINT, and SCIPparamGetLongintMax().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPparamGetLongintMax().

◆ SCIPparamGetLongintDefault()

SCIP_Longint SCIPparamGetLongintDefault ( SCIP_PARAM * param )

returns default value of SCIP_Longint parameter

Parameters

param parameter

Definition at line 814 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_Longint, SCIP_PARAMTYPE_LONGINT, and SCIPparamGetLongintDefault().

Referenced by SCIPparamGetLongintDefault(), SCIPparamIsDefault(), and SCIPparamSetToDefault().

◆ SCIPparamGetReal()

SCIP_Real SCIPparamGetReal ( SCIP_PARAM * param )

returns value of SCIP_Real parameter

Parameters

param parameter

Definition at line 825 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_REAL, SCIP_Real, and SCIPparamGetReal().

Referenced by paramCopyReal(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), SCIPparamGetReal(), SCIPparamIsDefault(), SCIPparamsetGetReal(), and SCIPparamSetReal().

◆ SCIPparamGetRealMin()

SCIP_Real SCIPparamGetRealMin ( SCIP_PARAM * param )

returns minimal value of real parameter

Parameters

param parameter

Definition at line 839 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_REAL, SCIP_Real, and SCIPparamGetRealMin().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPparamGetRealMin().

◆ SCIPparamGetRealMax()

SCIP_Real SCIPparamGetRealMax ( SCIP_PARAM * param )

returns maximal value of real parameter

Parameters

param parameter

Definition at line 850 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_REAL, SCIP_Real, and SCIPparamGetRealMax().

Referenced by copyMemoryAndTimeLimits(), SCIP_DECL_DIALOGEXEC(), and SCIPparamGetRealMax().

◆ SCIPparamGetRealDefault()

SCIP_Real SCIPparamGetRealDefault ( SCIP_PARAM * param )

returns default value of SCIP_Real parameter

Parameters

param parameter

Definition at line 861 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_REAL, SCIP_Real, and SCIPparamGetRealDefault().

Referenced by paramsetSetHeuristicsAggressive(), SCIPparamGetRealDefault(), SCIPparamIsDefault(), and SCIPparamSetToDefault().

◆ SCIPparamGetChar()

char SCIPparamGetChar ( SCIP_PARAM * param )

returns value of char parameter

Parameters

param parameter

Definition at line 872 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_CHAR, and SCIPparamGetChar().

Referenced by paramCopyChar(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIPparamGetChar(), SCIPparamIsDefault(), SCIPparamSetChar(), and SCIPparamsetGetChar().

◆ SCIPparamGetCharAllowedValues()

char * SCIPparamGetCharAllowedValues ( SCIP_PARAM * param )

returns allowed values of char parameter, or NULL if everything is allowed

Parameters

param parameter

Definition at line 886 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_CHAR, and SCIPparamGetCharAllowedValues().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPparamGetCharAllowedValues().

◆ SCIPparamGetCharDefault()

char SCIPparamGetCharDefault ( SCIP_PARAM * param )

returns default value of char parameter

Parameters

param parameter

Definition at line 897 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_CHAR, and SCIPparamGetCharDefault().

Referenced by SCIPparamGetCharDefault(), SCIPparamIsDefault(), and SCIPparamSetToDefault().

◆ SCIPparamGetString()

char * SCIPparamGetString ( SCIP_PARAM * param )

returns value of string parameter

Parameters

param parameter

Definition at line 908 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_STRING, and SCIPparamGetString().

Referenced by paramCopyString(), paramWrite(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_NLPICREATEPROBLEM(), SCIPparamGetString(), SCIPparamIsDefault(), and SCIPparamsetGetString().

◆ SCIPparamGetStringDefault()

char * SCIPparamGetStringDefault ( SCIP_PARAM * param )

returns default value of String parameter

Parameters

param parameter

Definition at line 922 of file paramset.c.

References assert(), SCIP_Param::data, NULL, SCIP_Param::paramtype, SCIP_PARAMTYPE_STRING, and SCIPparamGetStringDefault().

Referenced by SCIPparamGetStringDefault(), SCIPparamIsDefault(), and SCIPparamSetToDefault().

◆ SCIPparamIsDefault()

SCIP_Bool SCIPparamIsDefault ( SCIP_PARAM * param )

returns whether the parameter is on its default setting

Parameters

param parameter

Definition at line 933 of file paramset.c.

References assert(), EPSZ, FALSE, NULL, SCIP_Param::paramtype, SCIP_Bool, 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(), SCIPparamGetStringDefault(), and SCIPparamIsDefault().

Referenced by collectNondefaultParams(), paramWrite(), and SCIPparamIsDefault().

Detailed Description

Functions

Function Documentation

◆ SCIPparamGetType()

◆ SCIPparamGetName()

◆ SCIPparamGetDesc()

◆ SCIPparamGetData()

◆ SCIPparamIsAdvanced()

◆ SCIPparamIsFixed()

◆ SCIPparamSetFixed()

◆ SCIPparamGetBool()

◆ SCIPparamGetBoolDefault()

◆ SCIPparamGetInt()

◆ SCIPparamGetIntMin()

◆ SCIPparamGetIntMax()

◆ SCIPparamGetIntDefault()

◆ SCIPparamGetLongint()

◆ SCIPparamGetLongintMin()

◆ SCIPparamGetLongintMax()

◆ SCIPparamGetLongintDefault()

◆ SCIPparamGetReal()

◆ SCIPparamGetRealMin()

◆ SCIPparamGetRealMax()

◆ SCIPparamGetRealDefault()

◆ SCIPparamGetChar()

◆ SCIPparamGetCharAllowedValues()

◆ SCIPparamGetCharDefault()

◆ SCIPparamGetString()

◆ SCIPparamGetStringDefault()

◆ SCIPparamIsDefault()