Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods for the inclusion and access to reader plugins of SCIP

Functions

SCIP_READERDATASCIPreaderGetData (SCIP_READER *reader)
 
void SCIPreaderSetData (SCIP_READER *reader, SCIP_READERDATA *readerdata)
 
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_DECL_READERCOPY((*readercopy)))
 
SCIP_RETCODE SCIPsetReaderFree (SCIP *scip, SCIP_READER *reader, SCIP_DECL_READERFREE((*readerfree)))
 
SCIP_RETCODE SCIPsetReaderRead (SCIP *scip, SCIP_READER *reader, SCIP_DECL_READERREAD((*readerread)))
 
SCIP_RETCODE SCIPsetReaderWrite (SCIP *scip, SCIP_READER *reader, SCIP_DECL_READERWRITE((*readerwrite)))
 
SCIP_READERSCIPfindReader (SCIP *scip, const char *name)
 
SCIP_READER ** SCIPgetReaders (SCIP *scip)
 
int SCIPgetNReaders (SCIP *scip)
 

Function Documentation

◆ SCIPreaderGetData()

SCIP_READERDATA* SCIPreaderGetData ( SCIP_READER reader)

◆ 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 460 of file reader.c.

References NULL, and SCIP_Reader::readerdata.

Referenced by SCIP_DECL_READERFREE().

◆ SCIPreaderGetName()

◆ SCIPreaderGetDesc()

const char* SCIPreaderGetDesc ( SCIP_READER reader)

gets description of reader

Parameters
readerreader

Definition at line 525 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
readerreader

Definition at line 535 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
readerreader

Definition at line 545 of file reader.c.

References NULL.

Referenced by displayReaders().

◆ SCIPreaderCanWrite()

SCIP_Bool SCIPreaderCanWrite ( SCIP_READER reader)

return whether the reader can write files

Parameters
readerreader

Definition at line 555 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
scipSCIP data structure
namename of reader
descdescription of reader
extensionfile extension that reader processes
readerdatareader data

Definition at line 5159 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPerrorMessage, SCIPfindReader(), SCIPreaderCreate(), SCIPsetIncludeReader(), Scip::set, and TRUE.

Referenced by SCIPincludeObjReader(), and SCIPincludeReaderPbm().

◆ 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 5201 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPerrorMessage, SCIPfindReader(), SCIPreaderCreate(), SCIPsetIncludeReader(), Scip::set, and TRUE.

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderBpa(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCnf(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderSol(), 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
scipSCIP data structure
readerreader

Definition at line 5239 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPreaderSetCopy(), and TRUE.

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCcg(), SCIPincludeReaderCip(), SCIPincludeReaderCnf(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderSol(), 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
scipSCIP data structure
readerreader

Definition at line 5263 of file scip.c.

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

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderCip(), SCIPincludeReaderDiff(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), and SCIPincludeReaderPpm().

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

Definition at line 5287 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPreaderSetRead(), and TRUE.

Referenced by SCIPincludeReaderBnd(), SCIPincludeReaderBpa(), SCIPincludeReaderCip(), SCIPincludeReaderCnf(), SCIPincludeReaderDiff(), SCIPincludeReaderFix(), SCIPincludeReaderFzn(), SCIPincludeReaderGms(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderRlp(), SCIPincludeReaderSol(), 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
scipSCIP data structure
readerreader

Definition at line 5311 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPreaderSetWrite(), and TRUE.

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

◆ 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 5327 of file scip.c.

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

Referenced by SCIPfindObjReader(), SCIPincludeReader(), SCIPincludeReaderBasic(), SCIPprintSolReaderFzn(), and SCIPwriteLp().

◆ SCIPgetReaders()

SCIP_READER** SCIPgetReaders ( SCIP scip)

returns the array of currently available readers

Parameters
scipSCIP data structure

Definition at line 5340 of file scip.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
scipSCIP data structure

Definition at line 5351 of file scip.c.

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

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