Scippy

SCIP

Solving Constraint Integer Programs

pub_paramset.h File Reference

Detailed Description

public methods for handling parameter settings

Author
Tobias Achterberg

Definition in file pub_paramset.h.

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

Go to the source code of this file.

Functions

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

Function Documentation

◆ SCIPparamGetType()

◆ SCIPparamGetName()

SCIP_EXPORT const char* SCIPparamGetName ( SCIP_PARAM param)

◆ SCIPparamGetDesc()

SCIP_EXPORT const char* SCIPparamGetDesc ( SCIP_PARAM param)

returns description of parameter

Parameters
paramparameter

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
paramparameter

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
paramparameter

Definition at line 680 of file paramset.c.

References SCIP_Param::isadvanced, and NULL.

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

◆ SCIPparamIsFixed()

◆ SCIPparamSetFixed()

SCIP_EXPORT void SCIPparamSetFixed ( SCIP_PARAM param,
SCIP_Bool  fixed 
)

sets fixing status of given parameter

Parameters
paramparameter
fixednew 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()

◆ SCIPparamGetBoolDefault()

SCIP_EXPORT SCIP_Bool SCIPparamGetBoolDefault ( SCIP_PARAM param)

returns default value of SCIP_Bool parameter

Parameters
paramparameter

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()

◆ SCIPparamGetIntMin()

SCIP_EXPORT int SCIPparamGetIntMin ( SCIP_PARAM param)

returns minimal value of int parameter

Parameters
paramparameter

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
paramparameter

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)

◆ SCIPparamGetLongint()

◆ SCIPparamGetLongintMin()

SCIP_EXPORT SCIP_Longint SCIPparamGetLongintMin ( SCIP_PARAM param)

returns minimal value of longint parameter

Parameters
paramparameter

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
paramparameter

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
paramparameter

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()

◆ SCIPparamGetRealMin()

SCIP_EXPORT SCIP_Real SCIPparamGetRealMin ( SCIP_PARAM param)

returns minimal value of real parameter

Parameters
paramparameter

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
paramparameter

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
paramparameter

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)

◆ SCIPparamGetCharAllowedValues()

SCIP_EXPORT char* SCIPparamGetCharAllowedValues ( SCIP_PARAM param)

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

Parameters
paramparameter

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
paramparameter

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()

◆ SCIPparamGetStringDefault()

SCIP_EXPORT char* SCIPparamGetStringDefault ( SCIP_PARAM param)

returns default value of String parameter

Parameters
paramparameter

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()