Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods to access information about external codes used by SCIP

Functions

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

Function Documentation

◆ SCIPincludeExternalCodeInformation()

SCIP_EXPORT 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 697 of file scip_general.c.

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

Referenced by includeConshdlrCountsols(), SCIPincludeDefaultPlugins(), SCIPincludePresolMILP(), SCIPincludePropSymmetry(), and SCIPincludeReaderZpl().

◆ SCIPgetExternalCodeNames()

SCIP_EXPORT char** SCIPgetExternalCodeNames ( SCIP scip)

returns an array of names of currently included external codes

Parameters
scipSCIP data structure

Definition at line 714 of file scip_general.c.

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

◆ SCIPgetExternalCodeDescriptions()

SCIP_EXPORT 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 728 of file scip_general.c.

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

◆ SCIPgetNExternalCodes()

SCIP_EXPORT int SCIPgetNExternalCodes ( SCIP scip)

returns the number of currently included information on external codes

Parameters
scipSCIP data structure

Definition at line 739 of file scip_general.c.

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

◆ SCIPprintExternalCodes()

SCIP_EXPORT 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
Parameters
scipSCIP data structure
fileoutput file (or NULL for standard output)

Definition at line 753 of file scip_general.c.

References SCIP_Set::extcodedescs, SCIP_Set::extcodenames, Scip::messagehdlr, SCIP_Set::nextcodes, NULL, SCIPinfoMessage(), SCIPmessageFPrintInfo(), and Scip::set.

Referenced by processArguments(), and SCIPprocessShellArguments().