Scippy

    SCIP

    Solving Constraint Integer Programs

    Functions
    External Codes
    Public API of SCIP » Core API » Methods for managing plugins

    Detailed Description

    methods to access information about external codes used by SCIP

    Functions

    SCIP_RETCODE SCIPincludeExternalCodeInformation (SCIP *scip, const char *name, const char *description)
     
    char ** SCIPgetExternalCodeNames (SCIP *scip)
     
    char ** SCIPgetExternalCodeDescriptions (SCIP *scip)
     
    int SCIPgetNExternalCodes (SCIP *scip)
     
    void SCIPprintExternalCodes (SCIP *scip, FILE *file)
     

    Function Documentation

    ◆ SCIPincludeExternalCodeInformation()

    SCIP_RETCODE SCIPincludeExternalCodeInformation ( SCIP *  scip,
    const char *  name,
    const char *  description 
    )

    includes information about an external code linked into the SCIP library

    Parameters
    scipSCIP data structure
    namename of external code
    descriptiondescription of external code, or NULL

    Definition at line 769 of file scip_general.c.

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

    Referenced by includeConshdlrCountsols(), SCIPincludeNlpSolverConopt(), SCIPincludeNlpSolverFilterSQP(), SCIPincludeNlpSolverIpopt(), SCIPincludeNlpSolverWorhp(), SCIPincludePropSymmetry(), SCIPincludeReaderNl(), and SCIPincludeReaderZpl().

    ◆ SCIPgetExternalCodeNames()

    char ** SCIPgetExternalCodeNames ( SCIP *  scip)

    returns an array of names of currently included external codes

    Parameters
    scipSCIP data structure

    Definition at line 786 of file scip_general.c.

    References NULL.

    ◆ SCIPgetExternalCodeDescriptions()

    char ** SCIPgetExternalCodeDescriptions ( SCIP *  scip)

    returns an array of the descriptions of currently included external codes

    Note
    some descriptions may be NULL
    Parameters
    scipSCIP data structure

    Definition at line 800 of file scip_general.c.

    References NULL.

    ◆ SCIPgetNExternalCodes()

    int SCIPgetNExternalCodes ( SCIP *  scip)

    returns the number of currently included information on external codes

    Parameters
    scipSCIP data structure

    Definition at line 811 of file scip_general.c.

    References NULL.

    ◆ SCIPprintExternalCodes()

    void SCIPprintExternalCodes ( SCIP *  scip,
    FILE *  file 
    )

    prints information on external codes to a file stream via the message handler system

    Note
    If the message handler is set to a NULL pointer nothing will be printed

    prints information on external libraries to a file stream via the message handler system

    Note
    If the message handler is set to a NULL pointer nothing will be printed
    Parameters
    scipSCIP data structure
    fileoutput file (or NULL for standard output)

    Definition at line 825 of file scip_general.c.

    References NULL, SCIPinfoMessage(), and SCIPmessageFPrintInfo().

    Referenced by fromAmpl(), processArguments(), processShellArguments(), and SCIPprocessShellArguments().