SCIP Doxygen Documentation
 
Loading...
Searching...
No Matches

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_PARAMSCIPgetParam (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 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 SCIPsetParam (SCIP *scip, const char *name, 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)
 
SCIP_Bool SCIPgetSubscipsOff (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
scipSCIP data structure
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
paramdatalocally defined parameter specific data

Definition at line 57 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetAddBoolParam().

Referenced by alnsIncludeNeighborhood(), fromAmpl(), includeConshdlrCountsols(), tsp::ReaderTSP::ReaderTSP(), schedulerIncludeNeighborhood(), SCIPincludeBenderscutInt(), SCIPincludeBenderscutNogood(), SCIPincludeBenderscutOpt(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleGomory(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchruleRelpscost(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeBranchruleVanillafullstrong(), SCIPincludeComprWeakcompr(), SCIPincludeConshdlrAnd(), SCIPincludeConshdlrBenders(), SCIPincludeConshdlrBenderslp(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrCumulative(), SCIPincludeConshdlrDisjunction(), SCIPincludeConshdlrFixedvar(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrKnapsack(), SCIPincludeConshdlrLinear(), SCIPincludeConshdlrLinking(), SCIPincludeConshdlrLogicor(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOptcumulative(), SCIPincludeConshdlrOrbisack(), SCIPincludeConshdlrOrbitope(), SCIPincludeConshdlrPseudoboolean(), SCIPincludeConshdlrSetppc(), SCIPincludeConshdlrSOS1(), SCIPincludeConshdlrSuperindicator(), SCIPincludeConshdlrSymresack(), SCIPincludeConshdlrVarbound(), SCIPincludeConshdlrXor(), SCIPincludeConsUpgradeNonlinear(), SCIPincludeCutselEnsemble(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeExprhdlrPow(), SCIPincludeExprhdlrProduct(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurClique(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurCycGreedy(), SCIPincludeHeurDins(), SCIPincludeHeurDps(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurGins(), SCIPincludeHeurIndicator(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOfins(), SCIPincludeHeurOneopt(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVbounds(), SCIPincludeHeurZeroobj(), SCIPincludeHeurZirounding(), SCIPincludeLinconsUpgrade(), SCIPincludeNlhdlrBilinear(), SCIPincludeNlhdlrConcave(), SCIPincludeNlhdlrConvex(), SCIPincludeNlhdlrPerspective(), SCIPincludeNlhdlrQuadratic(), SCIPincludeNlhdlrSoc(), SCIPincludeNodeselRestartdfs(), SCIPincludeNodeselUct(), SCIPincludePresolBoundshift(), SCIPincludePresolConvertinttobin(), SCIPincludePresolDomcol(), SCIPincludePresolDualcomp(), SCIPincludePresolDualinfer(), SCIPincludePresolDualsparsify(), SCIPincludePresolGateextraction(), SCIPincludePresolQPKKTref(), SCIPincludePresolSparsify(), SCIPincludePresolTworowbnd(), SCIPincludePricerColoring(), SCIPincludePropGenvbounds(), SCIPincludePropNlobbt(), SCIPincludePropObbt(), SCIPincludePropPseudoobj(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), SCIPincludePropSymmetry(), SCIPincludePropVbounds(), SCIPincludeReaderBnd(), SCIPincludeReaderCip(), SCIPincludeReaderCmin(), SCIPincludeReaderCnf(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderOpb(), SCIPincludeReaderPbm(), SCIPincludeReaderPpm(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSto(), SCIPincludeReaderZpl(), SCIPincludeSepaAggregation(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClosecuts(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaImpliedbounds(), SCIPincludeSepaInterminor(), SCIPincludeSepaLagromory(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaMixing(), SCIPincludeSepaOddcycle(), SCIPincludeSepaRapidlearning(), SCIPincludeSepaRlt(), SCIPincludeSepaZerohalf(), SCIPnlhdlrCreate(), SCIPtreemodelInit(), 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
scipSCIP data structure
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
minvalueminimum value for parameter
maxvaluemaximum value for parameter
paramdatalocally defined parameter specific data

Definition at line 83 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetAddIntParam().

Referenced by includeNeighborhoods(), includeNeighborhoods(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleGomory(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleRelpscost(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeComprLargestrepr(), SCIPincludeConshdlrBenderslp(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrComponents(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrKnapsack(), SCIPincludeConshdlrLinear(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrRpa(), SCIPincludeConshdlrSetppc(), SCIPincludeConshdlrSOS1(), SCIPincludeConshdlrSuperindicator(), SCIPincludeConshdlrXor(), SCIPincludeCutselDynamic(), SCIPincludeCutselEnsemble(), SCIPincludeEventHdlrEstim(), SCIPincludeExprhdlrPow(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurClique(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurDps(), SCIPincludeHeurDualval(), SCIPincludeHeurFeaspump(), SCIPincludeHeurFixandinfer(), SCIPincludeHeurGins(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOptcumulative(), SCIPincludeHeurPADM(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVbounds(), SCIPincludeHeurZirounding(), SCIPincludeNlhdlrBilinear(), SCIPincludeNlhdlrPerspective(), SCIPincludeNlhdlrQuadratic(), SCIPincludeNlhdlrSignomial(), SCIPincludeNlpi(), SCIPincludeNlpSolverIpopt(), SCIPincludeNodeselBfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselRestartdfs(), SCIPincludeNodeselUct(), SCIPincludeOrbitopalReduction(), SCIPincludePresolDomcol(), SCIPincludePresolDualinfer(), SCIPincludePresolDualsparsify(), SCIPincludePresolGateextraction(), SCIPincludePresolSparsify(), SCIPincludePresolTworowbnd(), SCIPincludePricerColoring(), SCIPincludePricerRpa(), SCIPincludePropNlobbt(), SCIPincludePropObbt(), SCIPincludePropProbing(), SCIPincludePropPseudoobj(), SCIPincludePropSymmetry(), SCIPincludeReaderCmin(), SCIPincludeReaderPbm(), SCIPincludeReaderPpm(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeSepaAggregation(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaGauge(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaInterminor(), SCIPincludeSepaLagromory(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaMixing(), SCIPincludeSepaOddcycle(), SCIPincludeSepaRapidlearning(), SCIPincludeSepaRlt(), SCIPincludeSepaZerohalf(), and SCIPtreemodelInit().

◆ 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
scipSCIP data structure
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
minvalueminimum value for parameter
maxvaluemaximum value for parameter
paramdatalocally defined parameter specific data

Definition at line 111 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetAddLongintParam().

Referenced by includeConshdlrCountsols(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMultAggr(), SCIPincludeConshdlrComponents(), SCIPincludeConshdlrCumulative(), SCIPincludeConshdlrRpa(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurClique(), SCIPincludeHeurCompletesol(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurOfins(), SCIPincludeHeurOptcumulative(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurScheduler(), SCIPincludeHeurUndercover(), SCIPincludeHeurVbounds(), SCIPincludeHeurZeroobj(), SCIPincludePresolBoundshift(), SCIPincludePresolConvertinttobin(), SCIPincludePricerRpa(), SCIPincludePropObbt(), SCIPincludeReaderRpa(), SCIPincludeSepaCGMIP(), SCIPincludeSepaRapidlearning(), 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
scipSCIP data structure
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
minvalueminimum value for parameter
maxvaluemaximum value for parameter
paramdatalocally defined parameter specific data

Definition at line 139 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetAddRealParam().

Referenced by alnsIncludeNeighborhood(), includeNeighborhoods(), includeNeighborhoods(), schedulerIncludeNeighborhood(), SCIPincludeBenderscutInt(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleGomory(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRelpscost(), SCIPincludeConshdlrBounddisjunction(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrComponents(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrKnapsack(), SCIPincludeConshdlrLinear(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOrbisack(), SCIPincludeConshdlrRpa(), SCIPincludeConshdlrSOS1(), SCIPincludeConshdlrSuperindicator(), SCIPincludeConshdlrVarbound(), SCIPincludeCutselDynamic(), SCIPincludeCutselEnsemble(), SCIPincludeCutselHybrid(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeExprhdlrLog(), SCIPincludeExprhdlrPow(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurClique(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurDps(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurGins(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOfins(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurRedsize(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVbounds(), SCIPincludeHeurZeroobj(), SCIPincludeHeurZirounding(), SCIPincludeNlhdlrConvex(), SCIPincludeNlhdlrPerspective(), SCIPincludeNlhdlrQuadratic(), SCIPincludeNlhdlrSignomial(), SCIPincludeNlhdlrSoc(), SCIPincludeNlpSolverIpopt(), SCIPincludeNodeselBfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselUct(), SCIPincludePresolDualsparsify(), SCIPincludePresolSparsify(), SCIPincludePricerRpa(), SCIPincludePropNlobbt(), SCIPincludePropObbt(), SCIPincludePropPseudoobj(), SCIPincludePropSymmetry(), SCIPincludePropVbounds(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), SCIPincludeReaderRpa(), SCIPincludeSepaAggregation(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaInterminor(), SCIPincludeSepaLagromory(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaRapidlearning(), SCIPincludeSepaRlt(), SCIPincludeSepaZerohalf(), SCIPtreemodelInit(), 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
scipSCIP data structure
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
allowedvaluesarray with possible parameter values, or NULL if not restricted
paramdatalocally defined parameter specific data

Definition at line 167 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetAddCharParam().

Referenced by SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchrulePscost(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSOS1(), SCIPincludeCutselDynamic(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurGins(), SCIPincludeHeurLpface(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurUndercover(), SCIPincludePresolSparsify(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), and SCIPtreemodelInit().

◆ 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
scipSCIP data structure
namename of the parameter
descdescription of the parameter
valueptrpointer to store the current parameter value, or NULL; if not NULL then *valueptr should be NULL
isadvancedis this parameter an advanced parameter?
defaultvaluedefault value of the parameter
paramdatalocally defined parameter specific data

Definition at line 194 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetAddStringParam().

Referenced by fromAmpl(), runShell(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAlns(), SCIPincludeHeurRepair(), SCIPincludeHeurUndercover(), SCIPincludeNlpSolverIpopt(), SCIPincludeReaderCmin(), SCIPincludeReaderSm(), and SCIPincludeReaderZpl().

◆ SCIPisParamFixed()

◆ 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
scipSCIP data structure
namename of the parameter

Definition at line 234 of file scip_param.c.

References assert(), NULL, and SCIPsetGetParam().

Referenced by copyMemoryAndTimeLimits(), copySofttimelimit(), SCIP_DECL_NLPICREATEPROBLEM(), solveSubscip(), and tryAddOrbitalRedLexRed().

◆ 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
scipSCIP data structure
namename of the parameter
valuepointer to store the parameter

Definition at line 250 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetGetBoolParam().

Referenced by applyRepair(), checkArraySizesHeur(), checkConsnames(), checkVarnames(), createAndAddAndCons(), createCipFormulation(), createVariable(), determineLimits(), determineLimits(), disableConflictingDualReductions(), displayRelevantStats(), fromAmpl(), fromCommandLine(), getVariable(), mpsinputCreate(), printConformName(), readBounds(), readCnf(), readCols(), readConstraints(), readDecomposition(), readFile(), readMst(), readSol(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXITSOL(), SCIP_DECL_EVENTINITSOL(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRESOLEXEC(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIPcomputeDecompStats(), SCIPcount(), SCIPnlpiOracleCreate(), SCIPreadLp(), SCIPreadPip(), SCIPreadProb(), SCIPsetCommonSubscipParams(), SCIPwriteGms(), selectVarRecursive(), setSubscipLimits(), solveSubscip(), 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
scipSCIP data structure
namename of the parameter
valuepointer to store the parameter

Definition at line 269 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetGetIntParam().

Referenced by addRelaxation(), applyObbt(), checkParameters(), createCipFormulation(), createMipFormulation(), getNSyncdata(), polishSolution(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PROPINITPRE(), SCIPapplyUndercover(), SCIPbendersComputeSubproblemLowerbound(), SCIPcomputeDecompStats(), SCIPcreateBendersDefault(), SCIPincludeHeurSync(), SCIPprobdataSetupProblem(), SCIPsyncstoreInit(), setupAndSolveSubscipRapidlearning(), 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
scipSCIP data structure
namename of the parameter
valuepointer to store the parameter

Definition at line 288 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetGetLongintParam().

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

◆ 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
scipSCIP data structure
namename of the parameter
valuepointer to store the parameter

Definition at line 307 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetGetRealParam().

Referenced by applyObbt(), applyOptcumulative(), applyRepair(), checkArraySizesGLS(), checkArraySizesHeur(), copyMemoryAndTimeLimits(), copySofttimelimit(), createProbOnlyEdge(), createProbQP(), createProbSimplified(), createProbSimplifiedTest(), createSubscip(), createSubscip(), determineLimits(), determineLimits(), displayRelevantStats(), doSeachEcAggr(), execRelpscost(), getCopyMemlimit(), getCopyTimelimit(), getTimeLeft(), initBounds(), printIndicatorCons(), reoptimize(), reoptimize(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIPapplyUndercover(), SCIPbendersComputeSubproblemLowerbound(), SCIPprobdataEnumeratePatterns(), SCIPprobdataSetupProblem(), SCIPsolve(), SCIPsyncstoreInit(), SCIPvalidateSolve(), setAndUpdateCorePoint(), setSubscipLimits(), solveCumulative(), solveIndependentCons(), solveLagromoryLP(), solveLPWithHardCuts(), solveNlp(), solveSubNLP(), solveSubscip(), solveSubscip(), storeOrigSubproblemParams(), 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
scipSCIP data structure
namename of the parameter
valuepointer to store the parameter

Definition at line 326 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetGetCharParam().

Referenced by printIndicatorCons(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_CONSINITSOL(), SCIP_DECL_CONSINITSOL(), SCIP_DECL_SEPAEXECLP(), SCIPcreateProbCyc(), 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
scipSCIP data structure
namename of the parameter
valuepointer to store the parameter

Definition at line 345 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetGetStringParam().

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

◆ 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
scipSCIP data structure
namename of the parameter

Definition at line 367 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPsetChgParamFixed(), 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
scipSCIP data structure
namename of the parameter

Definition at line 385 of file scip_param.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetChgParamFixed().

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

◆ 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
scipSCIP data structure
paramparameter
valuenew value of the parameter

Definition at line 403 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, and SCIPsetChgBoolParam().

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
scipSCIP data structure
namename of the parameter
valuenew value of the parameter

Definition at line 429 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetSetBoolParam().

Referenced by addScenarioVarsAndConsToProb(), buildDecompProblem(), createSubSCIP(), createSubscip(), createSubscip(), createSubscip(), disableConflictingDualReductions(), doSolveSubMIP(), initConcsolver(), reoptimize(), reoptimize(), resetOrigSubproblemParams(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_CONCSOLVERINITSEEDS(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRESOLEXEC(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_SEPAEXECLP(), SCIPapplyRedSize(), SCIPbendersApplyDecomposition(), SCIPbendersSolveSubproblemCIP(), SCIPcount(), SCIPprobdataCreate(), SCIPsetCommonSubscipParams(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubScip(), setupSubScip(), solveCoveringProblem(), solveIndependentCons(), 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
scipSCIP data structure
paramparameter
valuevalue to check

Definition at line 444 of file scip_param.c.

References assert(), 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
scipSCIP data structure
paramparameter
valuenew value of the parameter

Definition at line 461 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, and SCIPsetChgIntParam().

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
scipSCIP data structure
namename of the parameter
valuenew value of the parameter

Definition at line 487 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetSetIntParam().

Referenced by applyObbt(), applyRepair(), buildDecompProblem(), checkParameters(), componentCreateSubscip(), createSubproblems(), createSubSCIP(), createSubSCIP(), createSubscip(), createSubscip(), createSubscip(), doSolveSubMIP(), execmain(), main(), polishSolution(), reoptimize(), reoptimize(), resetOrigSubproblemParams(), runBenders(), runShell(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_CONCSOLVERINITSEEDS(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEURINIT(), SCIP_DECL_PRICERINITSOL(), SCIP_DECL_PRICERREDCOST(), SCIPapplyHeurDualval(), SCIPapplyProximity(), SCIPapplyRedSize(), SCIPbendersApplyDecomposition(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPcopyLimits(), SCIPcreateBendersDefault(), SCIPprobdataCreate(), SCIPprocessShellArguments(), SCIPsetCommonSubscipParams(), SCIPsolveConcurrent(), SCIPverifyCircularPatternNLP(), searchEcAggrWithMIP(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveFiniteSolSubscip(), setupAndSolveSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupAndSolveSubscipTrustregion(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubScip(), setupSubScip(), setupSubscipLpface(), solveCoveringProblem(), solveIndependentCons(), solvePricingMINLP(), 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
scipSCIP data structure
paramparameter
valuevalue to check

Definition at line 502 of file scip_param.c.

References assert(), 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
scipSCIP data structure
paramparameter
valuenew value of the parameter

Definition at line 519 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, and SCIPsetChgLongintParam().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetLongintParam()

◆ 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
scipSCIP data structure
paramparameter
valuevalue to check

Definition at line 560 of file scip_param.c.

References assert(), 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
scipSCIP data structure
paramparameter
valuenew value of the parameter

Definition at line 577 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, and SCIPsetChgRealParam().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetRealParam()

◆ 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
scipSCIP data structure
paramparameter
valuevalue to check

Definition at line 618 of file scip_param.c.

References assert(), 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
scipSCIP data structure
paramparameter
valuenew value of the parameter

Definition at line 635 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, and SCIPsetChgCharParam().

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
scipSCIP data structure
namename of the parameter
valuenew value of the parameter

Definition at line 661 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetSetCharParam().

Referenced by doSolveSubMIP(), resetOrigSubproblemParams(), SCIPapplyRedSize(), SCIPsetCommonSubscipParams(), setChildSelRule(), setSubproblemParams(), setSubscipParameters(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupSubScip(), setupSubScip(), 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
scipSCIP data structure
paramparameter
valuevalue to check

Definition at line 676 of file scip_param.c.

References assert(), 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
scipSCIP data structure
paramparameter
valuenew value of the parameter

Definition at line 693 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_PARAMETERWRONGVAL, and SCIPsetChgStringParam().

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
scipSCIP data structure
namename of the parameter
valuenew value of the parameter

Definition at line 719 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetSetStringParam().

◆ SCIPisStringParamValid()

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

checks whether parameter value for a given string parameter is valid

Parameters
scipSCIP data structure
paramparameter
valuevalue to check

Definition at line 734 of file scip_param.c.

References assert(), NULL, and SCIPparamIsValidString().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetParam()

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

changes the value of an existing parameter

The parameter type is checked and conversion of the given value to this type is attempted.

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
scipSCIP data structure
namename of the parameter
valuenew value of the parameter as string

Definition at line 753 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetSetParam().

Referenced by fromAmpl().

◆ 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
scipSCIP data structure
filenamefile name

Definition at line 772 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetReadParams().

Referenced by changeParametersUsingSettingsFiles(), fromAmpl(), readParams(), readParams(), 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
scipSCIP data structure
paramparameter
filenamefile name, or NULL for stdout
commentsshould parameter descriptions be written as comments?
onlychangedshould only those parameters be written that are changed from their default value?

Definition at line 790 of file scip_param.c.

References assert(), 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
scipSCIP data structure
filenamefile name, or NULL for stdout
commentsshould parameter descriptions be written as comments?
onlychangedshould only those parameters be written that are changed from their default value?

Definition at line 813 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetWriteParams().

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

◆ 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
scipSCIP data structure
namename of the parameter

Definition at line 835 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetResetParam().

Referenced by createSubSCIP().

◆ 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
scipSCIP data structure

Definition at line 853 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetResetParams().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetEmphasis()

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

sets parameters to

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
scipSCIP data structure
paramemphasisparameter settings
quietshould the parameter be set quiet (no output)

Definition at line 882 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetSetEmphasis().

Referenced by adaptSolverBehavior(), changeEmphasisParameters(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIPsetParamsCountsols(), SCIPverifyCircularPatternNLP(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscipRapidlearning(), 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
quietshould the parameter be set quiet (no output)

Definition at line 904 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetSetSubscipsOff().

Referenced by applyRepair(), createSubscip(), createSubscip(), doSolveSubMIP(), reoptimize(), reoptimize(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), SCIPsetCommonSubscipParams(), setSubscipParameters(), setupAndSolve(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubScip(), 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
scipSCIP data structure
paramsettingparameter settings
quietshould the parameter be set quiet (no output)

Definition at line 927 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, and SCIPsetSetHeuristics().

Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), 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
scipSCIP data structure
paramsettingparameter settings
quietshould the parameter be set quiet (no output)

Definition at line 953 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, and SCIPsetSetPresolving().

Referenced by buildDecompProblem(), createSubSCIP(), createSubscip(), createSubscip(), createSubscip(), doSolveSubMIP(), reoptimize(), reoptimize(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), SCIPbendersApplyDecomposition(), SCIPsetCommonSubscipParams(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubScip(), setupSubScip(), solveCoveringProblem(), 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
scipSCIP data structure
paramsettingparameter settings
quietshould the parameter be set quiet (no output)

Definition at line 979 of file scip_param.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIP_PARAMSETTING_AGGRESSIVE, SCIP_PARAMSETTING_DEFAULT, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, and SCIPsetSetSeparating().

Referenced by createSubscip(), createSubscip(), doSolveSubMIP(), reoptimize(), reoptimize(), runShell(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), SCIPsetCommonSubscipParams(), setSubscipParameters(), setupAndSolve(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubScip(), 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
scipSCIP data structure

Definition at line 999 of file scip_param.c.

References assert(), NULL, and SCIPsetGetParams().

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
scipSCIP data structure

Definition at line 1013 of file scip_param.c.

References assert(), NULL, and SCIPsetGetNParams().

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

◆ SCIPgetSubscipsOff()

SCIP_Bool SCIPgetSubscipsOff ( SCIP * scip)

returns whether plugins with sub-SCIPs that could cause recursion have been disabled

Returns
the value of the variable set->subscipsoff
Parameters
scipSCIP data structure

Definition at line 1027 of file scip_param.c.

References assert(), NULL, and SCIPsetGetSubscipsOff().

Referenced by SCIP_DECL_EVENTINITSOL().