SCIP Doxygen Documentation
Loading...
Searching...
No Matches
Reader
Public API of SCIP » Core API » Methods for managing plugins

Detailed Description

functions for the inclusion and access to reader plugins of SCIP

Functions

SCIP_READERDATA * SCIPreaderGetData (SCIP_READER *reader)
void SCIPreaderSetData (SCIP_READER *reader, SCIP_READERDATA *readerdata)
void SCIPreaderMarkExact (SCIP_READER *reader)
const char * SCIPreaderGetName (SCIP_READER *reader)
const char * SCIPreaderGetDesc (SCIP_READER *reader)
const char * SCIPreaderGetExtension (SCIP_READER *reader)
SCIP_Bool SCIPreaderCanRead (SCIP_READER *reader)
SCIP_Bool SCIPreaderCanWrite (SCIP_READER *reader)
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)
SCIP_RETCODE SCIPincludeReaderBasic (SCIP *scip, SCIP_READER **readerptr, const char *name, const char *desc, const char *extension, SCIP_READERDATA *readerdata)
SCIP_RETCODE SCIPsetReaderCopy (SCIP *scip, SCIP_READER *reader,)
SCIP_RETCODE SCIPsetReaderFree (SCIP *scip, SCIP_READER *reader,)
SCIP_RETCODE SCIPsetReaderRead (SCIP *scip, SCIP_READER *reader,)
SCIP_RETCODE SCIPsetReaderWrite (SCIP *scip, SCIP_READER *reader,)
SCIP_READER * SCIPfindReader (SCIP *scip, const char *name)
SCIP_READER ** SCIPgetReaders (SCIP *scip)
int SCIPgetNReaders (SCIP *scip)

Function Documentation

◆ SCIPreaderGetData()

SCIP_READERDATA * SCIPreaderGetData ( SCIP_READER * reader)

gets user data of reader

Parameters
readerreader

Definition at line 625 of file reader.c.

References assert(), NULL, SCIP_Reader::readerdata, and SCIPreaderGetData().

Referenced by createReaderdata(), createStages(), readOPBFile(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIPcorGetConsName(), SCIPcorGetNConsNames(), SCIPcorGetNVarNames(), SCIPcorGetVarName(), SCIPcorHasRead(), SCIPfindObjReader(), SCIPfreeReaderdataCor(), SCIPfreeReaderdataSto(), SCIPfreeReaderdataTim(), SCIPgetObjReader(), SCIPincludeReaderWbo(), SCIPprintSolReaderFzn(), SCIPreadCor(), SCIPreaderGetData(), 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
readerreader
readerdatanew reader user data

Definition at line 635 of file reader.c.

References assert(), NULL, SCIP_Reader::readerdata, and SCIPreaderSetData().

Referenced by SCIP_DECL_READERFREE(), and SCIPreaderSetData().

◆ SCIPreaderMarkExact()

void SCIPreaderMarkExact ( SCIP_READER * reader)

marks the reader as safe to use in exact solving mode

Parameters
readerreader

Definition at line 690 of file reader.c.

References assert(), SCIP_Reader::exact, NULL, SCIPreaderMarkExact(), and TRUE.

Referenced by SCIPincludeReaderCip(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderOpb(), SCIPincludeReaderSol(), SCIPincludeReaderWbo(), SCIPincludeReaderZpl(), and SCIPreaderMarkExact().

◆ SCIPreaderGetName()

const char * SCIPreaderGetName ( SCIP_READER * reader)

gets name of reader

Parameters
readerreader

Definition at line 700 of file reader.c.

References assert(), SCIP_Reader::name, NULL, and SCIPreaderGetName().

Referenced by displayReaders(), printProblem(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERCOPY(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERFREE(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIP_DECL_READERWRITE(), SCIPcorGetConsName(), SCIPcorGetNConsNames(), SCIPcorGetNVarNames(), SCIPcorGetVarName(), SCIPcorHasRead(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), SCIPreaderCopyInclude(), SCIPreaderGetName(), SCIPreaderRead(), SCIPreaderWrite(), 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
readerreader

Definition at line 710 of file reader.c.

References assert(), SCIP_Reader::desc, NULL, and SCIPreaderGetDesc().

Referenced by displayReaders(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPreaderGetDesc().

◆ SCIPreaderGetExtension()

const char * SCIPreaderGetExtension ( SCIP_READER * reader)

gets file extension of reader

Parameters
readerreader

Definition at line 720 of file reader.c.

References assert(), SCIP_Reader::extension, NULL, and SCIPreaderGetExtension().

Referenced by displayReaders(), and SCIPreaderGetExtension().

◆ SCIPreaderCanRead()

SCIP_Bool SCIPreaderCanRead ( SCIP_READER * reader)

return whether the reader can read files

Parameters
readerreader

Definition at line 730 of file reader.c.

References assert(), NULL, SCIP_Bool, and SCIPreaderCanRead().

Referenced by displayReaders(), and SCIPreaderCanRead().

◆ SCIPreaderCanWrite()

SCIP_Bool SCIPreaderCanWrite ( SCIP_READER * reader)

return whether the reader can write files

Parameters
readerreader

Definition at line 740 of file reader.c.

References assert(), NULL, SCIP_Bool, and SCIPreaderCanWrite().

Referenced by displayReaders(), and SCIPreaderCanWrite().

◆ 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
scipSCIP data structure
namename of reader
descdescription of reader
extensionfile extension that reader processes
-copy method of reader or NULL if you don't want to copy your plugin into sub-SCIPs
-destructor of reader
-read method
-write method
readerdatareader data

Definition at line 66 of file scip_reader.c.

References FALSE, NULL, SCIP_CALL, SCIP_DECL_READERCOPY, SCIP_DECL_READERFREE, SCIP_DECL_READERREAD, SCIP_DECL_READERWRITE, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPfindReader(), SCIPincludeReader(), SCIPreaderCreate(), SCIPsetIncludeReader(), and TRUE.

Referenced by SCIPincludeObjReader(), SCIPincludeReader(), 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
scipSCIP data structure
readerptrreference to reader pointer, or NULL
namename of reader
descdescription of reader
extensionfile extension that reader processes
readerdatareader data

Definition at line 109 of file scip_reader.c.

References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPfindReader(), SCIPincludeReaderBasic(), SCIPreaderCreate(), SCIPsetIncludeReader(), and TRUE.

Referenced by SCIPincludeReaderBasic(), SCIPincludeReaderBnd(), SCIPincludeReaderBpa(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCmin(), SCIPincludeReaderCnf(), SCIPincludeReaderCol(), SCIPincludeReaderCor(), SCIPincludeReaderCsol(), SCIPincludeReaderCyc(), SCIPincludeReaderDec(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), and SCIPincludeReaderZpl().

◆ SCIPsetReaderCopy()

SCIP_RETCODE SCIPsetReaderCopy ( SCIP * scip,
SCIP_READER * reader )

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
scipSCIP data structure
readerreader copy method of reader or NULL if you don't want to copy your plugin into sub-SCIPs

Definition at line 147 of file scip_reader.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_READERCOPY, SCIP_OKAY, SCIPcheckStage, SCIPreaderSetCopy(), SCIPsetReaderCopy(), and TRUE.

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCnf(), SCIPincludeReaderCol(), SCIPincludeReaderCor(), SCIPincludeReaderCsol(), SCIPincludeReaderCyc(), SCIPincludeReaderDec(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), SCIPincludeReaderZpl(), and SCIPsetReaderCopy().

◆ SCIPsetReaderFree()

SCIP_RETCODE SCIPsetReaderFree ( SCIP * scip,
SCIP_READER * reader )

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
scipSCIP data structure
readerreader destructor of reader

Definition at line 171 of file scip_reader.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_READERFREE, SCIP_OKAY, SCIPcheckStage, SCIPreaderSetFree(), SCIPsetReaderFree(), and TRUE.

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCip(), SCIPincludeReaderCor(), SCIPincludeReaderDiff(), SCIPincludeReaderFzn(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderOpb(), SCIPincludeReaderPpm(), SCIPincludeReaderScflp(), SCIPincludeReaderSto(), SCIPincludeReaderTim(), and SCIPsetReaderFree().

◆ SCIPsetReaderRead()

SCIP_RETCODE SCIPsetReaderRead ( SCIP * scip,
SCIP_READER * reader )

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
scipSCIP data structure
readerreader read method of reader

Definition at line 195 of file scip_reader.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_READERREAD, SCIP_OKAY, SCIPcheckStage, SCIPreaderSetRead(), SCIPsetReaderRead(), and TRUE.

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderBpa(), SCIPincludeReaderCip(), SCIPincludeReaderCmin(), SCIPincludeReaderCnf(), SCIPincludeReaderCol(), SCIPincludeReaderCor(), SCIPincludeReaderCsol(), SCIPincludeReaderCyc(), SCIPincludeReaderDec(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderRlp(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), SCIPincludeReaderZpl(), and SCIPsetReaderRead().

◆ SCIPsetReaderWrite()

SCIP_RETCODE SCIPsetReaderWrite ( SCIP * scip,
SCIP_READER * reader )

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
scipSCIP data structure
readerreader write method of reader

Definition at line 219 of file scip_reader.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_READERWRITE, SCIP_OKAY, SCIPcheckStage, SCIPreaderSetWrite(), SCIPsetReaderWrite(), and TRUE.

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCsol(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderWbo(), and SCIPsetReaderWrite().

◆ SCIPfindReader()

SCIP_READER * SCIPfindReader ( SCIP * scip,
const char * name )

returns the reader of the given name, or NULL if not existing

Parameters
scipSCIP data structure
namename of reader

Definition at line 235 of file scip_reader.c.

References assert(), NULL, SCIPfindReader(), and SCIPsetFindReader().

Referenced by SCIP_DECL_READERREAD(), SCIP_DECL_READERREAD(), SCIPfindObjReader(), SCIPfindReader(), SCIPfreeReaderdataCor(), SCIPfreeReaderdataSto(), SCIPfreeReaderdataTim(), SCIPincludeReader(), SCIPincludeReaderBasic(), SCIPincludeReaderWbo(), 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
scipSCIP data structure

Definition at line 248 of file scip_reader.c.

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

Referenced by displayReaders(), SCIPgetReaders(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPgetNReaders()

int SCIPgetNReaders ( SCIP * scip)

returns the number of currently available readers

Parameters
scipSCIP data structure

Definition at line 259 of file scip_reader.c.

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

Referenced by displayReaders(), SCIPgetNReaders(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().