Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods to create, query, and print user parameters

Functions

SCIP_EXPORT 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_EXPORT 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_EXPORT 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_EXPORT 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_EXPORT 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_EXPORT 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_EXPORT SCIP_Bool SCIPisParamFixed (SCIP *scip, const char *name)
 
SCIP_EXPORT SCIP_PARAMSCIPgetParam (SCIP *scip, const char *name)
 
SCIP_EXPORT SCIP_RETCODE SCIPgetBoolParam (SCIP *scip, const char *name, SCIP_Bool *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPgetIntParam (SCIP *scip, const char *name, int *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPgetLongintParam (SCIP *scip, const char *name, SCIP_Longint *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPgetRealParam (SCIP *scip, const char *name, SCIP_Real *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPgetCharParam (SCIP *scip, const char *name, char *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPgetStringParam (SCIP *scip, const char *name, char **value)
 
SCIP_EXPORT SCIP_RETCODE SCIPfixParam (SCIP *scip, const char *name)
 
SCIP_EXPORT SCIP_RETCODE SCIPunfixParam (SCIP *scip, const char *name)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetParam (SCIP *scip, const char *name, void *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPchgBoolParam (SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetBoolParam (SCIP *scip, const char *name, SCIP_Bool value)
 
SCIP_EXPORT SCIP_Bool SCIPisBoolParamValid (SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
 
SCIP_EXPORT SCIP_RETCODE SCIPchgIntParam (SCIP *scip, SCIP_PARAM *param, int value)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetIntParam (SCIP *scip, const char *name, int value)
 
SCIP_EXPORT SCIP_Bool SCIPisIntParamValid (SCIP *scip, SCIP_PARAM *param, int value)
 
SCIP_EXPORT SCIP_RETCODE SCIPchgLongintParam (SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetLongintParam (SCIP *scip, const char *name, SCIP_Longint value)
 
SCIP_EXPORT SCIP_Bool SCIPisLongintParamValid (SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
 
SCIP_EXPORT SCIP_RETCODE SCIPchgRealParam (SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetRealParam (SCIP *scip, const char *name, SCIP_Real value)
 
SCIP_EXPORT SCIP_Bool SCIPisRealParamValid (SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
 
SCIP_EXPORT SCIP_RETCODE SCIPchgCharParam (SCIP *scip, SCIP_PARAM *param, char value)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetCharParam (SCIP *scip, const char *name, char value)
 
SCIP_EXPORT SCIP_Bool SCIPisCharParamValid (SCIP *scip, SCIP_PARAM *param, const char value)
 
SCIP_EXPORT SCIP_RETCODE SCIPchgStringParam (SCIP *scip, SCIP_PARAM *param, const char *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetStringParam (SCIP *scip, const char *name, const char *value)
 
SCIP_EXPORT SCIP_Bool SCIPisStringParamValid (SCIP *scip, SCIP_PARAM *param, const char *value)
 
SCIP_EXPORT SCIP_RETCODE SCIPreadParams (SCIP *scip, const char *filename)
 
SCIP_EXPORT SCIP_RETCODE SCIPwriteParam (SCIP *scip, SCIP_PARAM *param, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
 
SCIP_EXPORT SCIP_RETCODE SCIPwriteParams (SCIP *scip, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
 
SCIP_EXPORT SCIP_RETCODE SCIPresetParam (SCIP *scip, const char *name)
 
SCIP_EXPORT SCIP_RETCODE SCIPresetParams (SCIP *scip)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetEmphasis (SCIP *scip, SCIP_PARAMEMPHASIS paramemphasis, SCIP_Bool quiet)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetSubscipsOff (SCIP *scip, SCIP_Bool quiet)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetHeuristics (SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetPresolving (SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetSeparating (SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
 
SCIP_EXPORT SCIP_PARAM ** SCIPgetParams (SCIP *scip)
 
SCIP_EXPORT int SCIPgetNParams (SCIP *scip)
 
SCIP_EXPORT SCIP_Bool SCIPgetSubscipsOff (SCIP *scip)
 

Function Documentation

◆ SCIPaddBoolParam()

SCIP_EXPORT 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 48 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(), SCIPincludeBranchruleVanillafullstrong(), 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(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurCycGreedy(), SCIPincludeHeurDins(), SCIPincludeHeurDualval(), SCIPincludeHeurIndicator(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLpface(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurOctane(), SCIPincludeHeurOfins(), SCIPincludeHeurOneopt(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRens(), SCIPincludeHeurRins(), SCIPincludeHeurRounding(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurZeroobj(), SCIPincludeHeurZirounding(), SCIPincludeNodeselRestartdfs(), SCIPincludeNodeselUct(), SCIPincludeNonlinconsUpgrade(), SCIPincludePresolBoundshift(), SCIPincludePresolConvertinttobin(), SCIPincludePresolDomcol(), SCIPincludePresolDualcomp(), SCIPincludePresolDualinfer(), SCIPincludePresolDualsparsify(), SCIPincludePresolMILP(), SCIPincludePresolQPKKTref(), SCIPincludePresolSparsify(), SCIPincludePresolTworowbnd(), SCIPincludePricerColoring(), SCIPincludePropNlobbt(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), SCIPincludePropStp(), SCIPincludePropSymmetry(), 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_EXPORT 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 74 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(), SCIPincludeHeurPADM(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRens(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurZirounding(), SCIPincludeNlpi(), SCIPincludeNodeselBfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselRestartdfs(), SCIPincludeNodeselUct(), SCIPincludePresolDomcol(), SCIPincludePresolDualinfer(), SCIPincludePresolDualsparsify(), SCIPincludePresolMILP(), SCIPincludePresolSparsify(), SCIPincludePresolTworowbnd(), SCIPincludePricerColoring(), SCIPincludePricerRpa(), SCIPincludePropNlobbt(), SCIPincludePropStp(), SCIPincludePropSymmetry(), 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_EXPORT 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 102 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(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurCompletesol(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurLpface(), SCIPincludeHeurOfins(), SCIPincludeHeurOptcumulative(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurRens(), SCIPincludeHeurUndercover(), SCIPincludeHeurZeroobj(), SCIPincludePresolBoundshift(), SCIPincludePresolConvertinttobin(), SCIPincludePricerRpa(), SCIPincludeReaderRpa(), SCIPincludeSepaCGMIP(), solveClassification(), and solveMinIISC().

◆ SCIPaddRealParam()

SCIP_EXPORT 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 130 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(), includeNeighborhoods(), SCIPincludeBenderscutInt(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleInference(), SCIPincludeBranchrulePscost(), SCIPincludeConshdlrAbspower(), SCIPincludeConshdlrBivariate(), SCIPincludeConshdlrBounddisjunction(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrComponents(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOrbisack(), SCIPincludeConshdlrQuadratic(), SCIPincludeConshdlrRpa(), SCIPincludeConshdlrSOC(), SCIPincludeConshdlrSuperindicator(), SCIPincludeConshdlrVarbound(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurDualval(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOfins(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurRedsize(), SCIPincludeHeurRens(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurZeroobj(), SCIPincludeHeurZirounding(), SCIPincludeNodeselBfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselUct(), SCIPincludePresolDualsparsify(), SCIPincludePresolMILP(), SCIPincludePresolSparsify(), SCIPincludePricerRpa(), SCIPincludePropNlobbt(), SCIPincludePropSymmetry(), SCIPincludePropVbounds(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), SCIPincludeReaderRpa(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaGauge(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaMcf(), SCIPincludeSepaZerohalf(), SCIPStpReaderIncludeParams(), solveClassification(), and solveMinIISC().

◆ SCIPaddCharParam()

SCIP_EXPORT 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 158 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(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurLpface(), SCIPincludeHeurRens(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurUndercover(), SCIPincludePresolSparsify(), SCIPincludeReaderCyc(), SCIPincludeReaderGms(), and SCIPStpReaderIncludeParams().

◆ SCIPaddStringParam()

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

◆ SCIPgetParam()

SCIP_EXPORT 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 225 of file scip_param.c.

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

Referenced by copyMemoryAndTimeLimits(), and copySofttimelimit().

◆ SCIPgetBoolParam()

◆ SCIPgetIntParam()

SCIP_EXPORT 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 260 of file scip_param.c.

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

Referenced by addRelaxation(), checkParameters(), createCipFormulation(), createMipFormulation(), getNSyncdata(), polishSolution(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPINITPRE(), SCIPapplyUndercover(), SCIPbendersComputeSubproblemLowerbound(), SCIPcomputeDecompStats(), SCIPcreateBendersDefault(), SCIPincludeHeurSync(), SCIPprobdataCreate(), SCIPprobdataSetupProblem(), SCIPsyncstoreInit(), setupAndSolveSubscipRapidlearning(), storeOrigSubproblemParams(), and visualizeSolutionAscii().

◆ SCIPgetLongintParam()

SCIP_EXPORT 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 279 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_EXPORT 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 298 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(), execRelpscost(), 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(), SCIPincludePresolMILP(), SCIPprobdataCreate(), SCIPprobdataEnumeratePatterns(), SCIPprobdataSetupProblem(), SCIPsolve(), SCIPsyncstoreInit(), SCIPvalidateSolve(), separateCuts(), setAndUpdateCorePoint(), setSubscipLimits(), solveCumulative(), solveFeasibilityNonlinearSubproblem(), solveIndependentCons(), solveNlp(), solveSubNLP(), solveSubscip(), storeOrigSubproblemParams(), subscipdataCopySubscip(), and verifyCircularPattern().

◆ SCIPgetCharParam()

SCIP_EXPORT 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 317 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_EXPORT 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 336 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_EXPORT 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 358 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_EXPORT 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 376 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_EXPORT 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
scipSCIP data structure
namename of the parameter
valuenew value of the parameter

Definition at line 394 of file scip_param.c.

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

Referenced by setSubproblemParams().

◆ SCIPchgBoolParam()

SCIP_EXPORT 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 413 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_EXPORT 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 439 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(), infinityCountUpdate(), 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(), SCIPbendersApplyDecomposition(), SCIPbendersSolveSubproblemCIP(), SCIPcount(), SCIPprobdataCreate(), SCIPsetCommonSubscipParams(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), solveIndependentCons(), solveSubNLP(), solveSubproblem(), solveSubscip(), subscipSetParams(), wrapperDins(), wrapperRins(), and writeBounds().

◆ SCIPisBoolParamValid()

SCIP_EXPORT 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 454 of file scip_param.c.

References NULL, and SCIPparamIsValidBool().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPchgIntParam()

SCIP_EXPORT 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 471 of file scip_param.c.

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

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetIntParam()

SCIP_EXPORT 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 497 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(), doSolveSubMIP(), execmain(), infinityCountUpdate(), 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_PRICERINITSOL(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_SOLVECUMULATIVE(), SCIPapplyHeurDualval(), SCIPapplyProximity(), SCIPapplyRedSize(), SCIPbendersApplyDecomposition(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPcopyLimits(), SCIPcreateBendersDefault(), SCIPprobdataCreate(), SCIPprocessShellArguments(), SCIPsetCommonSubscipParams(), SCIPsolveConcurrent(), SCIPverifyCircularPatternNLP(), searchEcAggrWithMIP(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveFiniteSolSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupAndSolveSubscipTrustregion(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubscipLpface(), solveCoveringProblem(), solveIndependentCons(), solvePricingMINLP(), solveSubNLP(), solveSubproblem(), solveSubscip(), subscipSetParams(), wrapperDins(), wrapperRins(), and writeBounds().

◆ SCIPisIntParamValid()

SCIP_EXPORT 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 512 of file scip_param.c.

References NULL, and SCIPparamIsValidInt().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPchgLongintParam()

SCIP_EXPORT 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 529 of file scip_param.c.

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

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetLongintParam()

◆ SCIPisLongintParamValid()

SCIP_EXPORT 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 570 of file scip_param.c.

References NULL, and SCIPparamIsValidLongint().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPchgRealParam()

SCIP_EXPORT 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 587 of file scip_param.c.

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

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetRealParam()

◆ SCIPisRealParamValid()

SCIP_EXPORT 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 628 of file scip_param.c.

References NULL, and SCIPparamIsValidReal().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPchgCharParam()

SCIP_EXPORT 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 645 of file scip_param.c.

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

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetCharParam()

SCIP_EXPORT 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 671 of file scip_param.c.

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

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

◆ SCIPisCharParamValid()

SCIP_EXPORT 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 686 of file scip_param.c.

References NULL, and SCIPparamIsValidChar().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPchgStringParam()

SCIP_EXPORT 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 703 of file scip_param.c.

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

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetStringParam()

SCIP_EXPORT 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 729 of file scip_param.c.

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

◆ SCIPisStringParamValid()

SCIP_EXPORT 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 744 of file scip_param.c.

References NULL, and SCIPparamIsValidString().

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPreadParams()

SCIP_EXPORT 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 761 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_EXPORT 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 779 of file scip_param.c.

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

◆ SCIPwriteParams()

SCIP_EXPORT 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 802 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_EXPORT 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 824 of file scip_param.c.

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

Referenced by createSubSCIP(), and solveSubNLP().

◆ SCIPresetParams()

SCIP_EXPORT 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 842 of file scip_param.c.

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

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetEmphasis()

SCIP_EXPORT 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 871 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_EXPORT 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 893 of file scip_param.c.

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

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

◆ SCIPsetHeuristics()

SCIP_EXPORT 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 916 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(), searchEcAggrWithMIP(), setSubproblemParams(), setupAndSolveSubscipOneopt(), setupSCIPparamsFP2(), solvePricingMINLP(), and solveSubproblem().

◆ SCIPsetPresolving()

SCIP_EXPORT 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 942 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(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), SCIPbendersApplyDecomposition(), SCIPsetCommonSubscipParams(), setSubproblemParams(), setSubscipParameters(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsFP2(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), solveSubNLP(), solveSubproblem(), subscipSetParams(), wrapperDins(), and wrapperRins().

◆ SCIPsetSeparating()

SCIP_EXPORT 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 968 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(), SCIPsetCommonSubscipParams(), setSubscipParameters(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupAndSolveSubscipOneopt(), setupAndSolveSubscipRapidlearning(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), solveCoveringProblem(), subscipSetParams(), wrapperDins(), and wrapperRins().

◆ SCIPgetParams()

SCIP_EXPORT 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 988 of file scip_param.c.

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

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

◆ SCIPgetNParams()

SCIP_EXPORT 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 1002 of file scip_param.c.

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

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

◆ SCIPgetSubscipsOff()

SCIP_EXPORT 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 1016 of file scip_param.c.

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

Referenced by SCIP_DECL_EVENTINITSOL().