Scippy

SCIP

Solving Constraint Integer Programs

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_EXPORT SCIP_RETCODE SCIPincludeReaderTim (SCIP *scip)
 
SCIP_EXPORT SCIP_RETCODE SCIPreadTim (SCIP *scip, const char *filename, SCIP_RESULT *result)
 
SCIP_EXPORT SCIP_Bool SCIPtimHasRead (SCIP_READER *reader)
 
SCIP_EXPORT int SCIPtimGetNStages (SCIP *scip)
 
SCIP_EXPORT const char * SCIPtimGetStageName (SCIP *scip, int stagenum)
 
const char * SCIPtimConsGetStageName (SCIP *scip, const char *consname)
 
SCIP_EXPORT int SCIPtimFindStage (SCIP *scip, const char *stage)
 
SCIP_EXPORT SCIP_VAR ** SCIPtimGetStageVars (SCIP *scip, int stagenum)
 
SCIP_EXPORT SCIP_CONS ** SCIPtimGetStageConss (SCIP *scip, int stagenum)
 
SCIP_EXPORT int SCIPtimGetStageNVars (SCIP *scip, int stagenum)
 
SCIP_EXPORT int SCIPtimGetStageNConss (SCIP *scip, int stagenum)
 

Function Documentation

◆ SCIPtimHasRead()

SCIP_EXPORT SCIP_Bool SCIPtimHasRead ( SCIP_READER reader)
Parameters
readerthe file reader itself

Definition at line 908 of file reader_tim.c.

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

Referenced by SCIP_DECL_READERREAD().

◆ SCIPtimGetNStages()

SCIP_EXPORT int SCIPtimGetNStages ( SCIP scip)

◆ SCIPtimGetStageName()

SCIP_EXPORT const char* SCIPtimGetStageName ( SCIP scip,
int  stagenum 
)
Parameters
scipSCIP data structure
stagenumthe number of the requested stage

Definition at line 944 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
scipSCIP data structure
consnamethe constraint to search for

Definition at line 965 of file reader_tim.c.

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

Referenced by readIndep().

◆ SCIPtimFindStage()

SCIP_EXPORT int SCIPtimFindStage ( SCIP scip,
const char *  stage 
)
Parameters
scipSCIP data structure
stagethe name of the requested stage

Definition at line 1006 of file reader_tim.c.

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

Referenced by addScenarioVarsAndConsToProb(), and readScenarios().

◆ SCIPtimGetStageVars()

SCIP_EXPORT SCIP_VAR** SCIPtimGetStageVars ( SCIP scip,
int  stagenum 
)
Parameters
scipSCIP data structure
stagenumthe number of the requested stage

Definition at line 1044 of file reader_tim.c.

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

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().

◆ SCIPtimGetStageConss()

SCIP_EXPORT SCIP_CONS** SCIPtimGetStageConss ( SCIP scip,
int  stagenum 
)
Parameters
scipSCIP data structure
stagenumthe number of the requested stage

Definition at line 1065 of file reader_tim.c.

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

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().

◆ SCIPtimGetStageNVars()

SCIP_EXPORT int SCIPtimGetStageNVars ( SCIP scip,
int  stagenum 
)
Parameters
scipSCIP data structure
stagenumthe number of the requested stage

Definition at line 1086 of file reader_tim.c.

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

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().

◆ SCIPtimGetStageNConss()

SCIP_EXPORT int SCIPtimGetStageNConss ( SCIP scip,
int  stagenum 
)
Parameters
scipSCIP data structure
stagenumthe number of the requested stage

Definition at line 1107 of file reader_tim.c.

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

Referenced by addScenarioVarsAndConsToProb(), and removeCoreVariablesAndConstraints().