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_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_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_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 605 of file reader.c.

    References NULL, and SCIP_Reader::readerdata.

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

    Definition at line 615 of file reader.c.

    References NULL, and SCIP_Reader::readerdata.

    Referenced by SCIP_DECL_READERFREE().

    ◆ SCIPreaderMarkExact()

    void SCIPreaderMarkExact ( SCIP_READER *  reader)

    marks the reader as safe to use in exact solving mode

    Parameters
    readerreader

    Definition at line 670 of file reader.c.

    References SCIP_Reader::exact, NULL, and TRUE.

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

    ◆ SCIPreaderGetName()

    const char * SCIPreaderGetName ( SCIP_READER *  reader)

    gets name of reader

    Parameters
    readerreader

    Definition at line 680 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(), 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 690 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 700 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 710 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 720 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 66 of file scip_reader.c.

    References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPfindReader(), SCIPreaderCreate(), SCIPsetIncludeReader(), 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
    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(), SCIPreaderCreate(), SCIPsetIncludeReader(), and TRUE.

    Referenced by 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,
    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 147 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(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderPpm(), SCIPincludeReaderRlp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), 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
    scipSCIP data structure
    readerreader

    Definition at line 171 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(), SCIPincludeReaderOpb(), 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
    scipSCIP data structure
    readerreader

    Definition at line 195 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(), SCIPincludeReaderLOP(), SCIPincludeReaderLp(), SCIPincludeReaderMps(), SCIPincludeReaderMst(), SCIPincludeReaderNl(), SCIPincludeReaderOpb(), SCIPincludeReaderOsil(), SCIPincludeReaderPip(), SCIPincludeReaderRlp(), SCIPincludeReaderRpa(), SCIPincludeReaderScflp(), SCIPincludeReaderSch(), SCIPincludeReaderSm(), SCIPincludeReaderSmps(), SCIPincludeReaderSol(), SCIPincludeReaderSto(), 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
    scipSCIP data structure
    readerreader

    Definition at line 219 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(), SCIPincludeReaderNl(), 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 235 of file scip_reader.c.

    References NULL, and SCIPsetFindReader().

    Referenced by SCIP_DECL_READERREAD(), SCIPfindObjReader(), 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 NULL.

    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 259 of file scip_reader.c.

    References NULL.

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