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_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

SCIP_PARAMTYPE SCIPparamGetType

(

SCIP_PARAM *

param

)

returns type of parameter

Parameters

param

parameter

const char* SCIPparamGetName

(

SCIP_PARAM *

param

)

returns name of parameter

Parameters

param

parameter

const char* SCIPparamGetDesc

(

SCIP_PARAM *

param

)

returns description of parameter

Parameters

param

parameter

SCIP_PARAMDATA* SCIPparamGetData

(

SCIP_PARAM *

param

)

returns locally defined parameter specific data

Parameters

param

parameter

SCIP_Bool SCIPparamIsAdvanced

(

SCIP_PARAM *

param

)

returns whether parameter is advanced

Parameters

param

parameter

SCIP_Bool SCIPparamIsFixed

(

SCIP_PARAM *

param

)

returns whether parameter is fixed

Parameters

param

parameter

void SCIPparamSetFixed	(	SCIP_PARAM *	param,
		SCIP_Bool	fixed
	)

sets fixing status of given parameter

Parameters

param	parameter
fixed	new fixing status of the parameter

SCIP_Bool SCIPparamGetBool

(

SCIP_PARAM *

param

)

returns value of SCIP_Bool parameter

Parameters

param

parameter

SCIP_Bool SCIPparamGetBoolDefault

(

SCIP_PARAM *

param

)

returns default value of SCIP_Bool parameter

Parameters

param

parameter

int SCIPparamGetInt

(

SCIP_PARAM *

param

)

returns value of int parameter

Parameters

param

parameter

int SCIPparamGetIntMin

(

SCIP_PARAM *

param

)

returns minimal value of int parameter

Parameters

param

parameter

int SCIPparamGetIntMax

(

SCIP_PARAM *

param

)

returns maximal value of int parameter

Parameters

param

parameter

int SCIPparamGetIntDefault

(

SCIP_PARAM *

param

)

returns default value of int parameter

Parameters

param

parameter

SCIP_Longint SCIPparamGetLongint

(

SCIP_PARAM *

param

)

returns value of SCIP_Longint parameter

Parameters

param

parameter

SCIP_Longint SCIPparamGetLongintMin

(

SCIP_PARAM *

param

)

returns minimal value of longint parameter

Parameters

param

parameter

SCIP_Longint SCIPparamGetLongintMax

(

SCIP_PARAM *

param

)

returns maximal value of longint parameter

Parameters

param

parameter

SCIP_Longint SCIPparamGetLongintDefault

(

SCIP_PARAM *

param

)

returns default value of SCIP_Longint parameter

Parameters

param

parameter

SCIP_Real SCIPparamGetReal

(

SCIP_PARAM *

param

)

returns value of SCIP_Real parameter

Parameters

param

parameter

SCIP_Real SCIPparamGetRealMin

(

SCIP_PARAM *

param

)

returns minimal value of real parameter

Parameters

param

parameter

SCIP_Real SCIPparamGetRealMax

(

SCIP_PARAM *

param

)

returns maximal value of real parameter

Parameters

param

parameter

SCIP_Real SCIPparamGetRealDefault

(

SCIP_PARAM *

param

)

returns default value of SCIP_Real parameter

Parameters

param

parameter

char SCIPparamGetChar

(

SCIP_PARAM *

param

)

returns value of char parameter

Parameters

param

parameter

char* SCIPparamGetCharAllowedValues

(

SCIP_PARAM *

param

)

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

Parameters

param

parameter

char SCIPparamGetCharDefault

(

SCIP_PARAM *

param

)

returns default value of char parameter

Parameters

param

parameter

char* SCIPparamGetString

(

SCIP_PARAM *

param

)

returns value of string parameter

Parameters

param

parameter

char* SCIPparamGetStringDefault

(

SCIP_PARAM *

param

)

returns default value of String parameter

Parameters

param

parameter

SCIP_Bool SCIPparamIsDefault

(

SCIP_PARAM *

param

)

returns whether the parameter is on its default setting

Parameters

param

parameter