External Codes

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

scip	SCIP data structure
name	name of external code
description	description of external code, or NULL

Definition at line 749 of file scip_general.c.

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

Referenced by includeConshdlrCountsols(), SCIPincludeDefaultPlugins(), SCIPincludePresolSymmetry(), and SCIPincludeReaderZpl().

SCIPgetExternalCodeNames()

char** SCIPgetExternalCodeNames

(

SCIP *

scip

)

returns an array of names of currently included external codes

Parameters

scip	SCIP data structure

Definition at line 766 of file scip_general.c.

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

SCIPgetExternalCodeDescriptions()

char** SCIPgetExternalCodeDescriptions

(

SCIP *

scip

)

returns an array of the descriptions of currently included external codes

Note

some descriptions may be NULL

Parameters

scip	SCIP data structure

Definition at line 780 of file scip_general.c.

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

SCIPgetNExternalCodes()

int SCIPgetNExternalCodes

(

SCIP *

scip

)

returns the number of currently included information on external codes

Parameters

scip	SCIP data structure

Definition at line 791 of file scip_general.c.

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

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

Parameters

scip	SCIP data structure
file	output file (or NULL for standard output)

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