Detailed Description
commonly used methods for strings
Functions | |
SCIP_EXPORT int | SCIPmemccpy (char *dest, const char *src, char stop, unsigned int cnt) |
SCIP_EXPORT void | SCIPprintSysError (const char *message) |
SCIP_EXPORT char * | SCIPstrtok (char *s, const char *delim, char **ptrptr) |
SCIP_EXPORT void | SCIPescapeString (char *t, int bufsize, const char *s) |
SCIP_EXPORT int | SCIPsnprintf (char *t, int len, const char *s,...) |
SCIP_EXPORT int | SCIPstrncpy (char *t, const char *s, int size) |
SCIP_EXPORT SCIP_Bool | SCIPstrToIntValue (const char *str, int *value, char **endptr) |
SCIP_EXPORT SCIP_Bool | SCIPstrToRealValue (const char *str, SCIP_Real *value, char **endptr) |
SCIP_EXPORT void | SCIPstrCopySection (const char *str, char startchar, char endchar, char *token, int size, char **endptr) |
SCIP_EXPORT SCIP_Bool | SCIPstrAtStart (const char *s, const char *t, size_t tlen) |
Function Documentation
◆ SCIPmemccpy()
SCIP_EXPORT int SCIPmemccpy | ( | char * | dest, |
const char * | src, | ||
char | stop, | ||
unsigned int | cnt | ||
) |
copies characters from 'src' to 'dest', copying is stopped when either the 'stop' character is reached or after 'cnt' characters have been copied, whichever comes first.
- Note
- undefined behaviuor on overlapping arrays
copies characters from 'src' to 'dest', copying is stopped when either the 'stop' character is reached or after 'cnt' characters have been copied, whichever comes first.
- Note
- undefined behavior on overlapping arrays
- Parameters
-
dest destination pointer to copy to src source pointer to copy from stop character when found stop copying cnt maximal number of characters to copy
Definition at line 10488 of file misc.c.
References NULL.
Referenced by generateSecantCutNoCheck(), mpsinputSetObjname(), mpsinputSetProbname(), readBounds(), readCoefficients(), readCols(), readColsMop(), readRanges(), readRhs(), readSOS(), readSos(), stoinputSetProbname(), stoinputSetStochtype(), and timinputSetProbname().
◆ SCIPprintSysError()
SCIP_EXPORT void SCIPprintSysError | ( | const char * | message | ) |
prints an error message containing of the given string followed by a string describing the current system error; prefers to use the strerror_r method, which is threadsafe; on systems where this method does not exist, NO_STRERROR_R should be defined (see INSTALL), in this case, srerror is used which is not guaranteed to be threadsafe (on SUN-systems, it actually is)
prints an error message containing of the given string followed by a string describing the current system error
Prefers to use the strerror_r method, which is threadsafe. On systems where this method does not exist, NO_STRERROR_R should be defined (see INSTALL). In this case, strerror is used which is not guaranteed to be threadsafe (on SUN-systems, it actually is).
- Parameters
-
message first part of the error message, e.g. the filename
Definition at line 10513 of file misc.c.
References NULL, SCIP_MAXSTRLEN, and SCIPmessagePrintError().
Referenced by LOPreadFile(), processArguments(), readBounds(), readDecomposition(), readDiffFile(), readFZNFile(), readLIBSVM(), readLPFile(), readMOP(), readMps(), readOPBFile(), readPIPFile(), readSol(), readSolFile(), readSto(), readTim(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_READERREAD(), SCIPlpWriteMip(), SCIPparamsetRead(), SCIPparamsetWrite(), SCIPparamWrite(), SCIPprobdataCreate(), SCIPprocessShellArguments(), SCIPvisualInit(), SCIPvisualizeConsCumulative(), and writeProblem().
◆ SCIPstrtok()
SCIP_EXPORT char* SCIPstrtok | ( | char * | s, |
const char * | delim, | ||
char ** | ptrptr | ||
) |
extracts tokens from strings - wrapper method for strtok_r()
- Parameters
-
s string to parse delim delimiters for parsing ptrptr pointer to working char pointer - must stay the same while parsing
Definition at line 10562 of file misc.c.
Referenced by findBestObjectiveValue(), getNJobs(), getNResources(), getResourcesNames(), mpsinputReadLine(), parseConstraint(), readCnf(), SCIP_DECL_CONSPARSE(), smpsinputReadLine(), stoinputReadLine(), and timinputReadLine().
◆ SCIPescapeString()
SCIP_EXPORT void SCIPescapeString | ( | char * | t, |
int | bufsize, | ||
const char * | s | ||
) |
translates the given string into a string where symbols ", ', and spaces are escaped with a \ prefix
- Parameters
-
t target buffer to store escaped string bufsize size of buffer t s string to transform into escaped string
Definition at line 10576 of file misc.c.
References NULL.
Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPdialoghdlrAddHistory().
◆ SCIPsnprintf()
SCIP_EXPORT int SCIPsnprintf | ( | char * | t, |
int | len, | ||
const char * | s, | ||
... | |||
) |
safe version of snprintf
- Parameters
-
t target string len length of the string to copy s source string
Definition at line 10604 of file misc.c.
References NULL, and SCIPerrorMessage.
Referenced by ObjPricerVRP::add_tour_variable(), addAuxiliaryVariablesToMaster(), addBranchingComplementaritiesSOS1(), addCliques(), addCut(), addExtendedAsymmetricFormulation(), addExtendedFlowFormulation(), addExtraCliques(), addFixParamDialog(), addLocalBranchingConstraint(), addLocalbranchingConstraintAndObjcutoff(), addLocalConss(), addPathCuts(), addRelaxation(), addScenarioVarsAndConsToProb(), addSetParamDialog(), addSlackVars(), addSplitcons(), addSubtourCuts(), addSymresackConss(), addSymresackInequality(), addTourCuts(), addTrustRegionConstraints(), addVarbound(), addVarCardinality(), addVariable(), adjustOversizedJobBounds(), aggregation(), alnsIncludeNeighborhood(), appendVarCardinality(), applyCliqueFixings(), applyFixings(), applyRepair(), assignAuxiliaryVariables(), BENDERS_CUTORACLE(), blockCreateSubscip(), branchBalancedCardinality(), branchOnVertex(), btPrintSubtree(), buildScenariosFromBlocks(), checkConsnames(), checkVarnames(), cliquePresolve(), componentCreateSubscip(), computeCut(), computeEffectiveHorizon(), computeInteriorPoint(), computeMinDistance(), consdataCollectLinkingCons(), consdataCreateBinvars(), copyCuts(), createAndAddAndCons(), createAndAddLinearCons(), createAndAddProofcons(), createAndAddTransferredCut(), createAndApplyStoredBendersCut(), createCapacityRestriction(), createCapacityRestrictionIntvars(), createCGCutCMIR(), createCGCutDirect(), createCGCutStrongCG(), createCipFormulation(), createConflict(), createConstraints(), createCoverCutsTimepoint(), createCoveringProblem(), createDegreeConstraints(), createIndicatorConstraint(), createInitialColumns(), createIntervalRelaxation(), createKKTComplementarityBinary(), createKKTComplementarityBounds(), createKKTComplementarityLinear(), createKKTDualCons(), createMasterproblem(), createMIP(), createMipCpFormulation(), createMipFormulation(), createOriginalproblem(), createPartitionCut(), createPatternVars(), createPrizeConstraints(), createProbOnlyEdge(), createProbQP(), createProbSimplified(), createProbSimplifiedTest(), createRelaxation(), createRows(), createScenariosFromBlocks(), createSubproblem(), createSubproblems(), createSubSCIP(), createSubscip(), createVariableMappings(), createVariables(), createVarUbs(), deleteRedundantVars(), detectRedundantVars(), disaggregate(), displayRelevantStats(), doBendersCreate(), doBenderscutCreate(), doBranchruleCreate(), doComprCreate(), doConcsolverTypeCreate(), doConflicthdlrCreate(), doConshdlrCreate(), doCopy(), doDispCreate(), doHeurCreate(), doNodeselCreate(), doPresolCreate(), doPricerCreate(), doPropCreate(), doRelaxCreate(), doSepaCreate(), doTableCreate(), dualPresolve(), execmain(), extendToCover(), extensionOperatorSOS1(), extractGates(), findAggregation(), findBestObjectiveValue(), findCumulativeConss(), findScenarioVar(), fixDeleteOrUpgradeCons(), flattenAssignment(), flattenFloat(), forbidCover(), forbidFixation(), generateAndApplyBendersCuts(), generateAndApplyBendersIntegerCuts(), generateAndApplyBendersNogoodCut(), generateBoundInequalityFromSOS1Nodes(), generateConvexConcaveEstimator(), generateCut(), generateCutConvex(), generateCutFactorableDo(), generateCutLTI(), generateCutNonConvex(), generateCutPoint(), generateCutProjectedPoint(), generateCutSol(), generateDisjCutSOS1(), generateLinearizationCut(), generateOddCycleCut(), generateRowCardinality(), generateRowSOS2(), generateSecantCut(), generateZerohalfCut(), get_scale_order(), getFixedVariable(), getJobs(), getScenarioDecompVar(), getScenarioEntityName(), graph_load(), includeConshdlrCountsols(), infinityCountUpdate(), initLP(), initProblem(), LOPseparate(), lpBarrier(), lpDualSimplex(), lpPrimalSimplex(), newsolCliqueAddRow(), nodepartitionIsConnected(), paramsetSetHeuristicsAggressive(), paramsetSetHeuristicsDefault(), paramsetSetHeuristicsFast(), paramsetSetHeuristicsOff(), paramsetSetPresolvingAggressive(), paramsetSetPresolvingDefault(), paramsetSetPresolvingFast(), paramsetSetPresolvingOff(), paramsetSetSeparatingAggressive(), paramsetSetSeparatingDefault(), paramsetSetSeparatingOff(), parseConstantArray(), parseConstraint(), parseName(), parseVariableArray(), performImplicationGraphAnalysis(), preprocessConstraintPairs(), presolveAddKKTLinearCons(), presolveCreateBenTalNemirovskiApproxDim3(), presolveCreateGlineurApproxDim3(), presolveCreateOuterApprox(), presolveDisaggregate(), presolveFindDuplicates(), presolveTryAddAND(), presolveTryAddLinearReform(), pricing(), printActiveVariables(), printAggregatedCons(), printAndCons(), printBoundSection(), printConformName(), printEntry(), printExpr(), printIndicatorCons(), printLinearCons(), printLinearRow(), printName(), printNLRow(), printNonlinearRow(), printPBRow(), printQuadraticRow(), printRecord(), printReport(), printRow(), printRowNl(), printRowType(), printSignpowerRow(), printSOCCons(), printSOSCons(), printSosCons(), printStart(), probdataPrintGraph(), processArguments(), processNlRow(), propIndicator(), readArguments(), readBlocks(), readBounds(), readCnf(), readCnfLine(), readConstraints(), readIndep(), readIndicators(), readLIBSVM(), readScenarios(), readSemicontinuous(), readSol(), readSolFile(), readSOS(), readSos(), readSOScons(), readVariables(), real2String(), reformMonomial(), reformNode2Var(), reformulate(), resolvePropagation(), SCIP_DECL_BENDERSCUTEXEC(), SCIP_DECL_CONCSOLVERCREATEINST(), SCIP_DECL_CONFLICTEXEC(), SCIP_DECL_CONSENFOLP(), SCIP_DECL_CONSINITLP(), SCIP_DECL_CONSINITPRE(), SCIP_DECL_CONSPARSE(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_CONSTRANS(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EXPRGRAPHNODEREFORM(), SCIP_DECL_HEUREXEC(), SCIP_DECL_LINCONSUPGD(), SCIP_DECL_NONLINCONSUPGD(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PRESOLEXEC(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_QUADCONSUPGD(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERREAD(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SOLVECUMULATIVE(), SCIPaddTrustregionNeighborhoodConstraint(), SCIPbendersApplyDecomposition(), SCIPbendersMergeSubproblemIntoMaster(), SCIPconcsolverCreateInstance(), SCIPcopyLargeNeighborhoodSearch(), SCIPcreateConsCardinality(), SCIPcreateConsIndicator(), SCIPcreateNlpSolverWorhp(), SCIPcreateSchedulingProblem(), SCIPdecompPrintStats(), SCIPdialogDisplayMenuEntry(), SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), SCIPdialoghdlrCreate(), SCIPdialoghdlrGetLine(), SCIPdialoghdlrGetWord(), SCIPdigraphPrintGml(), SCIPdispLongint(), SCIPdispTime(), SCIPdivesetCreate(), SCIPException::SCIPException(), SCIPgetErrorString(), SCIPgetVarCopy(), SCIPincludeBenderscutInt(), SCIPincludeBenderscutNogood(), SCIPincludeBenderscutOpt(), SCIPincludeNlpi(), SCIPincludeNonlinconsUpgrade(), SCIPincludeQuadconsUpgrade(), SCIPincludeReaderZpl(), SCIPlpiReadLP(), SCIPlpiWriteLP(), SCIPlpWriteMip(), SCIPnlpiOraclePrintProblemGams(), SCIPnodePrintAncestorBranchings(), SCIPparamsetSetEmphasis(), SCIPparamsetSetToSubscipsOff(), SCIPprintConflictStatistics(), SCIPprintReal(), SCIPprintSolutionStatistics(), SCIPprobdataAddNewSol(), SCIPprobdataCreate(), SCIPprobdataPrintGraph2(), SCIPprobTransform(), SCIPreaderWrite(), SCIPregForestFromFile(), SCIPreoptApplyCuts(), SCIPreoptApplyGlbConss(), SCIPsetConshdlrPresol(), SCIPsetConshdlrProp(), SCIPsetConshdlrSepa(), SCIPsetPropPresol(), SCIPsnprintfProbingStats(), SCIPStpIncludeHeurTM(), SCIPtransformMinUC(), SCIPvarNegate(), SCIPvarTransform(), SCIPverifyCircularPatternNLP(), SCIPvisualizeConsCumulative(), SCIPwriteCliqueGraph(), SCIPwriteGms(), SCIPwriteLp(), SCIPwriteMps(), SCIPwritePip(), separateCons(), separateCuts(), separateGLS(), separateIndicators(), separatePerspective(), separateSCIs(), separateSequLiftedExtendedWeightInequality(), separateSequLiftedMinimalCoverInequality(), separateSupLiftedMinimalCoverInequality(), setObjective(), setupAndSolveCumulativeSubscip(), setupAndSolveFiniteSolSubscip(), setupProblem(), setupSubscipLpface(), solveClassification(), solveMinIISC(), solvePricingMINLP(), strengthenVarbounds(), syntaxError(), tightenCoefs(), tightenSingleVar(), tightenWeights(), toString(), tryAggregateIntVars(), tryUpgradingLogicor(), tryUpgradingSetppc(), tryUpgradingXor(), updateSolNodeArray(), upgradeCons(), upgradeIndicatorSuperindicator(), upgradeLinearSuperindicator(), varSetName(), visualizeSolutionAscii(), writeFzn(), writeOpb(), writeOpbFixedVars(), writeOpbObjective(), and writeOpbRelevantAnds().
◆ SCIPstrncpy()
SCIP_EXPORT int SCIPstrncpy | ( | char * | t, |
const char * | s, | ||
int | size | ||
) |
safe version of strncpy
Copies string in s to t using at most size-1 nonzero characters (strncpy copies size characters). It always adds a terminating zero char. Does not pad the remaining string with zero characters (unlike strncpy). Returns the number of copied nonzero characters, if the length of s is at most size - 1, and returns size otherwise. Thus, the original string was truncated if the return value is size.
- Parameters
-
t target string s source string size maximal size of t
Definition at line 10647 of file misc.c.
Referenced by appendBuffer(), exprparseReadVariable(), readInputLine(), readPolynomial(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_READERREAD(), SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), and xmlProcess().
◆ SCIPstrToIntValue()
SCIP_EXPORT SCIP_Bool SCIPstrToIntValue | ( | const char * | str, |
int * | value, | ||
char ** | endptr | ||
) |
extract the next token as a integer value if it is one; in case no value is parsed the endptr is set to str
- Returns
- Returns TRUE if a value could be extracted, otherwise FALSE
- Parameters
-
str string to search value pointer to store the parsed value endptr pointer to store the final string position if successfully parsed, otherwise str
Definition at line 10674 of file misc.c.
References FALSE, NULL, SCIPdebugMessage, and TRUE.
Referenced by exprParse(), getJobId(), getJobs(), getPrecedence(), parseDetails(), readFile(), and SCIP_DECL_DIALOGEXEC().
◆ SCIPstrToRealValue()
SCIP_EXPORT SCIP_Bool SCIPstrToRealValue | ( | const char * | str, |
SCIP_Real * | value, | ||
char ** | endptr | ||
) |
extract the next token as a double value if it is one; in case a value is parsed the endptr is set to str
- Returns
- Returns TRUE if a value could be extracted, otherwise FALSE
extract the next token as a double value if it is one; in case no value is parsed the endptr is set to str
- Returns
- Returns TRUE if a value could be extracted, otherwise FALSE
- Parameters
-
str string to search value pointer to store the parsed value endptr pointer to store the final string position if successfully parsed, otherwise str
Definition at line 10705 of file misc.c.
References FALSE, NULL, SCIPdebugMessage, and TRUE.
Referenced by exprParse(), getFixedVariable(), getNJobs(), getNResources(), getObjective(), getResourcesCapacities(), parseValue(), SCIP_DECL_CONSPARSE(), SCIPparseReal(), SCIPparseVarsPolynomial(), SCIPregForestFromFile(), and varParse().
◆ SCIPstrCopySection()
SCIP_EXPORT void SCIPstrCopySection | ( | const char * | str, |
char | startchar, | ||
char | endchar, | ||
char * | token, | ||
int | size, | ||
char ** | endptr | ||
) |
copies the first size characters between a start and end character of str into token, if no error occurred endptr will point to the position after the read part, otherwise it will point to str
- Parameters
-
str string to search startchar character which defines the beginning endchar character which defines the ending token string to store the copy size size of the token char array endptr pointer to store the final string position if successfully parsed, otherwise str
Definition at line 10735 of file misc.c.
References NULL, SCIP_MAXSTRLEN, and SCIPdebugMessage.
Referenced by parseBounds(), parseDetails(), SCIP_DECL_CONSPARSE(), SCIPconsParse(), SCIPparseVarName(), and varParse().
◆ SCIPstrAtStart()
SCIP_EXPORT SCIP_Bool SCIPstrAtStart | ( | const char * | s, |
const char * | t, | ||
size_t | tlen | ||
) |
checks whether a given string t appears at the beginning of the string s (up to spaces at beginning)
- Parameters
-
s string to search in t string to search for tlen length of t
Definition at line 11114 of file misc.c.
References FALSE, NULL, SCIP_MAXSTRLEN, and TRUE.
Referenced by SCIP_DECL_READERREAD().