Scippy

SCIP

Solving Constraint Integer Programs

Functions
Reader
Public API of SCIP » Core API » Methods for managing plugins

Detailed Description

methods for the inclusion and access to reader plugins of SCIP

Functions

SCIP_EXPORT SCIP_READERDATA * SCIPreaderGetData (SCIP_READER *reader)
 
SCIP_EXPORT void SCIPreaderSetData (SCIP_READER *reader, SCIP_READERDATA *readerdata)
 
SCIP_EXPORT const char * SCIPreaderGetName (SCIP_READER *reader)
 
SCIP_EXPORT const char * SCIPreaderGetDesc (SCIP_READER *reader)
 
SCIP_EXPORT const char * SCIPreaderGetExtension (SCIP_READER *reader)
 
SCIP_EXPORT SCIP_Bool SCIPreaderCanRead (SCIP_READER *reader)
 
SCIP_EXPORT SCIP_Bool SCIPreaderCanWrite (SCIP_READER *reader)
 
SCIP_EXPORT 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_EXPORT SCIP_RETCODE SCIPincludeReaderBasic (SCIP *scip, SCIP_READER **readerptr, const char *name, const char *desc, const char *extension, SCIP_READERDATA *readerdata)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetReaderCopy (SCIP *scip, SCIP_READER *reader, SCIP_DECL_READERCOPY((*readercopy)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetReaderFree (SCIP *scip, SCIP_READER *reader, SCIP_DECL_READERFREE((*readerfree)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetReaderRead (SCIP *scip, SCIP_READER *reader, SCIP_DECL_READERREAD((*readerread)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetReaderWrite (SCIP *scip, SCIP_READER *reader, SCIP_DECL_READERWRITE((*readerwrite)))
 
SCIP_EXPORT SCIP_READER * SCIPfindReader (SCIP *scip, const char *name)
 
SCIP_EXPORT SCIP_READER ** SCIPgetReaders (SCIP *scip)
 
SCIP_EXPORT int SCIPgetNReaders (SCIP *scip)
 

Function Documentation

◆ SCIPreaderGetData()

SCIP_EXPORT SCIP_READERDATA* SCIPreaderGetData ( SCIP_READER *  reader)

gets user data of reader

Parameters
readerreader

Definition at line 482 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()

SCIP_EXPORT 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 492 of file reader.c.

References NULL, and SCIP_Reader::readerdata.

Referenced by SCIP_DECL_READERFREE().

◆ SCIPreaderGetName()

SCIP_EXPORT const char* SCIPreaderGetName ( SCIP_READER *  reader)

gets name of reader

Parameters
readerreader

Definition at line 547 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(), SCIPsetSetPresolving(), SCIPstoGetNScenarios(), SCIPtimConsGetStageName(), SCIPtimFindStage(), SCIPtimGetNStages(), SCIPtimGetStageConss(), SCIPtimGetStageName(), SCIPtimGetStageNConss(), SCIPtimGetStageNVars(), SCIPtimGetStageVars(), SCIPtimHasRead(), and SCIPwriteMps().

◆ SCIPreaderGetDesc()

SCIP_EXPORT const char* SCIPreaderGetDesc ( SCIP_READER *  reader)

gets description of reader

Parameters
readerreader

Definition at line 557 of file reader.c.

References SCIP_Reader::desc, and NULL.

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

◆ SCIPreaderGetExtension()

SCIP_EXPORT const char* SCIPreaderGetExtension ( SCIP_READER *  reader)

gets file extension of reader

Parameters
readerreader

Definition at line 567 of file reader.c.

References SCIP_Reader::extension, and NULL.

Referenced by displayReaders().

◆ SCIPreaderCanRead()

SCIP_EXPORT SCIP_Bool SCIPreaderCanRead ( SCIP_READER *  reader)

return whether the reader can read files

Parameters
readerreader

Definition at line 577 of file reader.c.

References NULL.

Referenced by displayReaders().

◆ SCIPreaderCanWrite()

SCIP_EXPORT SCIP_Bool SCIPreaderCanWrite ( SCIP_READER *  reader)

return whether the reader can write files

Parameters
readerreader

Definition at line 587 of file reader.c.

References NULL.

Referenced by displayReaders().

◆ SCIPincludeReader()

SCIP_EXPORT 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
readerdatareader data

Definition at line 56 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_EXPORT 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 99 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(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderGr(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderStp(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), and SCIPincludeReaderZpl().

◆ SCIPsetReaderCopy()

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

Definition at line 137 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(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderGr(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderStp(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), and SCIPincludeReaderZpl().

◆ SCIPsetReaderFree()

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

Definition at line 161 of file scip_reader.c.

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

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

◆ SCIPsetReaderRead()

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

Definition at line 185 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(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderGr(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderRlp(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), SCIPincludeReaderStp(), SCIPincludeReaderTim(), SCIPincludeReaderWbo(), and SCIPincludeReaderZpl().

◆ SCIPsetReaderWrite()

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

Definition at line 209 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_EXPORT 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 225 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_EXPORT SCIP_READER** SCIPgetReaders ( SCIP *  scip)

returns the array of currently available readers

Parameters
scipSCIP data structure

Definition at line 238 of file scip_reader.c.

References NULL, SCIP_Set::readers, and Scip::set.

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

◆ SCIPgetNReaders()

SCIP_EXPORT int SCIPgetNReaders ( SCIP *  scip)

returns the number of currently available readers

Parameters
scipSCIP data structure

Definition at line 249 of file scip_reader.c.

References SCIP_Set::nreaders, NULL, and Scip::set.

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