Detailed Description

interface for input file readers

Author: Tobias Achterberg

Definition in file reader.c.

#include <assert.h>
#include <string.h>
#include <math.h>
#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/set.h"
#include "scip/clock.h"
#include "scip/pub_misc.h"
#include "scip/reader.h"
#include "scip/prob.h"
#include "scip/pub_var.h"
#include "scip/var.h"
#include "scip/pub_cons.h"
#include "scip/cons.h"
#include "scip/struct_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, 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)

static SCIP_Bool	readerIsApplicable (SCIP_READER reader, const char extension)

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

static void	resetVarname (SCIP_VAR var, const char name)

SCIP_RETCODE	SCIPreaderWrite (SCIP_READER reader, SCIP_PROB prob, SCIP_SET set, FILE file, const char extension, SCIP_Bool genericnames, SCIP_RESULT result)

SCIP_READERDATA *	SCIPreaderGetData (SCIP_READER *reader)

void	SCIPreaderSetData (SCIP_READER reader, SCIP_READERDATA readerdata)

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)))

const char *	SCIPreaderGetName (SCIP_READER *reader)

const char *	SCIPreaderGetDesc (SCIP_READER *reader)

const char *	SCIPreaderGetExtension (SCIP_READER *reader)

SCIP_Bool	SCIPreaderCanRead (SCIP_READER *reader)

SCIP_Bool	SCIPreaderCanWrite (SCIP_READER *reader)

SCIP_Real	SCIPreaderGetReadingTime (SCIP_READER *reader)

void	SCIPreaderEnableOrDisableClocks (SCIP_READER *reader, SCIP_Bool enable)

SCIP_RETCODE	SCIPreaderResetReadingTime (SCIP_READER *reader)

Function Documentation

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

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

Referenced by SCIPsetEnableOrDisablePluginClocks().

SCIP_RETCODE SCIPreaderCreate	(	SCIP_READER **	reader,
		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
name	name of reader
desc	description of reader
extension	file extension that reader processes
readerdata	reader data

Definition at line 61 of file reader.c.

References BMSallocMemory, BMSduplicateMemoryArray, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_CLOCKTYPE_DEFAULT, SCIP_OKAY, and SCIPclockCreate().

Referenced by SCIPincludeReader(), and SCIPincludeReaderBasic().

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

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

static SCIP_Bool readerIsApplicable	(	SCIP_READER *	reader,
		const char *	extension
	)

static

returns TRUE, if reader is responsible for files with the given extension

Parameters

reader	reader
extension	extension of the input file name

Definition at line 123 of file reader.c.

References SCIP_Reader::extension, and NULL.

Referenced by SCIPreaderRead(), and SCIPreaderWrite().

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

References 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(), and SCIPclockStop().

Referenced by SCIPreadProb().

static void resetVarname	(	SCIP_VAR *	var,
		const char *	name
	)

static

Parameters

var	variable
name	variable name

Definition at line 202 of file reader.c.

References BMSfreeMemory, NULL, SCIPvarGetName(), and SCIPvarSetNamePointer().

Referenced by SCIPreaderWrite().

SCIP_RETCODE SCIPreaderWrite	(	SCIP_READER *	reader,
		SCIP_PROB *	prob,
		SCIP_SET *	set,
		FILE *	file,
		const char *	extension,
		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
file	output file (or NULL for standard output)
extension	file format
genericnames	using generic variable and constraint names?
result	pointer to store the result of the callback method