Detailed Description

internal methods for input file readers

Author: Tobias Achterberg

Definition in file reader.h.

#include "scip/def.h"
#include "scip/type_prob.h"
#include "scip/type_retcode.h"
#include "scip/type_result.h"
#include "scip/type_set.h"
#include "scip/type_reader.h"
#include "scip/pub_reader.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPreaderCopyInclude (SCIP_READER reader, SCIP_SET set)
SCIP_RETCODE	SCIPreaderCreate (SCIP_READER *reader, SCIP_SET set, 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	SCIPreaderFree (SCIP_READER *reader, SCIP_SET set)
SCIP_RETCODE	SCIPreaderRead (SCIP_READER reader, SCIP_SET set, const char filename, const char extension, SCIP_RESULT *result)
SCIP_RETCODE	SCIPreaderWrite (SCIP_READER reader, SCIP_PROB prob, SCIP_SET set, SCIP_MESSAGEHDLR msghdlr, FILE file, const char filename, const char format, SCIP_Bool genericnames, SCIP_RESULT result)
SCIP_Real	SCIPreaderGetReadingTime (SCIP_READER *reader)
void	SCIPreaderEnableOrDisableClocks (SCIP_READER *reader, SCIP_Bool enable)
SCIP_RETCODE	SCIPreaderResetReadingTime (SCIP_READER *reader)
void	SCIPreaderSetCopy (SCIP_READER *reader,)
void	SCIPreaderSetFree (SCIP_READER *reader,)
void	SCIPreaderSetRead (SCIP_READER *reader,)
void	SCIPreaderSetWrite (SCIP_READER *reader,)

Function Documentation

◆ SCIPreaderCopyInclude()

SCIP_RETCODE SCIPreaderCopyInclude	(	SCIP_READER *	reader,
		SCIP_SET *	set )

copies the given reader to a new scip

Parameters

reader	reader
set	SCIP_SET of SCIP to copy to

Definition at line 58 of file reader.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPreaderCopyInclude(), SCIPreaderGetName(), and SCIPsetDebugMsg.

Referenced by SCIPreaderCopyInclude(), and SCIPsetCopyPlugins().

◆ SCIPreaderCreate()

SCIP_RETCODE SCIPreaderCreate	(	SCIP_READER **	reader,
		SCIP_SET *	set,
		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

Parameters

reader	pointer to store reader
set	global SCIP settings
name	name of reader
desc	description of reader
extension	file extension that reader processes
-	copy method of reader or NULL if you don't want to copy your plugin into sub-SCIPs
-	destructor of reader
-	read method
-	write method
readerdata	reader data

Definition at line 114 of file reader.c.

References assert(), doReaderCreate(), NULL, SCIP_CALL_FINALLY, SCIP_DECL_READERCOPY, SCIP_DECL_READERFREE, SCIP_DECL_READERREAD, SCIP_DECL_READERWRITE, SCIP_OKAY, SCIPreaderCreate(), and SCIPreaderFree().

Referenced by SCIPincludeReader(), SCIPincludeReaderBasic(), and SCIPreaderCreate().

◆ SCIPreaderFree()

SCIP_RETCODE SCIPreaderFree	(	SCIP_READER **	reader,
		SCIP_SET *	set )

frees memory of reader

Parameters

reader	pointer to reader data structure
set	global SCIP settings

Definition at line 140 of file reader.c.

References assert(), BMSfreeMemory, BMSfreeMemoryArrayNull, NULL, SCIP_CALL, SCIP_OKAY, SCIPclockFree(), and SCIPreaderFree().

Referenced by SCIPreaderCreate(), and SCIPreaderFree().

◆ SCIPreaderRead()

SCIP_RETCODE SCIPreaderRead	(	SCIP_READER *	reader,
		SCIP_SET *	set,
		const char *	filename,
		const char *	extension,
		SCIP_RESULT *	result )

reads problem data from file with given reader or returns SCIP_DIDNOTRUN

Note: we need temporary clock to measure the reading time correctly since in case of creating a new problem within the reader all clocks are reset (including the reader clocks); this resetting is necessary for example for those case we people solve several problems using the (same) interactive shell

Parameters

reader	reader
set	global SCIP settings
filename	name of the input file
extension	extension of the input file name
result	pointer to store the result of the callback method

Definition at line 184 of file reader.c.

References assert(), SCIP_Reader::exact, NULL, readerIsApplicable(), SCIP_Reader::readingtime, result, SCIP_CALL, SCIP_CLOCKTYPE_DEFAULT, SCIP_DIDNOTRUN, SCIP_NOFILE, SCIP_OKAY, SCIP_READERROR, SCIP_SUCCESS, SCIPclockCreate(), SCIPclockFree(), SCIPclockGetTime(), SCIPclockIsRunning(), SCIPclockSetTime(), SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPreaderGetName(), and SCIPreaderRead().

Referenced by SCIPreaderRead(), and SCIPreadProb().

◆ SCIPreaderWrite()

SCIP_RETCODE SCIPreaderWrite	(	SCIP_READER *	reader,
		SCIP_PROB *	prob,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	msghdlr,
		FILE *	file,
		const char *	filename,
		const char *	format,
		SCIP_Bool	genericnames,
		SCIP_RESULT *	result )

writes problem data to file with given reader or returns SCIP_DIDNOTRUN

Parameters

reader	reader
prob	problem data
set	global SCIP settings
msghdlr	message handler
file	output file (or NULL for standard output)
filename	name of output file, or NULL if not available
format	file format
genericnames	using generic variable and constraint names?
result	pointer to store the result of the callback method