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, SCIP_DECL_READERCOPY((readercopy)))

void	SCIPreaderSetFree (SCIP_READER reader, SCIP_DECL_READERFREE((readerfree)))

void	SCIPreaderSetRead (SCIP_READER reader, SCIP_DECL_READERREAD((readerread)))

void	SCIPreaderSetWrite (SCIP_READER reader, SCIP_DECL_READERWRITE((readerwrite)))

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

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

Referenced by 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
readerdata	reader data

Definition at line 113 of file reader.c.

References doReaderCreate(), NULL, SCIP_CALL_FINALLY, SCIP_OKAY, and SCIPreaderFree().

Referenced by SCIPincludeReader(), and SCIPincludeReaderBasic().

◆ 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 139 of file reader.c.

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

Referenced by SCIPreaderCreate().

◆ 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 183 of file reader.c.

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

Referenced by 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

Definition at line 277 of file reader.c.

References SCIP_Reader::exact, NULL, readerIsApplicable(), resetVarname(), SCIP_CALL, SCIP_DIDNOTRUN, SCIP_OBJSENSE_MAXIMIZE, SCIP_OKAY, SCIP_READERROR, SCIP_Real, SCIP_WRITEERROR, SCIPbuffer(), SCIPconsGetName(), SCIPconshdlrGetConss(), SCIPconshdlrGetEnfoConss(), SCIPconshdlrGetName(), SCIPconshdlrGetNConss(), SCIPconshdlrGetNEnfoConss(), SCIPconsSetNamePointer(), SCIPerrorMessage, SCIPmessageFPrintWarning(), SCIPprobFindCons(), SCIPprobFindVar(), SCIPprobGetConss(), SCIPprobGetData(), SCIPprobGetFixedVars(), SCIPprobGetMaxNConss(), SCIPprobGetName(), SCIPprobGetNBinVars(), SCIPprobGetNConss(), SCIPprobGetNContVars(), SCIPprobGetNFixedVars(), SCIPprobGetNImplVars(), SCIPprobGetNIntVars(), SCIPprobGetNVars(), SCIPprobGetObjoffset(), SCIPprobGetObjoffsetExact(), SCIPprobGetObjscale(), SCIPprobGetObjscaleExact(), SCIPprobGetObjsense(), SCIPprobGetStartNConss(), SCIPprobGetStartNVars(), SCIPprobGetVars(), SCIPprobIsTransformed(), SCIPrationalCreateBuffer(), SCIPrationalFreeBuffer(), SCIPrationalMultReal(), SCIPrationalSetRational(), SCIPreaderGetName(), SCIPsetAllocBufferArray, SCIPsetDebugMsg, SCIPsetFreeBufferArray, SCIPsnprintf(), SCIPvarGetName(), and SCIPvarSetNamePointer().

Referenced by printProblem().

◆ SCIPreaderGetReadingTime()

SCIP_Real SCIPreaderGetReadingTime ( SCIP_READER * reader )

gets time in seconds used in this reader for reading

Parameters

reader reader

Definition at line 730 of file reader.c.

References NULL, SCIP_Reader::readingtime, and SCIPclockGetTime().

Referenced by SCIPgetReadingTime().

◆ SCIPreaderEnableOrDisableClocks()

void SCIPreaderEnableOrDisableClocks	(	SCIP_READER *	reader,
		SCIP_Bool	enable
	)

enables or disables all clocks of reader, depending on the value of the flag

Parameters

reader	the reader for which all clocks should be enabled or disabled
enable	should the clocks be enabled?

Definition at line 740 of file reader.c.

References NULL, SCIP_Reader::readingtime, and SCIPclockEnableOrDisable().

◆ SCIPreaderResetReadingTime()

SCIP_RETCODE SCIPreaderResetReadingTime ( SCIP_READER * reader )

resets reading time of reader

Parameters

reader reader

Definition at line 751 of file reader.c.

References NULL, SCIP_Reader::readingtime, SCIP_OKAY, and SCIPclockReset().

Referenced by SCIPfreeProb().

◆ SCIPreaderSetCopy()

void SCIPreaderSetCopy	(	SCIP_READER *	reader,
		SCIP_DECL_READERCOPY((*readercopy))
	)

sets copy method of reader

Parameters

reader reader

Definition at line 626 of file reader.c.

References NULL.

Referenced by SCIPsetReaderCopy().

◆ SCIPreaderSetFree()

void SCIPreaderSetFree	(	SCIP_READER *	reader,
		SCIP_DECL_READERFREE((*readerfree))
	)

sets destructor of reader

Parameters

reader reader

Definition at line 637 of file reader.c.

References NULL.

Referenced by SCIPsetReaderFree().

◆ SCIPreaderSetRead()

void SCIPreaderSetRead	(	SCIP_READER *	reader,
		SCIP_DECL_READERREAD((*readerread))
	)

sets read method of reader

Parameters

reader reader

Definition at line 648 of file reader.c.

References NULL.

Referenced by SCIPsetReaderRead().

◆ SCIPreaderSetWrite()

void SCIPreaderSetWrite	(	SCIP_READER *	reader,
		SCIP_DECL_READERWRITE((*readerwrite))
	)

sets write method of reader

Parameters

reader reader

Definition at line 659 of file reader.c.

References NULL.

Referenced by SCIPsetReaderWrite().

SCIP

Detailed Description

Functions

Function Documentation

◆ SCIPreaderCopyInclude()

◆ SCIPreaderCreate()

◆ SCIPreaderFree()

◆ SCIPreaderRead()

◆ SCIPreaderWrite()

◆ SCIPreaderGetReadingTime()

◆ SCIPreaderEnableOrDisableClocks()

◆ SCIPreaderResetReadingTime()

◆ SCIPreaderSetCopy()

◆ SCIPreaderSetFree()

◆ SCIPreaderSetRead()

◆ SCIPreaderSetWrite()