Parameter

Detailed Description

methods to create, query, and print user parameters

Functions
SCIP_RETCODE	SCIPaddBoolParam (SCIP *scip, const char *name, const char *desc, SCIP_Bool *valueptr, SCIP_Bool isadvanced, SCIP_Bool defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
SCIP_RETCODE	SCIPaddIntParam (SCIP *scip, 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	SCIPaddLongintParam (SCIP *scip, 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	SCIPaddRealParam (SCIP *scip, 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	SCIPaddCharParam (SCIP *scip, 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	SCIPaddStringParam (SCIP *scip, const char *name, const char *desc, char **valueptr, SCIP_Bool isadvanced, const char *defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
SCIP_Bool	SCIPisParamFixed (SCIP *scip, const char *name)
SCIP_PARAM *	SCIPgetParam (SCIP *scip, const char *name)
SCIP_RETCODE	SCIPgetBoolParam (SCIP *scip, const char *name, SCIP_Bool *value)
SCIP_RETCODE	SCIPgetIntParam (SCIP *scip, const char *name, int *value)
SCIP_RETCODE	SCIPgetLongintParam (SCIP *scip, const char *name, SCIP_Longint *value)
SCIP_RETCODE	SCIPgetRealParam (SCIP *scip, const char *name, SCIP_Real *value)
SCIP_RETCODE	SCIPgetCharParam (SCIP *scip, const char *name, char *value)
SCIP_RETCODE	SCIPgetStringParam (SCIP *scip, const char *name, char **value)
SCIP_RETCODE	SCIPfixParam (SCIP *scip, const char *name)
SCIP_RETCODE	SCIPunfixParam (SCIP *scip, const char *name)
SCIP_RETCODE	SCIPsetParam (SCIP *scip, const char *name, void *value)
SCIP_RETCODE	SCIPchgBoolParam (SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
SCIP_RETCODE	SCIPsetBoolParam (SCIP *scip, const char *name, SCIP_Bool value)
SCIP_Bool	SCIPisBoolParamValid (SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
SCIP_RETCODE	SCIPchgIntParam (SCIP *scip, SCIP_PARAM *param, int value)
SCIP_RETCODE	SCIPsetIntParam (SCIP *scip, const char *name, int value)
SCIP_Bool	SCIPisIntParamValid (SCIP *scip, SCIP_PARAM *param, int value)
SCIP_RETCODE	SCIPchgLongintParam (SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
SCIP_RETCODE	SCIPsetLongintParam (SCIP *scip, const char *name, SCIP_Longint value)
SCIP_Bool	SCIPisLongintParamValid (SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
SCIP_RETCODE	SCIPchgRealParam (SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
SCIP_RETCODE	SCIPsetRealParam (SCIP *scip, const char *name, SCIP_Real value)
SCIP_Bool	SCIPisRealParamValid (SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
SCIP_RETCODE	SCIPchgCharParam (SCIP *scip, SCIP_PARAM *param, char value)
SCIP_RETCODE	SCIPsetCharParam (SCIP *scip, const char *name, char value)
SCIP_Bool	SCIPisCharParamValid (SCIP *scip, SCIP_PARAM *param, const char value)
SCIP_RETCODE	SCIPchgStringParam (SCIP *scip, SCIP_PARAM *param, const char *value)
SCIP_RETCODE	SCIPsetStringParam (SCIP *scip, const char *name, const char *value)
SCIP_Bool	SCIPisStringParamValid (SCIP *scip, SCIP_PARAM *param, const char *value)
SCIP_RETCODE	SCIPreadParams (SCIP *scip, const char *filename)
SCIP_RETCODE	SCIPwriteParam (SCIP *scip, SCIP_PARAM *param, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
SCIP_RETCODE	SCIPwriteParams (SCIP *scip, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
SCIP_RETCODE	SCIPresetParam (SCIP *scip, const char *name)
SCIP_RETCODE	SCIPresetParams (SCIP *scip)
SCIP_RETCODE	SCIPsetEmphasis (SCIP *scip, SCIP_PARAMEMPHASIS paramemphasis, SCIP_Bool quiet)
SCIP_RETCODE	SCIPsetSubscipsOff (SCIP *scip, SCIP_Bool quiet)
SCIP_RETCODE	SCIPsetHeuristics (SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
SCIP_RETCODE	SCIPsetPresolving (SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
SCIP_RETCODE	SCIPsetSeparating (SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
SCIP_PARAM **	SCIPgetParams (SCIP *scip)
int	SCIPgetNParams (SCIP *scip)

Function Documentation

SCIPaddBoolParam()

SCIP_RETCODE SCIPaddBoolParam	(	SCIP *	scip,
		const char *	name,
		const char *	desc,
		SCIP_Bool *	valueptr,
		SCIP_Bool	isadvanced,
		SCIP_Bool	defaultvalue,
		SCIP_DECL_PARAMCHGD((*paramchgd))	,
		SCIP_PARAMDATA *	paramdata
	)

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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
paramdata	locally defined parameter specific data

Definition at line 129 of file scip_param.c.

References Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetAddBoolParam(), Scip::set, and SCIP_Mem::setmem.

Referenced by alnsIncludeNeighborhood(), includeConshdlrCountsols(), tsp::ReaderTSP::ReaderTSP(), SCIPincludeBenderscutInt(), SCIPincludeBenderscutNogood(), SCIPincludeBenderscutOpt(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeComprWeakcompr(), SCIPincludeConshdlrAbspower(), SCIPincludeConshdlrAnd(), SCIPincludeConshdlrBenders(), SCIPincludeConshdlrBenderslp(), SCIPincludeConshdlrBivariate(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrCumulative(), SCIPincludeConshdlrDisjunction(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrLinking(), SCIPincludeConshdlrLogicor(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOptcumulative(), SCIPincludeConshdlrOrbisack(), SCIPincludeConshdlrOrbitope(), SCIPincludeConshdlrPseudoboolean(), SCIPincludeConshdlrQuadratic(), SCIPincludeConshdlrSOC(), SCIPincludeConshdlrStp(), SCIPincludeConshdlrSuperindicator(), SCIPincludeConshdlrSymresack(), SCIPincludeConshdlrVarbound(), SCIPincludeConshdlrXor(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurCycGreedy(), SCIPincludeHeurDins(), SCIPincludeHeurDualval(), SCIPincludeHeurIndicator(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLpface(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurOctane(), SCIPincludeHeurOfins(), SCIPincludeHeurOneopt(), SCIPincludeHeurProximity(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRens(), SCIPincludeHeurRins(), SCIPincludeHeurRounding(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurZeroobj(), SCIPincludeHeurZirounding(), SCIPincludeNodeselRestartdfs(), SCIPincludeNodeselUct(), SCIPincludeNonlinconsUpgrade(), SCIPincludePresolBoundshift(), SCIPincludePresolConvertinttobin(), SCIPincludePresolDomcol(), SCIPincludePresolDualcomp(), SCIPincludePresolQPKKTref(), SCIPincludePresolSparsify(), SCIPincludePresolSymbreak(), SCIPincludePresolSymmetry(), SCIPincludePricerColoring(), SCIPincludePropNlobbt(), SCIPincludePropOrbitalfixing(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), SCIPincludePropStp(), SCIPincludePropVbounds(), SCIPincludeQuadconsUpgrade(), SCIPincludeReaderBnd(), SCIPincludeReaderCip(), SCIPincludeReaderCmin(), SCIPincludeReaderCnf(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderOpb(), SCIPincludeReaderPbm(), SCIPincludeReaderPpm(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSto(), SCIPincludeReaderZpl(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClosecuts(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaImpliedbounds(), SCIPincludeSepaMcf(), SCIPincludeSepaOddcycle(), SCIPincludeSepaStrongcg(), SCIPincludeSepaZerohalf(), SCIPStpIncludeHeurAscendPrune(), SCIPStpIncludeHeurLocal(), SCIPStpIncludeHeurPrune(), SCIPStpIncludeHeurRec(), SCIPStpIncludeHeurSlackPrune(), SCIPStpReaderIncludeParams(), solveClassification(), and solveMinIISC().

SCIPaddIntParam()

SCIP_RETCODE SCIPaddIntParam	(	SCIP *	scip,
		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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
minvalue	minimum value for parameter
maxvalue	maximum value for parameter
paramdata	locally defined parameter specific data

Definition at line 155 of file scip_param.c.

References Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetAddIntParam(), Scip::set, and SCIP_Mem::setmem.

Referenced by includeNeighborhoods(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleStp(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeComprLargestrepr(), SCIPincludeConshdlrAbspower(), SCIPincludeConshdlrBenderslp(), SCIPincludeConshdlrBivariate(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrComponents(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrQuadratic(), SCIPincludeConshdlrRpa(), SCIPincludeConshdlrSOC(), SCIPincludeConshdlrStp(), SCIPincludeConshdlrSuperindicator(), SCIPincludeConshdlrXor(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurDualval(), SCIPincludeHeurFixandinfer(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOptcumulative(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRens(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurZirounding(), SCIPincludeNlpi(), SCIPincludeNodeselBfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselRestartdfs(), SCIPincludeNodeselUct(), SCIPincludePresolDomcol(), SCIPincludePresolSparsify(), SCIPincludePresolSymbreak(), SCIPincludePresolSymmetry(), SCIPincludePricerColoring(), SCIPincludePricerRpa(), SCIPincludePropNlobbt(), SCIPincludePropOrbitalfixing(), SCIPincludePropStp(), SCIPincludeReaderCmin(), SCIPincludeReaderPbm(), SCIPincludeReaderPpm(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaGauge(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaMcf(), SCIPincludeSepaOddcycle(), SCIPincludeSepaStrongcg(), SCIPincludeSepaZerohalf(), SCIPStpIncludeHeurLocal(), SCIPStpIncludeHeurRec(), SCIPStpIncludeHeurTM(), and SCIPStpReaderIncludeParams().

SCIPaddLongintParam()

SCIP_RETCODE SCIPaddLongintParam	(	SCIP *	scip,
		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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
minvalue	minimum value for parameter
maxvalue	maximum value for parameter
paramdata	locally defined parameter specific data

Definition at line 183 of file scip_param.c.

References Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetAddLongintParam(), Scip::set, and SCIP_Mem::setmem.

Referenced by includeConshdlrCountsols(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleMultAggr(), SCIPincludeConshdlrComponents(), SCIPincludeConshdlrCumulative(), SCIPincludeConshdlrRpa(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAlns(), SCIPincludeHeurCompletesol(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurLpface(), SCIPincludeHeurOfins(), SCIPincludeHeurOptcumulative(), SCIPincludeHeurProximity(), SCIPincludeHeurRens(), SCIPincludeHeurUndercover(), SCIPincludeHeurZeroobj(), SCIPincludePresolBoundshift(), SCIPincludePresolConvertinttobin(), SCIPincludePricerRpa(), SCIPincludeReaderRpa(), SCIPincludeSepaCGMIP(), solveClassification(), and solveMinIISC().

SCIPaddRealParam()

SCIP_RETCODE SCIPaddRealParam	(	SCIP *	scip,
		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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
minvalue	minimum value for parameter
maxvalue	maximum value for parameter
paramdata	locally defined parameter specific data

Definition at line 211 of file scip_param.c.

References Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetAddRealParam(), Scip::set, and SCIP_Mem::setmem.

Referenced by alnsIncludeNeighborhood(), SCIPincludeBenderscutInt(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleInference(), SCIPincludeBranchrulePscost(), SCIPincludeConshdlrAbspower(), SCIPincludeConshdlrBivariate(), SCIPincludeConshdlrBounddisjunction(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrComponents(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOrbisack(), SCIPincludeConshdlrQuadratic(), SCIPincludeConshdlrRpa(), SCIPincludeConshdlrSOC(), SCIPincludeConshdlrSuperindicator(), SCIPincludeConshdlrVarbound(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAlns(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurDualval(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOfins(), SCIPincludeHeurProximity(), SCIPincludeHeurRedsize(), SCIPincludeHeurRens(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurZeroobj(), SCIPincludeHeurZirounding(), SCIPincludeNodeselBfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselUct(), SCIPincludePresolSparsify(), SCIPincludePricerRpa(), SCIPincludePropNlobbt(), SCIPincludePropVbounds(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), SCIPincludeReaderRpa(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaGauge(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaMcf(), SCIPincludeSepaZerohalf(), SCIPStpReaderIncludeParams(), solveClassification(), and solveMinIISC().

SCIPaddCharParam()

SCIP_RETCODE SCIPaddCharParam	(	SCIP *	scip,
		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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
allowedvalues	array with possible parameter values, or NULL if not restricted
paramdata	locally defined parameter specific data

Definition at line 239 of file scip_param.c.

References Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetAddCharParam(), Scip::set, and SCIP_Mem::setmem.

Referenced by SCIPincludeBranchruleDistribution(), SCIPincludeBranchrulePscost(), SCIPincludeConshdlrQuadratic(), SCIPincludeConshdlrSOC(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurLpface(), SCIPincludeHeurRens(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurUndercover(), SCIPincludePresolSparsify(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), and SCIPStpReaderIncludeParams().

SCIPaddStringParam()

SCIP_RETCODE SCIPaddStringParam	(	SCIP *	scip,
		const char *	name,
		const char *	desc,
		char **	valueptr,
		SCIP_Bool	isadvanced,
		const char *	defaultvalue,
		SCIP_DECL_PARAMCHGD((*paramchgd))	,
		SCIP_PARAMDATA *	paramdata
	)

creates a string(char*) parameter, sets it to its default value, and adds it to the parameter set

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL; if not NULL then *valueptr should be NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
paramdata	locally defined parameter specific data

Definition at line 266 of file scip_param.c.

References Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetAddStringParam(), Scip::set, and SCIP_Mem::setmem.

Referenced by runShell(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAlns(), SCIPincludeHeurSubNlp(), SCIPincludeHeurUndercover(), SCIPincludeReaderCmin(), SCIPincludeReaderSm(), SCIPincludeReaderZpl(), and SCIPStpReaderIncludeParams().

SCIPisParamFixed()

SCIP_Bool SCIPisParamFixed	(	SCIP *	scip,
		const char *	name
	)

gets the fixing status of an existing parameter

Returns

TRUE if the parameter is fixed to a value, otherwise FALSE.

Parameters

scip	SCIP data structure
name	name of the parameter

Definition at line 291 of file scip_param.c.

References NULL, SCIPsetIsParamFixed(), and Scip::set.

Referenced by applyRepair(), checkParameters(), createSubSCIP(), createSubscip(), doSolveSubMIP(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), SCIPcreateBendersDefault(), setSubscipParameters(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), solveSubNLP(), solveSubproblem(), subscipSetParams(), wrapperDins(), and wrapperRins().

SCIPgetParam()

SCIP_PARAM* SCIPgetParam	(	SCIP *	scip,
		const char *	name
	)

returns the pointer to the SCIP parameter with the given name

Returns

pointer to the parameter with the given name

Parameters

scip	SCIP data structure
name	name of the parameter

Definition at line 306 of file scip_param.c.

References NULL, SCIPsetGetParam(), and Scip::set.

Referenced by copyMemoryAndTimeLimits(), and copySofttimelimit().

SCIPgetBoolParam()

SCIP_RETCODE SCIPgetBoolParam	(	SCIP *	scip,
		const char *	name,
		SCIP_Bool *	value
	)

gets the value of an existing SCIP_Bool parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	pointer to store the parameter

Definition at line 322 of file scip_param.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetGetBoolParam(), and Scip::set.

Referenced by checkConsnames(), checkVarnames(), createAndAddAndCons(), createCipFormulation(), createVariable(), disableConflictingDualReductions(), displayRelevantStats(), fromCommandLine(), getVariable(), mpsinputCreate(), printConformName(), printExpr(), readBounds(), readCnf(), readColsMop(), readConstraints(), readFile(), readMst(), readRowsMop(), readSol(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXITSOL(), SCIP_DECL_EVENTINITSOL(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PROBTRANS(), SCIP_DECL_READERREAD(), SCIP_DECL_SEPAEXECLP(), SCIPcount(), SCIPprobdataCreate(), SCIPreadLp(), SCIPreadPip(), SCIPreadProb(), SCIPwriteGms(), storeOrigSubproblemParams(), and writeOpb().

SCIPgetIntParam()

SCIP_RETCODE SCIPgetIntParam	(	SCIP *	scip,
		const char *	name,
		int *	value
	)

gets the value of an existing int parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	pointer to store the parameter

Definition at line 341 of file scip_param.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetGetIntParam(), and Scip::set.

Referenced by checkParameters(), createCipFormulation(), createMipFormulation(), determineSymmetry(), getNSyncdata(), polishSolution(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PRESOLINIT(), SCIP_DECL_PRESOLINITPRE(), SCIP_DECL_PROPINIT(), SCIPapplyUndercover(), SCIPbendersComputeSubproblemLowerbound(), SCIPcreateBendersDefault(), SCIPincludeHeurSync(), SCIPprobdataCreate(), SCIPprobdataSetupProblem(), SCIPsyncstoreInit(), storeOrigSubproblemParams(), and visualizeSolutionAscii().

SCIPgetLongintParam()

SCIP_RETCODE SCIPgetLongintParam	(	SCIP *	scip,
		const char *	name,
		SCIP_Longint *	value
	)

gets the value of an existing SCIP_Longint parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	pointer to store the parameter

Definition at line 360 of file scip_param.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetGetLongintParam(), and Scip::set.

Referenced by SCIP_DECL_CONSPROP(), SCIPbendersComputeSubproblemLowerbound(), SCIPprobdataSetupProblem(), solveComponent(), and subscipdataCopySubscip().

SCIPgetRealParam()

SCIP_RETCODE SCIPgetRealParam	(	SCIP *	scip,
		const char *	name,
		SCIP_Real *	value
	)

gets the value of an existing SCIP_Real parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	pointer to store the parameter

Definition at line 379 of file scip_param.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetGetRealParam(), and Scip::set.

Referenced by applyHeur(), applyOptcumulative(), applyRepair(), checkArraySizesGLS(), checkArraySizesHeur(), computeInteriorPoint(), copyMemoryAndTimeLimits(), copySofttimelimit(), createProbOnlyEdge(), createProbQP(), createProbSimplified(), createProbSimplifiedTest(), determineLimits(), displayRelevantStats(), doSeachEcAggr(), getCopyMemlimit(), getCopyTimelimit(), getlecloseterms(), getTimeLeft(), printIndicatorCons(), redLoopMw(), redLoopPc(), redLoopStp(), reduceHc(), reduceNw(), reducePc(), reduceSap(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_PROBTRANS(), SCIP_DECL_RELAXEXEC(), SCIP_DECL_SEPAEXECLP(), SCIPapplyUndercover(), SCIPbendersComputeSubproblemLowerbound(), SCIPprobdataCreate(), SCIPprobdataEnumeratePatterns(), SCIPprobdataSetupProblem(), SCIPsolve(), SCIPsyncstoreInit(), SCIPvalidateSolve(), separateCuts(), setSubscipLimits(), solveCumulative(), solveIndependentCons(), solveNlp(), solveSubNLP(), solveSubscip(), storeOrigSubproblemParams(), subscipdataCopySubscip(), and verifyCircularPattern().

SCIPgetCharParam()

SCIP_RETCODE SCIPgetCharParam	(	SCIP *	scip,
		const char *	name,
		char *	value
	)

gets the value of an existing char parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	pointer to store the parameter

Definition at line 398 of file scip_param.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetGetCharParam(), and Scip::set.

Referenced by printIndicatorCons(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_CONSINITSOL(), SCIP_DECL_READERREAD(), SCIP_DECL_SEPAEXECLP(), SCIPcreateProbCyc(), SCIPprobdataCreate(), and storeOrigSubproblemParams().

SCIPgetStringParam()

SCIP_RETCODE SCIPgetStringParam	(	SCIP *	scip,
		const char *	name,
		char **	value
	)

gets the value of an existing string(char*) parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	pointer to store the parameter

Definition at line 417 of file scip_param.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetGetStringParam(), and Scip::set.

Referenced by findBestObjectiveValue(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_READERREAD(), and SCIPprobdataCreate().

SCIPfixParam()

SCIP_RETCODE SCIPfixParam	(	SCIP *	scip,
		const char *	name
	)

fixes the value of an existing parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Note

: Be careful with this method! Some general settings, e.g., the time or node limit, should not be fixed because they have to be changed for sub-SCIPs.

Parameters

scip	SCIP data structure
name	name of the parameter

Definition at line 439 of file scip_param.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetChgParamFixed(), Scip::set, and TRUE.

Referenced by createSubscip(), fixOrUnfixRelevantParameters(), SCIP_DECL_CONCSOLVERCREATEINST(), and SCIPcreateBendersDefault().

SCIPunfixParam()

SCIP_RETCODE SCIPunfixParam	(	SCIP *	scip,
		const char *	name
	)

unfixes the value of an existing parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter

Definition at line 457 of file scip_param.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetChgParamFixed(), and Scip::set.

Referenced by checkParameters(), fixOrUnfixRelevantParameters(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), and solveSubproblem().

SCIPsetParam()

SCIP_RETCODE SCIPsetParam	(	SCIP *	scip,
		const char *	name,
		void *	value
	)

changes the value of an existing parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	new value of the parameter

Definition at line 475 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetParam(), and Scip::set.

Referenced by setSubproblemParams().

SCIPchgBoolParam()

SCIP_RETCODE SCIPchgBoolParam	(	SCIP *	scip,
		SCIP_PARAM *	param,
		SCIP_Bool	value
	)

changes the value of an existing SCIP_Bool parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
param	parameter
value	new value of the parameter

Definition at line 494 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, SCIPsetChgBoolParam(), and Scip::set.

Referenced by checkTransferBoolParam(), and SCIP_DECL_DIALOGEXEC().

SCIPsetBoolParam()

SCIP_RETCODE SCIPsetBoolParam	(	SCIP *	scip,
		const char *	name,
		SCIP_Bool	value
	)

changes the value of an existing SCIP_Bool parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	new value of the parameter

Definition at line 520 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetBoolParam(), and Scip::set.

Referenced by addScenarioVarsAndConsToProb(), applyDomainChanges(), buildDecompProblem(), createSubSCIP(), createSubscip(), disableConflictingDualReductions(), doSolveSubMIP(), resetOrigSubproblemParams(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_CONCSOLVERINITSEEDS(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SOLVECUMULATIVE(), SCIPapplyRedSize(), SCIPbendersSolveSubproblemCIP(), SCIPcount(), SCIPprobdataCreate(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), solveIndependentCons(), solveSubNLP(), solveSubproblem(), solveSubscip(), subscipSetParams(), wrapperDins(), wrapperRins(), and writeBounds().

SCIPisBoolParamValid()

SCIP_Bool SCIPisBoolParamValid	(	SCIP *	scip,
		SCIP_PARAM *	param,
		SCIP_Bool	value
	)

checks whether the value of an existing SCIP_Bool parameter is valid

Parameters

scip	SCIP data structure
param	parameter
value	value to check

Definition at line 535 of file scip_param.c.

References NULL, and SCIPparamIsValidBool().

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPchgIntParam()

SCIP_RETCODE SCIPchgIntParam	(	SCIP *	scip,
		SCIP_PARAM *	param,
		int	value
	)

changes the value of an existing int parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
param	parameter
value	new value of the parameter

Definition at line 552 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, SCIPsetChgIntParam(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPsetIntParam()

SCIP_RETCODE SCIPsetIntParam	(	SCIP *	scip,
		const char *	name,
		int	value
	)

changes the value of an existing int parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	new value of the parameter

Definition at line 578 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetIntParam(), and Scip::set.

Referenced by applyDomainChanges(), applyRepair(), buildDecompProblem(), checkParameters(), componentCreateSubscip(), createSubproblems(), createSubscip(), createSubSCIP(), determineSymmetry(), doSolveSubMIP(), execmain(), getActivities(), polishSolution(), resetOrigSubproblemParams(), runBenders(), runShell(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_CONCSOLVERINITSEEDS(), SCIP_DECL_CONSINITSOL(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEURINIT(), SCIP_DECL_PRESOLEXIT(), SCIP_DECL_PRESOLINITPRE(), SCIP_DECL_PRICERINITSOL(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_SOLVECUMULATIVE(), SCIPapplyHeurDualval(), SCIPapplyProximity(), SCIPapplyRedSize(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPcopyLimits(), SCIPcreateBendersDefault(), SCIPprobdataCreate(), SCIPprocessShellArguments(), SCIPsolveConcurrent(), SCIPverifyCircularPatternNLP(), searchEcAggrWithMIP(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveFiniteSolSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubscipLpface(), solveCoveringProblem(), solveIndependentCons(), solvePricingMINLP(), solveSubNLP(), solveSubproblem(), solveSubscip(), subscipSetParams(), wrapperDins(), wrapperRins(), and writeBounds().

SCIPisIntParamValid()

SCIP_Bool SCIPisIntParamValid	(	SCIP *	scip,
		SCIP_PARAM *	param,
		int	value
	)

checks whether the value of an existing int parameter is valid

checks whether parameter value of an existing int paramter is valid

Parameters

scip	SCIP data structure
param	parameter
value	value to check

Definition at line 593 of file scip_param.c.

References NULL, and SCIPparamIsValidInt().

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPchgLongintParam()

SCIP_RETCODE SCIPchgLongintParam	(	SCIP *	scip,
		SCIP_PARAM *	param,
		SCIP_Longint	value
	)

changes the value of an existing SCIP_Longint parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
param	parameter
value	new value of the parameter

Definition at line 610 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, SCIPsetChgLongintParam(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPsetLongintParam()

SCIP_RETCODE SCIPsetLongintParam	(	SCIP *	scip,
		const char *	name,
		SCIP_Longint	value
	)

changes the value of an existing SCIP_Longint parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	new value of the parameter

Definition at line 636 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetLongintParam(), and Scip::set.

Referenced by applyDomainChanges(), applyRepair(), doSolveSubMIP(), runBenders(), SCIP_DECL_HEUREXEC(), SCIP_DECL_SOLVECUMULATIVE(), SCIPapplyHeurDualval(), SCIPapplyProximity(), SCIPapplyRedSize(), SCIPbendersComputeSubproblemLowerbound(), SCIPcopyLimits(), SCIPverifyCircularPatternNLP(), searchEcAggrWithMIP(), setLimits(), setSubscipLimits(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), solveCoveringProblem(), solvePricingMINLP(), solveSubNLP(), solveSubproblem(), solveSubscip(), wrapperDins(), wrapperRins(), and writeBounds().

SCIPisLongintParamValid()

SCIP_Bool SCIPisLongintParamValid	(	SCIP *	scip,
		SCIP_PARAM *	param,
		SCIP_Longint	value
	)

checks whether parameter value of an existing SCIP_Longint paramter is valid

Parameters

scip	SCIP data structure
param	parameter
value	value to check

Definition at line 651 of file scip_param.c.

References NULL, and SCIPparamIsValidLongint().

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPchgRealParam()

SCIP_RETCODE SCIPchgRealParam	(	SCIP *	scip,
		SCIP_PARAM *	param,
		SCIP_Real	value
	)

changes the value of an existing SCIP_Real parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
param	parameter
value	new value of the parameter

Definition at line 668 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, SCIPsetChgRealParam(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPsetRealParam()

SCIP_RETCODE SCIPsetRealParam	(	SCIP *	scip,
		const char *	name,
		SCIP_Real	value
	)

changes the value of an existing SCIP_Real parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	new value of the parameter

Definition at line 694 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetRealParam(), and Scip::set.

Referenced by applyRepair(), copyMemoryAndTimeLimits(), copySofttimelimit(), polyscip::Polyscip::numberofUnboundedResults(), resetOrigSubproblemParams(), runBenders(), runBrachistochrone(), runPacking(), runShell(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_PROBTRANS(), SCIP_DECL_SOLVECUMULATIVE(), SCIPbendersComputeSubproblemLowerbound(), SCIPcopyLimits(), SCIPprobdataCreate(), SCIPsolve(), SCIPverifyCircularPatternNLP(), searchEcAggrWithMIP(), setLimits(), setSubscipLimits(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscipRapidlearning(), solveCoveringProblem(), solveIndependentCons(), solvePricingMINLP(), solveSubNLP(), solveSubproblem(), solveSubscip(), and subscipSetParams().

SCIPisRealParamValid()

SCIP_Bool SCIPisRealParamValid	(	SCIP *	scip,
		SCIP_PARAM *	param,
		SCIP_Real	value
	)

checks whether parameter value of an existing SCIP_Real paramter is valid

Parameters

scip	SCIP data structure
param	parameter
value	value to check

Definition at line 709 of file scip_param.c.

References NULL, and SCIPparamIsValidReal().

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPchgCharParam()

SCIP_RETCODE SCIPchgCharParam	(	SCIP *	scip,
		SCIP_PARAM *	param,
		char	value
	)

changes the value of an existing char parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
param	parameter
value	new value of the parameter

Definition at line 726 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, SCIPsetChgCharParam(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPsetCharParam()

SCIP_RETCODE SCIPsetCharParam	(	SCIP *	scip,
		const char *	name,
		char	value
	)

changes the value of an existing char parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	new value of the parameter

Definition at line 752 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetCharParam(), and Scip::set.

Referenced by doSolveSubMIP(), resetOrigSubproblemParams(), SCIPapplyRedSize(), setChildSelRule(), setSubproblemParams(), setSubscipParameters(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupSubScip(), solveIndependentCons(), wrapperDins(), and wrapperRins().

SCIPisCharParamValid()

SCIP_Bool SCIPisCharParamValid	(	SCIP *	scip,
		SCIP_PARAM *	param,
		const char	value
	)

checks whether parameter value for a given SCIP_Real parameter is valid

Parameters

scip	SCIP data structure
param	parameter
value	value to check

Definition at line 767 of file scip_param.c.

References NULL, and SCIPparamIsValidChar().

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPchgStringParam()

SCIP_RETCODE SCIPchgStringParam	(	SCIP *	scip,
		SCIP_PARAM *	param,
		const char *	value
	)

changes the value of an existing string(char*) parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
param	parameter
value	new value of the parameter

Definition at line 784 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, SCIPsetChgStringParam(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPsetStringParam()

SCIP_RETCODE SCIPsetStringParam	(	SCIP *	scip,
		const char *	name,
		const char *	value
	)

changes the value of an existing string(char*) parameter

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter
value	new value of the parameter

Definition at line 810 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetStringParam(), and Scip::set.

SCIPisStringParamValid()

SCIP_Bool SCIPisStringParamValid	(	SCIP *	scip,
		SCIP_PARAM *	param,
		const char *	value
	)

checks whether parameter value for a given string parameter is valid

Parameters

scip	SCIP data structure
param	parameter
value	value to check

Definition at line 825 of file scip_param.c.

References NULL, and SCIPparamIsValidString().

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPreadParams()

SCIP_RETCODE SCIPreadParams	(	SCIP *	scip,
		const char *	filename
	)

reads parameters from a file

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
filename	file name

Definition at line 842 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetReadParams(), and Scip::set.

Referenced by changeParametersUsingSettingsFiles(), polyscip::Polyscip::Polyscip(), readParams(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), solveClassification(), and solveMinIISC().

SCIPwriteParam()

SCIP_RETCODE SCIPwriteParam	(	SCIP *	scip,
		SCIP_PARAM *	param,
		const char *	filename,
		SCIP_Bool	comments,
		SCIP_Bool	onlychanged
	)

writes a single parameter to a file

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
param	parameter
filename	file name, or NULL for stdout
comments	should parameter descriptions be written as comments?
onlychanged	should only those parameters be written that are changed from their default value?

Definition at line 860 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, and SCIPparamWrite().

SCIPwriteParams()

SCIP_RETCODE SCIPwriteParams	(	SCIP *	scip,
		const char *	filename,
		SCIP_Bool	comments,
		SCIP_Bool	onlychanged
	)

writes all parameters in the parameter set to a file

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
filename	file name, or NULL for stdout
comments	should parameter descriptions be written as comments?
onlychanged	should only those parameters be written that are changed from their default value?

Definition at line 883 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetWriteParams(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC(), solveClassification(), solveMinIISC(), and solveSubscipLpface().

SCIPresetParam()

SCIP_RETCODE SCIPresetParam	(	SCIP *	scip,
		const char *	name
	)

resets a single parameter to its default value

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
name	name of the parameter

Definition at line 905 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetResetParam(), and Scip::set.

Referenced by createSubSCIP(), and solveSubNLP().

SCIPresetParams()

SCIP_RETCODE SCIPresetParams

(

SCIP *

scip

)

resets all parameters to their default values

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure

Definition at line 923 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetResetParams(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPsetEmphasis()

SCIP_RETCODE SCIPsetEmphasis	(	SCIP *	scip,
		SCIP_PARAMEMPHASIS	paramemphasis,
		SCIP_Bool	quiet
	)

sets parameters to

• SCIP_PARAMEMPHASIS_DEFAULT to use default values (see also SCIPresetParams())
• SCIP_PARAMEMPHASIS_COUNTER to get feasible and "fast" counting process
• SCIP_PARAMEMPHASIS_CPSOLVER to get CP like search (e.g. no LP relaxation)
• SCIP_PARAMEMPHASIS_EASYCIP to solve easy problems fast
• SCIP_PARAMEMPHASIS_FEASIBILITY to detect feasibility fast
• SCIP_PARAMEMPHASIS_HARDLP to be capable to handle hard LPs
• SCIP_PARAMEMPHASIS_OPTIMALITY to prove optimality fast
• SCIP_PARAMEMPHASIS_PHASEFEAS to find feasible solutions during a 3 phase solution process
• SCIP_PARAMEMPHASIS_PHASEIMPROVE to find improved solutions during a 3 phase solution process
• SCIP_PARAMEMPHASIS_PHASEPROOF to proof optimality during a 3 phase solution process

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
paramemphasis	parameter settings
quiet	should the parameter be set quiet (no output)

Definition at line 951 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetEmphasis(), and Scip::set.

Referenced by adaptSolverBehavior(), changeEmphasisParameters(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), SCIPsetParamsCountsols(), SCIPverifyCircularPatternNLP(), setupAndSolveCumulativeSubscip(), solveSubproblem(), and subscipSetParams().

SCIPsetSubscipsOff()

SCIP_RETCODE SCIPsetSubscipsOff	(	SCIP *	scip,
		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

Note

only deactivates plugins which could cause recursion, some plugins which use sub-SCIPs stay activated

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	(auxiliary) SCIP data structure
quiet	should the parameter be set quiet (no output)

Definition at line 973 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPsetSetSubscipsOff(), and Scip::set.

Referenced by applyRepair(), doSolveSubMIP(), runShell(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), setSubscipParameters(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), subscipSetParams(), wrapperDins(), and wrapperRins().

SCIPsetHeuristics()

SCIP_RETCODE SCIPsetHeuristics	(	SCIP *	scip,
		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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
paramsetting	parameter settings
quiet	should the parameter be set quiet (no output)

Definition at line 996 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, SCIPsetSetHeuristics(), and Scip::set.

Referenced by applyDomainChanges(), SCIP_DECL_DIALOGEXEC(), SCIPbendersSolveSubproblemCIP(), searchEcAggrWithMIP(), setSubproblemParams(), setupAndSolveSubscipOneopt(), setupSCIPparamsFP2(), solvePricingMINLP(), and solveSubproblem().

SCIPsetPresolving()

SCIP_RETCODE SCIPsetPresolving	(	SCIP *	scip,
		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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
paramsetting	parameter settings
quiet	should the parameter be set quiet (no output)

Definition at line 1022 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, SCIPsetSetPresolving(), and Scip::set.

Referenced by buildDecompProblem(), createSubscip(), doSolveSubMIP(), polyscip::Polyscip::numberofUnboundedResults(), runShell(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), solveSubNLP(), solveSubproblem(), subscipSetParams(), wrapperDins(), and wrapperRins().

SCIPsetSeparating()

SCIP_RETCODE SCIPsetSeparating	(	SCIP *	scip,
		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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

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

Returns

SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Parameters

scip	SCIP data structure
paramsetting	parameter settings
quiet	should the parameter be set quiet (no output)

Definition at line 1048 of file scip_param.c.

References Scip::messagehdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, SCIPsetSetSeparating(), and Scip::set.

Referenced by doSolveSubMIP(), runShell(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), setSubscipParameters(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), subscipSetParams(), wrapperDins(), and wrapperRins().

SCIPgetParams()

SCIP_PARAM** SCIPgetParams

(

SCIP *

scip

)

returns the array of all available SCIP parameters

Returns

SCIP_PARAM* array, containing all SCIP parameters.

Parameters

scip	SCIP data structure

Definition at line 1068 of file scip_param.c.

References NULL, SCIPsetGetParams(), and Scip::set.

Referenced by collectNondefaultParams(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

SCIPgetNParams()

int SCIPgetNParams

(

SCIP *

scip

)

returns the total number of all available SCIP parameters

Returns

number of all SCIP parameters.

Parameters

scip	SCIP data structure

Definition at line 1082 of file scip_param.c.

References NULL, SCIPsetGetNParams(), and Scip::set.

Referenced by collectNondefaultParams(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().