reader_tim.h File Reference

Detailed Description

TIM file reader - the stage information for a stochastic programming instance in SMPS format.

Author

Stephen J. Maher

This is a reader for the time file of a stochastic programming instance in SMPS format. The three files that must be read are:

• .cor
• .tim
• .sto

Alternatively, it is possible to create a .smps file with the relative path to the .cor, .tim and .sto files. A file reader is available for the .smps file.

Details regarding the SMPS file format can be found at: Birge, J. R.; Dempster, M. A.; Gassmann, H. I.; Gunn, E.; King, A. J. & Wallace, S. W. A standard input format for multiperiod stochastic linear programs IIASA, Laxenburg, Austria, WP-87-118, 1987

Definition in file reader_tim.h.

#include "scip/def.h"
#include "scip/type_cons.h"
#include "scip/type_reader.h"
#include "scip/type_result.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"
#include "scip/type_var.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPincludeReaderTim (SCIP *scip)
SCIP_RETCODE	SCIPreadTim (SCIP *scip, const char *filename, SCIP_RESULT *result)
SCIP_RETCODE	SCIPfreeReaderdataTim (SCIP *scip)
SCIP_Bool	SCIPtimHasRead (SCIP_READER *reader)
int	SCIPtimGetNStages (SCIP *scip)
const char *	SCIPtimGetStageName (SCIP *scip, int stagenum)
const char *	SCIPtimConsGetStageName (SCIP *scip, const char *consname)
int	SCIPtimFindStage (SCIP *scip, const char *stage)
SCIP_VAR **	SCIPtimGetStageVars (SCIP *scip, int stagenum)
SCIP_CONS **	SCIPtimGetStageConss (SCIP *scip, int stagenum)
int	SCIPtimGetStageNVars (SCIP *scip, int stagenum)
int	SCIPtimGetStageNConss (SCIP *scip, int stagenum)

Function Documentation

SCIPfreeReaderdataTim()

SCIP_RETCODE SCIPfreeReaderdataTim

(

SCIP *

scip

)

frees the reader data for the tim file

Parameters

scip	the SCIP data structure

Definition at line 932 of file reader_tim.c.

References freeReaderdata(), NULL, READER_NAME, SCIP_OKAY, SCIPfindReader(), and SCIPreaderGetData().

Referenced by SCIP_DECL_READERREAD(), and SCIPreadCor().

SCIPtimHasRead()

SCIP_Bool SCIPtimHasRead

(

SCIP_READER *

reader

)

Parameters

reader

the file reader itself

Definition at line 958 of file reader_tim.c.

References NULL, READER_NAME, SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by SCIP_DECL_READERREAD().

SCIPtimGetNStages()

int SCIPtimGetNStages

(

SCIP *

scip

)

Parameters

scip	SCIP data structure

Definition at line 975 of file reader_tim.c.

References NULL, READER_NAME, SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by addScenariosToReaderdata(), addScenarioVarsAndConsToProb(), readSto(), removeCoreVariablesAndConstraints(), and SCIP_DECL_READERREAD().

SCIPtimGetStageName()

const char * SCIPtimGetStageName	(	SCIP *	scip,
		int	stagenum
	)

Parameters

scip	SCIP data structure
stagenum	the number of the requested stage

Definition at line 994 of file reader_tim.c.

References TimInput::nstages, NULL, READER_NAME, SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by buildScenarioTree(), and createReaderdata().

SCIPtimConsGetStageName()

const char * SCIPtimConsGetStageName	(	SCIP *	scip,
		const char *	consname
	)

Parameters

scip	SCIP data structure
consname	the constraint to search for

Definition at line 1015 of file reader_tim.c.

References TimInput::nstages, NULL, READER_NAME, SCIPconsGetName(), SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by readIndep().

SCIPtimFindStage()

int SCIPtimFindStage	(	SCIP *	scip,
		const char *	stage
	)

Parameters

scip	SCIP data structure
stage	the name of the requested stage

Definition at line 1056 of file reader_tim.c.

References NULL, READER_NAME, SCIPABORT, SCIPerrorMessage, SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by addScenarioVarsAndConsToProb(), and readScenarios().

SCIPtimGetStageVars()

SCIP_VAR ** SCIPtimGetStageVars	(	SCIP *	scip,
		int	stagenum
	)

Parameters

scip	SCIP data structure
stagenum	the number of the requested stage

Definition at line 1094 of file reader_tim.c.

References TimInput::nstages, NULL, READER_NAME, SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().

SCIPtimGetStageConss()

SCIP_CONS ** SCIPtimGetStageConss	(	SCIP *	scip,
		int	stagenum
	)

Parameters

scip	SCIP data structure
stagenum	the number of the requested stage

Definition at line 1115 of file reader_tim.c.

References TimInput::nstages, NULL, READER_NAME, SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().

SCIPtimGetStageNVars()

int SCIPtimGetStageNVars	(	SCIP *	scip,
		int	stagenum
	)

Parameters

scip	SCIP data structure
stagenum	the number of the requested stage

Definition at line 1136 of file reader_tim.c.

References TimInput::nstages, NULL, READER_NAME, SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().

SCIPtimGetStageNConss()

int SCIPtimGetStageNConss	(	SCIP *	scip,
		int	stagenum
	)

Parameters

scip	SCIP data structure
stagenum	the number of the requested stage

Definition at line 1157 of file reader_tim.c.

References TimInput::nstages, NULL, READER_NAME, SCIPfindReader(), SCIPreaderGetData(), and SCIPreaderGetName().

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().