SCIP
Solving Constraint Integer Programs
Detailed Description
methods for the inclusion and access to reader plugins of SCIP
Function Documentation
◆ SCIPreaderGetData()
| SCIP_READERDATA* SCIPreaderGetData | ( | SCIP_READER * | reader | ) |
gets user data of reader
- Parameters
-
reader reader
Definition at line 483 of file reader.c.
References NULL, and SCIP_Reader::readerdata.
Referenced by createReaderdata(), createStages(), freeReaderdata(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERFREE(), SCIP_DECL_READERREAD(), SCIP_DECL_READERWRITE(), SCIPcorGetConsName(), SCIPcorGetNConsNames(), SCIPcorGetNVarNames(), SCIPcorGetVarName(), SCIPcorHasRead(), SCIPfindObjReader(), SCIPgetObjReader(), SCIPprintSolReaderFzn(), SCIPreadCor(), SCIPreadSto(), SCIPreadTim(), SCIPstoGetNScenarios(), SCIPtimConsGetStageName(), SCIPtimFindStage(), SCIPtimGetNStages(), SCIPtimGetStageConss(), SCIPtimGetStageName(), SCIPtimGetStageNConss(), SCIPtimGetStageNVars(), SCIPtimGetStageVars(), SCIPtimHasRead(), SCIPwriteLp(), and SCIPwriteMps().
◆ SCIPreaderSetData()
| void SCIPreaderSetData | ( | SCIP_READER * | reader, |
| SCIP_READERDATA * | readerdata | ||
| ) |
sets user data of reader; user has to free old data in advance!
- Parameters
-
reader reader readerdata new reader user data
Definition at line 493 of file reader.c.
References NULL, and SCIP_Reader::readerdata.
Referenced by SCIP_DECL_READERFREE().
◆ SCIPreaderGetName()
| const char* SCIPreaderGetName | ( | SCIP_READER * | reader | ) |
gets name of reader
- Parameters
-
reader reader
Definition at line 548 of file reader.c.
References SCIP_Reader::name, and NULL.
Referenced by displayReaders(), printProblem(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERFREE(), SCIP_DECL_READERREAD(), SCIP_DECL_READERWRITE(), SCIPcorGetConsName(), SCIPcorGetNConsNames(), SCIPcorGetNVarNames(), SCIPcorGetVarName(), SCIPcorHasRead(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), SCIPreaderCopyInclude(), SCIPreadProb(), SCIPstoGetNScenarios(), SCIPtimConsGetStageName(), SCIPtimFindStage(), SCIPtimGetNStages(), SCIPtimGetStageConss(), SCIPtimGetStageName(), SCIPtimGetStageNConss(), SCIPtimGetStageNVars(), SCIPtimGetStageVars(), SCIPtimHasRead(), and SCIPwriteMps().
◆ SCIPreaderGetDesc()
| const char* SCIPreaderGetDesc | ( | SCIP_READER * | reader | ) |
gets description of reader
- Parameters
-
reader reader
Definition at line 558 of file reader.c.
References SCIP_Reader::desc, and NULL.
Referenced by displayReaders(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
◆ SCIPreaderGetExtension()
| const char* SCIPreaderGetExtension | ( | SCIP_READER * | reader | ) |
gets file extension of reader
- Parameters
-
reader reader
Definition at line 568 of file reader.c.
References SCIP_Reader::extension, and NULL.
Referenced by displayReaders().
◆ SCIPreaderCanRead()
| SCIP_Bool SCIPreaderCanRead | ( | SCIP_READER * | reader | ) |
return whether the reader can read files
- Parameters
-
reader reader
Definition at line 578 of file reader.c.
References NULL.
Referenced by displayReaders().
◆ SCIPreaderCanWrite()
| SCIP_Bool SCIPreaderCanWrite | ( | SCIP_READER * | reader | ) |
return whether the reader can write files
- Parameters
-
reader reader
Definition at line 588 of file reader.c.
References NULL.
Referenced by displayReaders().
◆ SCIPincludeReader()
| SCIP_RETCODE SCIPincludeReader | ( | SCIP * | scip, |
| const char * | name, | ||
| const char * | desc, | ||
| const char * | extension, | ||
| SCIP_DECL_READERCOPY((*readercopy)) | , | ||
| SCIP_DECL_READERFREE((*readerfree)) | , | ||
| SCIP_DECL_READERREAD((*readerread)) | , | ||
| SCIP_DECL_READERWRITE((*readerwrite)) | , | ||
| SCIP_READERDATA * | readerdata | ||
| ) |
creates a reader and includes it in SCIP
- 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.
- Precondition
- This method can be called if SCIP is in one of the following stages:
- Note
- method has all reader callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeReaderBasic() and setter functions if you seek for a method which is less likely to change in future releases
- Parameters
-
scip SCIP data structure name name of reader desc description of reader extension file extension that reader processes readerdata reader data
Definition at line 57 of file scip_reader.c.
References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindReader(), SCIPreaderCreate(), SCIPsetIncludeReader(), Scip::set, and TRUE.
Referenced by SCIPincludeObjReader(), SCIPincludeReaderPbm(), and SCIPincludeReaderRcp().
◆ SCIPincludeReaderBasic()
| SCIP_RETCODE SCIPincludeReaderBasic | ( | SCIP * | scip, |
| SCIP_READER ** | readerptr, | ||
| const char * | name, | ||
| const char * | desc, | ||
| const char * | extension, | ||
| SCIP_READERDATA * | readerdata | ||
| ) |
creates a reader and includes it in SCIP. All non-fundamental (or optional) callbacks will be set to NULL. Optional callbacks can be set via specific setter functions, see SCIPsetReaderCopy(), SCIPsetReaderFree(), SCIPsetReaderRead(), SCIPsetReaderWrite().
- 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.
- Precondition
- This method can be called if SCIP is in one of the following stages:
- Note
- if you want to set all callbacks with a single method call, consider using SCIPincludeReader() instead
- Parameters
-
scip SCIP data structure readerptr reference to reader pointer, or NULL name name of reader desc description of reader extension file extension that reader processes readerdata reader data
Definition at line 100 of file scip_reader.c.
References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindReader(), SCIPreaderCreate(), SCIPsetIncludeReader(), Scip::set, and TRUE.
Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderBpa(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCmin(), SCIPincludeReaderCnf(), SCIPincludeReaderCol(), SCIPincludeReaderCor(), SCIPincludeReaderCsol(), SCIPincludeReaderCyc(), SCIPincludeReaderDec(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderGr(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderStp(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), and SCIPincludeReaderZpl().
◆ SCIPsetReaderCopy()
| SCIP_RETCODE SCIPsetReaderCopy | ( | SCIP * | scip, |
| SCIP_READER * | reader, | ||
| SCIP_DECL_READERCOPY((*readercopy)) | |||
| ) |
set copy method of reader
- 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.
- Precondition
- This method can be called if SCIP is in one of the following stages:
- Parameters
-
scip SCIP data structure reader reader
Definition at line 138 of file scip_reader.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPreaderSetCopy(), and TRUE.
Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCnf(), SCIPincludeReaderCol(), SCIPincludeReaderCor(), SCIPincludeReaderCsol(), SCIPincludeReaderCyc(), SCIPincludeReaderDec(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderGr(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderStp(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), and SCIPincludeReaderZpl().
◆ SCIPsetReaderFree()
| SCIP_RETCODE SCIPsetReaderFree | ( | SCIP * | scip, |
| SCIP_READER * | reader, | ||
| SCIP_DECL_READERFREE((*readerfree)) | |||
| ) |
set deinitialization method of reader
- 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.
- Precondition
- This method can be called if SCIP is in one of the following stages:
- Parameters
-
scip SCIP data structure reader reader
Definition at line 162 of file scip_reader.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPreaderSetFree(), and TRUE.
Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCip(), SCIPincludeReaderCor(), SCIPincludeReaderDiff(), SCIPincludeReaderFzn(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderPpm(), SCIPincludeReaderScflp(), SCIPincludeReaderSto(), and SCIPincludeReaderTim().
◆ SCIPsetReaderRead()
| SCIP_RETCODE SCIPsetReaderRead | ( | SCIP * | scip, |
| SCIP_READER * | reader, | ||
| SCIP_DECL_READERREAD((*readerread)) | |||
| ) |
set read method of reader
- 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.
- Precondition
- This method can be called if SCIP is in one of the following stages:
- Parameters
-
scip SCIP data structure reader reader
Definition at line 186 of file scip_reader.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPreaderSetRead(), and TRUE.
Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderBpa(), SCIPincludeReaderCip(), SCIPincludeReaderCmin(), SCIPincludeReaderCnf(), SCIPincludeReaderCol(), SCIPincludeReaderCor(), SCIPincludeReaderCsol(), SCIPincludeReaderCyc(), SCIPincludeReaderDec(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGr(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderRlp(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderStp(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), and SCIPincludeReaderZpl().
◆ SCIPsetReaderWrite()
| SCIP_RETCODE SCIPsetReaderWrite | ( | SCIP * | scip, |
| SCIP_READER * | reader, | ||
| SCIP_DECL_READERWRITE((*readerwrite)) | |||
| ) |
set write method of reader
- 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.
- Precondition
- This method can be called if SCIP is in one of the following stages:
- Parameters
-
scip SCIP data structure reader reader
Definition at line 210 of file scip_reader.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPreaderSetWrite(), and TRUE.
Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCsol(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderOpb(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderStp(), and SCIPincludeReaderWbo().
◆ SCIPfindReader()
| SCIP_READER* SCIPfindReader | ( | SCIP * | scip, |
| const char * | name | ||
| ) |
returns the reader of the given name, or NULL if not existing
- Parameters
-
scip SCIP data structure name name of reader
Definition at line 226 of file scip_reader.c.
References NULL, SCIPsetFindReader(), and Scip::set.
Referenced by SCIP_DECL_READERREAD(), SCIPfindObjReader(), SCIPincludeReader(), SCIPincludeReaderBasic(), SCIPprintSolReaderFzn(), SCIPreadCor(), SCIPreadSto(), SCIPreadTim(), SCIPstoGetNScenarios(), SCIPtimConsGetStageName(), SCIPtimFindStage(), SCIPtimGetNStages(), SCIPtimGetStageConss(), SCIPtimGetStageName(), SCIPtimGetStageNConss(), SCIPtimGetStageNVars(), SCIPtimGetStageVars(), and SCIPwriteLp().
◆ SCIPgetReaders()
| SCIP_READER** SCIPgetReaders | ( | SCIP * | scip | ) |
returns the array of currently available readers
- Parameters
-
scip SCIP data structure
Definition at line 239 of file scip_reader.c.
References NULL, SCIP_Set::readers, and Scip::set.
Referenced by displayReaders(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
◆ SCIPgetNReaders()
| int SCIPgetNReaders | ( | SCIP * | scip | ) |
returns the number of currently available readers
- Parameters
-
scip SCIP data structure
Definition at line 250 of file scip_reader.c.
References SCIP_Set::nreaders, NULL, and Scip::set.
Referenced by displayReaders(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().