Detailed Description

This page contains a list of all file readers which are currently available.

List of readable file formats

The interactive shell and the callable library are capable of reading/parsing several different file formats.

BND format	for variable bounds
CIP format	for SCIP's constraint integer programming format
CNF format	DIMACS CNF (conjunctive normal form) file format used for example for SAT problems
DIFF format	for reading a new objective function for mixed-integer programs
FZN format	FlatZinc is a low-level solver input language that is the target language for MiniZinc
LP format	for mixed-integer (quadratically constrained quadratic) programs (CPLEX)
MPS format	for mixed-integer (quadratically constrained quadratic) programs
NL format	for AMPL .nl files, e.g., mixed-integer linear and nonlinear
OPB format	for pseudo-Boolean optimization instances
OSiL format	for mixed-integer nonlinear programs
PIP format	for mixed-integer polynomial programming problems
SOL format	for solutions; XML-format (read-only) or raw SCIP format
WBO format	for weighted pseudo-Boolean optimization instances
ZPL format	for ZIMPL models, i.e., mixed-integer linear and nonlinear programming problems [read only]

How to add a file reader

A detailed description what a file reader does and how to add a file reader to SCIP can be found here.

Modules
	Inclusion methods
	methods to include specific file readers into SCIP

Functions
SCIP_RETCODE	SCIPwriteCcg (SCIP scip, FILE file, const char name, SCIP_Bool transformed, SCIP_VAR vars, int nvars, SCIP_CONS conss, int nconss, SCIP_RESULT result)

SCIP_RETCODE	SCIPreadCor (SCIP scip, const char filename, SCIP_RESULT *result)

SCIP_RETCODE	SCIPfreeReaderdataCor (SCIP *scip)

SCIP_Bool	SCIPcorHasRead (SCIP_READER *reader)

int	SCIPcorGetNVarNames (SCIP_READER *reader)

int	SCIPcorGetNConsNames (SCIP_READER *reader)

const char *	SCIPcorGetVarName (SCIP_READER *reader, int i)

const char *	SCIPcorGetConsName (SCIP_READER *reader, int i)

SCIP_RETCODE	SCIPreadDiff (SCIP scip, SCIP_READER reader, const char filename, SCIP_RESULT result)

SCIP_RETCODE	SCIPprintSolReaderFzn (SCIP scip, SCIP_SOL sol, FILE *file)

SCIP_RETCODE	SCIPwriteGms (SCIP scip, FILE file, const char name, SCIP_Bool transformed, SCIP_OBJSENSE objsense, SCIP_Real objscale, SCIP_Real objoffset, SCIP_VAR vars, int nvars, int nbinvars, int nintvars, int nimplvars, int ncontvars, SCIP_CONS conss, int nconss, SCIP_RESULT result)

SCIP_RETCODE	SCIPreadLp (SCIP scip, SCIP_READER reader, const char filename, SCIP_RESULT result)

SCIP_RETCODE	SCIPwriteLp (SCIP scip, FILE file, const char name, SCIP_Bool transformed, SCIP_OBJSENSE objsense, SCIP_Real objoffset, SCIP_Real objscale, SCIP_RATIONAL objoffsetexact, SCIP_RATIONAL objscaleexact, SCIP_VAR vars, int nvars, int nbinvars, int nintvars, int nimplvars, int ncontvars, SCIP_CONS conss, int nconss, SCIP_RESULT result)

SCIP_RETCODE	SCIPreadMps (SCIP scip, SCIP_READER reader, const char filename, SCIP_RESULT result, const char *varnames, const char consnames, int varnamessize, int consnamessize, int nvarnames, int *nconsnames)

SCIP_RETCODE	SCIPwriteMps (SCIP scip, SCIP_READER reader, FILE file, const char name, SCIP_Bool transformed, SCIP_OBJSENSE objsense, SCIP_Real objoffset, SCIP_Real objscale, SCIP_RATIONAL objoffsetexact, SCIP_RATIONAL objscaleexact, SCIP_VAR vars, int nvars, int nbinvars, int nintvars, int nimplvars, int ncontvars, SCIP_VAR fixedvars, int nfixedvars, SCIP_CONS *conss, int nconss, SCIP_RESULT result)

SCIP_RETCODE	SCIPreadOpb (SCIP scip, SCIP_READER reader, const char filename, SCIP_RESULT result)

SCIP_RETCODE	SCIPwriteOpb (SCIP scip, FILE file, const char name, SCIP_Bool transformed, SCIP_OBJSENSE objsense, SCIP_Real objoffset, SCIP_Real objscale, SCIP_RATIONAL objoffsetexact, SCIP_RATIONAL objscaleexact, SCIP_VAR vars, int nvars, int nbinvars, int nintvars, int nimplvars, int ncontvars, SCIP_VAR fixedvars, int nfixedvars, SCIP_CONS conss, int nconss, SCIP_Bool genericnames, SCIP_RESULT result)

SCIP_RETCODE	SCIPwritePbm (SCIP scip, FILE file, const char name, SCIP_READERDATA readerdata, SCIP_Bool transformed, int nvars, SCIP_CONS *conss, int nconss, SCIP_RESULT result)

SCIP_RETCODE	SCIPreadPip (SCIP scip, SCIP_READER reader, const char filename, SCIP_RESULT result)

SCIP_RETCODE	SCIPwritePip (SCIP scip, FILE file, const char name, SCIP_Bool transformed, SCIP_OBJSENSE objsense, SCIP_Real objscale, SCIP_Real objoffset, SCIP_VAR vars, int nvars, int nbinvars, int nintvars, int nimplvars, int ncontvars, SCIP_CONS conss, int nconss, SCIP_RESULT result)

SCIP_RETCODE	SCIPwritePpm (SCIP scip, FILE file, const char name, SCIP_READERDATA readerdata, SCIP_Bool transformed, SCIP_VAR vars, int nvars, SCIP_CONS conss, int nconss, SCIP_RESULT *result)

SCIP_RETCODE	SCIPreadSto (SCIP scip, const char filename, SCIP_RESULT *result)

int	SCIPstoGetNScenarios (SCIP *scip)

SCIP_RETCODE	SCIPfreeReaderdataSto (SCIP *scip)

SCIP_RETCODE	SCIPreadTim (SCIP scip, const char filename, SCIP_RESULT *result)

Files
file	reader_bnd.h
	file reader for variable bounds

file	reader_ccg.h
	Column connectivity graph file reader (actually, only a writer)

file	reader_cip.h
	CIP file reader.

file	reader_cnf.h
	CNF file reader.

file	reader_cor.h
	COR file reader (MPS format of the core problem for stochastic programs)

file	reader_dec.h
	file reader for decompositions in the constraint based dec-file format.

file	reader_diff.h
	diff file reader

file	reader_fix.h
	file reader for variable fixings

file	reader_fzn.h
	FlatZinc file reader.

file	reader_gms.h
	GAMS file reader and writer.

file	reader_lp.h
	LP file reader.

file	reader_mps.h
	(extended) MPS file reader

file	reader_mst.h
	file reader for partial primal solutions

file	reader_nl.h
	AMPL .nl file reader and writer.

file	reader_opb.h
	pseudo-Boolean file reader (opb format)

file	reader_osil.h
	OS instance language (OSiL) format file reader.

file	reader_pbm.h
	file writer for portable bitmap file format (PBM), open with common graphic viewer programs (e.g. xview)

file	reader_pip.h
	file reader for polynomial mixed-integer programs in PIP format

file	reader_ppm.h
	file writer for portable pixmap file format (PPM), open with common graphic viewer programs (e.g. xview)

file	reader_rlp.h
	RLP file reader (LP format with generic variables and row names)

file	reader_smps.h
	SMPS file reader - SMPS files lists the cor, tim and sto files for a single instance to be read.

file	reader_sol.h
	file reader for primal solutions

file	reader_sto.h
	STO file reader - the stochastic information of an instance in SMPS format.

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

file	reader_wbo.h
	WBO file reader (LP format with generic variables and row names)

file	reader_zpl.h
	ZIMPL model file reader.

file	reader_lop.h
	linear ordering file reader

Function Documentation

◆ SCIPwriteCcg()

SCIP_RETCODE SCIPwriteCcg	(	SCIP *	scip,
		FILE *	file,
		const char *	name,
		SCIP_Bool	transformed,
		SCIP_VAR **	vars,
		int	nvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_RESULT *	result
	)

writes problem to file

Parameters

scip	SCIP data structure
file	output file, or NULL if standard output should be used
name	problem name
transformed	TRUE iff problem is the transformed problem
vars	array with active variables ordered binary, integer, implicit, continuous
nvars	number of active variables in the problem
conss	array with constraints of the problem
nconss	number of constraints in the problem
result	pointer to store the result of the file writing call

Definition at line 397 of file reader_ccg.c.

References a, freeGraph(), handleLinearCons(), initGraph(), NULL, SCIP_CALL, SCIP_Longint, SCIP_OKAY, SCIP_Real, SCIP_SUCCESS, SCIPallocBufferArray, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPconsIsEnabled(), SCIPconsIsTransformed(), SCIPfreeBufferArray, SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetValsLinear(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPinfoMessage(), SCIPprintCons(), SCIPwarningMessage(), and w.

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPreadCor()

SCIP_RETCODE SCIPreadCor	(	SCIP *	scip,
		const char *	filename,
		SCIP_RESULT *	result
	)

reads problem from file

Parameters

scip	SCIP data structure
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call

Definition at line 200 of file reader_cor.c.

References createReaderdata(), NULL, READER_NAME, SCIP_CALL, SCIP_DIDNOTRUN, SCIP_OKAY, SCIP_SUCCESS, SCIPfindReader(), SCIPfreeProb(), SCIPfreeReaderdataCor(), SCIPfreeReaderdataSto(), SCIPfreeReaderdataTim(), SCIPreaderGetData(), SCIPreadMps(), and TRUE.

Referenced by SCIP_DECL_READERREAD().

◆ SCIPfreeReaderdataCor()

SCIP_RETCODE SCIPfreeReaderdataCor ( SCIP * scip )

frees the COR reader data

Parameters

scip	the SCIP data structure

Definition at line 241 of file reader_cor.c.

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

Referenced by SCIPreadCor().

◆ SCIPcorHasRead()

SCIP_Bool SCIPcorHasRead ( SCIP_READER * reader )

returns whether the COR file has been successfully read. This is used by the TIM and STO readers.

Parameters

reader the file reader itself

Definition at line 267 of file reader_cor.c.

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

Referenced by SCIP_DECL_READERREAD().

◆ SCIPcorGetNVarNames()

int SCIPcorGetNVarNames ( SCIP_READER * reader )

returns the number of variable names in the COR problem

Parameters

reader the file reader itself

Definition at line 283 of file reader_cor.c.

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

Referenced by createStages().

◆ SCIPcorGetNConsNames()

int SCIPcorGetNConsNames ( SCIP_READER * reader )

returns the number of constraint names in the COR problem

Parameters

reader the file reader itself

Definition at line 299 of file reader_cor.c.

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

Referenced by createStages().

◆ SCIPcorGetVarName()

const char * SCIPcorGetVarName	(	SCIP_READER *	reader,
		int	i
	)

returns the variable name for the given index

Parameters

reader	the file reader itself
i	the index of the variable that is requested

Definition at line 315 of file reader_cor.c.

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

Referenced by createStages().

◆ SCIPcorGetConsName()

const char * SCIPcorGetConsName	(	SCIP_READER *	reader,
		int	i
	)

returns the constraint name for the given index

Parameters

reader	the file reader itself
i	the index of the constraint that is requested

Definition at line 333 of file reader_cor.c.

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

Referenced by createStages().

◆ SCIPreadDiff()

SCIP_RETCODE SCIPreadDiff	(	SCIP *	scip,
		SCIP_READER *	reader,
		const char *	filename,
		SCIP_RESULT *	result
	)

reads problem from file

Parameters

scip	SCIP data structure
reader	the file reader itself
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call

Definition at line 1012 of file reader_diff.c.

References FALSE, LP_MAX_LINELEN, LP_MAX_PUSHEDTOKENS, LP_START, NULL, readDiffFile(), SCIP_CALL, SCIP_DIDNOTRUN, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_READERROR, SCIP_SUCCESS, SCIPallocBlockMemoryArray, and SCIPfreeBlockMemoryArray.

Referenced by SCIP_DECL_READERREAD().

◆ SCIPprintSolReaderFzn()

SCIP_RETCODE SCIPprintSolReaderFzn	(	SCIP *	scip,
		SCIP_SOL *	sol,
		FILE *	file
	)

print given solution in Flatzinc format w.r.t. the output annotation

Parameters

scip	SCIP data structure
sol	primal solution, or NULL for current LP/pseudo solution
file	output file (or NULL for standard output)

Definition at line 4975 of file reader_fzn.c.

References NULL, printValue(), READER_NAME, SCIP_OKAY, SCIP_Real, SCIPfindReader(), SCIPgetSolVal(), SCIPinfoMessage(), SCIPreaderGetData(), and SCIPsortPtr().

◆ SCIPwriteGms()

SCIP_RETCODE SCIPwriteGms	(	SCIP *	scip,
		FILE *	file,
		const char *	name,
		SCIP_Bool	transformed,
		SCIP_OBJSENSE	objsense,
		SCIP_Real	objscale,
		SCIP_Real	objoffset,
		SCIP_VAR **	vars,
		int	nvars,
		int	nbinvars,
		int	nintvars,
		int	nimplvars,
		int	ncontvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_RESULT *	result
	)

writes problem to file

writes problem to gms file

Parameters

scip	SCIP data structure
file	output file, or NULL if standard output should be used
name	problem name
transformed	TRUE iff problem is the transformed problem
objsense	objective sense
objscale	scalar applied to objective function; external objective value is extobj = objsense * objscale * (intobj + objoffset)
objoffset	objective offset from bound shifting and fixing
vars	array with active variables ordered binary, integer, implicit, continuous
nvars	number of active variables in the problem
nbinvars	number of binary variables
nintvars	number of general integer variables
nimplvars	number of implicit integer variables
ncontvars	number of continuous variables
conss	array with constraints of the problem
nconss	number of constraints in the problem
result	pointer to store the result of the file writing call

Definition at line 1476 of file reader_gms.c.

References appendLine(), checkConsnames(), checkVarnames(), clearLine(), endLine(), FALSE, GMS_MAX_LINELEN, GMS_MAX_NAMELEN, GMS_MAX_PRINTLEN, NULL, printActiveVariables(), printAndCons(), printConformName(), printIndicatorCons(), printLinearCons(), printNonlinearCons(), printSOSCons(), SCIP_Bool, SCIP_CALL, SCIP_INVALIDDATA, SCIP_Longint, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_Real, SCIP_SETPPCTYPE_COVERING, SCIP_SETPPCTYPE_PACKING, SCIP_SETPPCTYPE_PARTITIONING, SCIP_SUCCESS, SCIP_VARSTATUS_NEGATED, SCIP_VARSTATUS_ORIGINAL, SCIP_VARTYPE_BINARY, SCIP_VARTYPE_CONTINUOUS, SCIP_VARTYPE_INTEGER, SCIPallocBufferArray, SCIPceil(), SCIPconsGetHdlr(), SCIPconsGetName(), SCIPconshdlrGetName(), SCIPconsIsEnabled(), SCIPconsIsTransformed(), SCIPerrorMessage, SCIPfeasFloor(), SCIPfloor(), SCIPfreeBufferArray, SCIPgetBinaryVarIndicator(), SCIPgetCapacityKnapsack(), SCIPgetExprNonlinear(), SCIPgetIntParam(), SCIPgetLhsLinear(), SCIPgetLhsNonlinear(), SCIPgetLhsVarbound(), SCIPgetNVarsAnd(), SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetNVarsSOS1(), SCIPgetNVarsSOS2(), SCIPgetResultantAnd(), SCIPgetRhsLinear(), SCIPgetRhsNonlinear(), SCIPgetRhsVarbound(), SCIPgetSlackVarIndicator(), SCIPgetTypeSetppc(), SCIPgetValsLinear(), SCIPgetVarsAnd(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarsSOS1(), SCIPgetVarsSOS2(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPinfinity(), SCIPinfoMessage(), SCIPisEQ(), SCIPisFeasEQ(), SCIPisInfinity(), SCIPisZero(), SCIPprintCons(), SCIPsnprintf(), SCIPvarGetImplType(), SCIPvarGetLbLocal(), SCIPvarGetLbOriginal(), SCIPvarGetName(), SCIPvarGetObj(), SCIPvarGetStatus(), SCIPvarGetType(), SCIPvarGetUbLocal(), SCIPvarGetUbOriginal(), SCIPvarIsActive(), SCIPwarningMessage(), and TRUE.

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPreadLp()

SCIP_RETCODE SCIPreadLp	(	SCIP *	scip,
		SCIP_READER *	reader,
		const char *	filename,
		SCIP_RESULT *	result
	)

reads problem from file

Parameters

scip	SCIP data structure
reader	the file reader itself
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call

Definition at line 4427 of file reader_lp.c.

References FALSE, LP_MAX_LINELEN, LP_MAX_PUSHEDTOKENS, LP_START, NULL, readLPFile(), SCIP_CALL, SCIP_INVALIDDATA, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_READERROR, SCIP_SUCCESS, SCIPallocBlockMemoryArray, SCIPfreeBlockMemoryArray, SCIPgetBoolParam(), and SCIPsetObjsense().

Referenced by SCIP_DECL_READERREAD().

◆ SCIPwriteLp()

SCIP_RETCODE SCIPwriteLp	(	SCIP *	scip,
		FILE *	file,
		const char *	name,
		SCIP_Bool	transformed,
		SCIP_OBJSENSE	objsense,
		SCIP_Real	objoffset,
		SCIP_Real	objscale,
		SCIP_RATIONAL *	objoffsetexact,
		SCIP_RATIONAL *	objscaleexact,
		SCIP_VAR **	vars,
		int	nvars,
		int	nbinvars,
		int	nintvars,
		int	nimplvars,
		int	ncontvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_RESULT *	result
	)

writes problem to file

Parameters

scip	SCIP data structure
file	output file, or NULL if standard output should be used
name	problem name
transformed	TRUE iff problem is the transformed problem
objsense	objective sense
objoffset	objective offset from bound shifting and fixing
objscale	scalar applied to objective function; external objective value is extobj = objsense * objscale * (intobj + objoffset)
objoffsetexact	exact objective offset from bound shifting and fixing
objscaleexact	exact scalar applied to objective function; external objective value is extobjexact = objsense * objscaleexact * (intobjexact + objoffsetexact)
vars	array with active variables ordered binary, integer, implicit, continuous
nvars	number of active variables in the problem
nbinvars	number of binary variables
nintvars	number of general integer variables
nimplvars	number of implicit integer variables
ncontvars	number of continuous variables
conss	array with constraints of the problem
nconss	number of constraints in the problem
result	pointer to store the result of the file writing call

Definition at line 4503 of file reader_lp.c.

References appendLine(), checkConsnames(), checkVarnames(), clearLine(), collectAggregatedVars(), DEFAULT_AGGRLINEARIZATION_ANDS, DEFAULT_LINEARIZE_ANDS, endLine(), FALSE, LP_MAX_NAMELEN, LP_MAX_PRINTLEN, MAX, NULL, printAggregatedCons(), printAndCons(), printQuadraticCons(), printRowExact(), printSosCons(), READER_NAME, SCIP_Bool, SCIP_CALL, SCIP_INVALIDDATA, SCIP_Longint, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_Real, SCIP_SETPPCTYPE_COVERING, SCIP_SETPPCTYPE_PACKING, SCIP_SETPPCTYPE_PARTITIONING, SCIP_SUCCESS, SCIP_VARSTATUS_NEGATED, SCIP_VARSTATUS_ORIGINAL, SCIP_VARTYPE_BINARY, SCIP_VARTYPE_CONTINUOUS, SCIP_VARTYPE_INTEGER, SCIPallocBlockMemoryArray, SCIPallocBufferArray, SCIPblkmem(), SCIPbuffer(), SCIPcalcMemGrowSize(), SCIPcheckExprQuadratic(), SCIPcheckQuadraticNonlinear(), SCIPconsGetHdlr(), SCIPconsGetName(), SCIPconshdlrGetConss(), SCIPconshdlrGetName(), SCIPconshdlrGetNConss(), SCIPconsIsDeleted(), SCIPconsIsEnabled(), SCIPconsIsTransformed(), SCIPdebugMsg, SCIPduplicateExpr(), SCIPerrorMessage, SCIPexprAreQuadraticExprsVariables(), SCIPfindConshdlr(), SCIPfindReader(), SCIPfreeBlockMemoryArray, SCIPfreeBufferArray, SCIPgetBinaryVarIndicator(), SCIPgetCapacityKnapsack(), SCIPgetConsNVars(), SCIPgetConsVars(), SCIPgetExprNonlinear(), SCIPgetIntParam(), SCIPgetLhsExactLinear(), SCIPgetLhsLinear(), SCIPgetLhsNonlinear(), SCIPgetLhsVarbound(), SCIPgetLinearConsIndicator(), SCIPgetNTotalVars(), SCIPgetNVarsExactLinear(), SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetNVarsSOS1(), SCIPgetNVarsSOS2(), SCIPgetRhsExactLinear(), SCIPgetRhsLinear(), SCIPgetRhsNonlinear(), SCIPgetRhsVarbound(), SCIPgetSlackVarIndicator(), SCIPgetTypeSetppc(), SCIPgetValsExactLinear(), SCIPgetValsLinear(), SCIPgetVarsExactLinear(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarsSOS1(), SCIPgetVarsSOS2(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPgetWeightsSOS1(), SCIPgetWeightsSOS2(), SCIPhashmapCreate(), SCIPhashmapExists(), SCIPhashmapFree(), SCIPhashmapSetImageInt(), SCIPhashtableCreate(), SCIPhashtableFree(), SCIPinfinity(), SCIPinfoMessage(), SCIPisExact(), SCIPisFeasEQ(), SCIPisInfinity(), SCIPisZero(), SCIPprintCons(), SCIPrationalCreateBuffer(), SCIPrationalFreeBuffer(), SCIPrationalIsEQ(), SCIPrationalIsInfinity(), SCIPrationalIsNegative(), SCIPrationalIsNegInfinity(), SCIPrationalIsZero(), SCIPrationalMult(), SCIPrationalSetRational(), SCIPrationalToString(), SCIPreaderGetData(), SCIPreallocBufferArray, SCIPreleaseExpr(), SCIPsimplifyExpr(), SCIPsnprintf(), SCIPvarGetImplType(), SCIPvarGetLbGlobal(), SCIPvarGetLbLocal(), SCIPvarGetLbOriginal(), SCIPvarGetName(), SCIPvarGetNegatedVar(), SCIPvarGetObj(), SCIPvarGetObjExact(), SCIPvarGetStatus(), SCIPvarGetType(), SCIPvarGetUbGlobal(), SCIPvarGetUbLocal(), SCIPvarGetUbOriginal(), SCIPvarIsNegated(), SCIPwarningMessage(), and TRUE.

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPreadMps()

SCIP_RETCODE SCIPreadMps	(	SCIP *	scip,
		SCIP_READER *	reader,
		const char *	filename,
		SCIP_RESULT *	result,
		const char ***	varnames,
		const char ***	consnames,
		int *	varnamessize,
		int *	consnamessize,
		int *	nvarnames,
		int *	nconsnames
	)

reads problem from file

Parameters

scip	SCIP data structure
reader	the file reader itself
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call
varnames	storage for the variable names, or NULL
consnames	storage for the constraint names, or NULL
varnamessize	the size of the variable names storage, or NULL
consnamessize	the size of the constraint names storage, or NULL
nvarnames	the number of stored variable names, or NULL
nconsnames	the number of stored constraint names, or NULL

Definition at line 4945 of file reader_mps.c.

References NULL, readMps(), readMpsExact(), SCIP_CALL, SCIP_NOFILE, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_READERROR, SCIP_SUCCESS, and SCIPisExact().

Referenced by SCIP_DECL_READERREAD(), and SCIPreadCor().

◆ SCIPwriteMps()

SCIP_RETCODE SCIPwriteMps	(	SCIP *	scip,
		SCIP_READER *	reader,
		FILE *	file,
		const char *	name,
		SCIP_Bool	transformed,
		SCIP_OBJSENSE	objsense,
		SCIP_Real	objoffset,
		SCIP_Real	objscale,
		SCIP_RATIONAL *	objoffsetexact,
		SCIP_RATIONAL *	objscaleexact,
		SCIP_VAR **	vars,
		int	nvars,
		int	nbinvars,
		int	nintvars,
		int	nimplvars,
		int	ncontvars,
		SCIP_VAR **	fixedvars,
		int	nfixedvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_RESULT *	result
	)

writes problem to file

Parameters

scip	SCIP data structure
reader	the file reader itself
file	output file, or NULL if standard output should be used
name	problem name
transformed	TRUE iff problem is the transformed problem
objsense	objective sense
objoffset	objective offset from bound shifting and fixing
objscale	scalar applied to objective function; external objective value is extobj = objsense * objscale * (intobj + objoffset)
objoffsetexact	exact objective offset from bound shifting and fixing
objscaleexact	exact scalar applied to objective function; external objective value is extobjexact = objsense * objscaleexact * (intobjexact + objoffsetexact)
vars	array with active variables ordered binary, integer, implicit, continuous
nvars	number of active variables in the problem
nbinvars	number of binary variables
nintvars	number of general integer variables
nimplvars	number of implicit integer variables
ncontvars	number of continuous variables
fixedvars	array with fixed and aggregated variables
nfixedvars	number of fixed and aggregated variables in the problem
conss	array with constraints of the problem
nconss	number of constraints in the problem
result	pointer to store the result of the file writing call

Definition at line 4983 of file reader_mps.c.

References checkConsnames(), checkSparseMatrixCapacity(), checkVarnames(), collectAggregatedVars(), ConsNameFreq::consname, FALSE, freeMatrix(), getLinearCoeffs(), initializeMatrix(), MAX, MPS_MAX_NAMELEN, MPS_MAX_VALUELEN, NULL, printBoundSection(), printRangeSection(), printRecord(), printRhsSection(), printRowType(), printStart(), READER_NAME, SCIP_Bool, SCIP_CALL, SCIP_LOCKTYPE_MODEL, SCIP_Longint, SCIP_OBJSENSE_MAXIMIZE, SCIP_OKAY, SCIP_Real, SCIP_SETPPCTYPE_COVERING, SCIP_SETPPCTYPE_PACKING, SCIP_SETPPCTYPE_PARTITIONING, SCIP_SUCCESS, SCIP_VARSTATUS_AGGREGATED, SCIP_VARSTATUS_FIXED, SCIPallocBlockMemoryArray, SCIPallocBufferArray, SCIPblkmem(), SCIPcheckExprQuadratic(), SCIPconsGetHdlr(), SCIPconsGetName(), SCIPconshdlrGetName(), SCIPconsIsDeleted(), SCIPconsIsEnabled(), SCIPdebugMsg, SCIPduplicateExpr(), SCIPexprAreQuadraticExprsVariables(), SCIPexprGetQuadraticBilinTerm(), SCIPexprGetQuadraticData(), SCIPexprGetQuadraticQuadTerm(), SCIPfindConshdlr(), SCIPfreeBlockMemoryArray, SCIPfreeBufferArray, SCIPgetBinaryVarIndicator(), SCIPgetCapacityKnapsack(), SCIPgetExprNonlinear(), SCIPgetIntParam(), SCIPgetLhsLinear(), SCIPgetLhsNonlinear(), SCIPgetLhsVarbound(), SCIPgetLinearConsIndicator(), SCIPgetNVarsAnd(), SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetNVarsSOS1(), SCIPgetNVarsSOS2(), SCIPgetResultantAnd(), SCIPgetRhsLinear(), SCIPgetRhsNonlinear(), SCIPgetRhsVarbound(), SCIPgetSlackVarIndicator(), SCIPgetTypeSetppc(), SCIPgetValsLinear(), SCIPgetVarExprVar(), SCIPgetVarsAnd(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarsSOS1(), SCIPgetVarsSOS2(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPgetWeightsSOS1(), SCIPgetWeightsSOS2(), SCIPhashmapExists(), SCIPhashmapFree(), SCIPhashmapGetImage(), SCIPhashmapInsert(), SCIPhashtableCreate(), SCIPhashtableExists(), SCIPhashtableFree(), SCIPhashtableInsert(), SCIPinfinity(), SCIPinfoMessage(), SCIPisEQ(), SCIPisExact(), SCIPisExprVar(), SCIPisInfinity(), SCIPisZero(), SCIPprintOrigProblem(), SCIPprintTransProblem(), SCIPrationalGetReal(), SCIPreaderGetData(), SCIPreaderGetName(), SCIPreallocBufferArray, SCIPreleaseExpr(), SCIPsimplifyExpr(), SCIPsnprintf(), SCIPvarGetName(), SCIPvarGetNegatedVar(), SCIPvarGetNLocksDownType(), SCIPvarGetNLocksUpType(), SCIPvarGetObj(), SCIPvarGetStatus(), SCIPvarIsNegated(), SCIPwarningMessage(), TRUE, and writeVarIsIntegral().

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPreadOpb()

SCIP_RETCODE SCIPreadOpb	(	SCIP *	scip,
		SCIP_READER *	reader,
		const char *	filename,
		SCIP_RESULT *	result
	)

reads problem from file

Parameters

scip	SCIP data structure
reader	the file reader itself
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call

Definition at line 4551 of file reader_opb.c.

References FALSE, NULL, OPB_MAX_LINELEN, OPB_MAX_PUSHEDTOKENS, readOPBFile(), SCIP_CALL, SCIP_DIDNOTRUN, SCIP_INVALIDDATA, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_READERROR, SCIP_SUCCESS, SCIPallocBlockMemoryArray, SCIPfreeBlockMemoryArray, SCIPinfinity(), SCIPsetObjsense(), and SCIPwarningMessage().

Referenced by SCIP_DECL_READERREAD().

◆ SCIPwriteOpb()

SCIP_RETCODE SCIPwriteOpb	(	SCIP *	scip,
		FILE *	file,
		const char *	name,
		SCIP_Bool	transformed,
		SCIP_OBJSENSE	objsense,
		SCIP_Real	objoffset,
		SCIP_Real	objscale,
		SCIP_RATIONAL *	objoffsetexact,
		SCIP_RATIONAL *	objscaleexact,
		SCIP_VAR **	vars,
		int	nvars,
		int	nbinvars,
		int	nintvars,
		int	nimplvars,
		int	ncontvars,
		SCIP_VAR **	fixedvars,
		int	nfixedvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_Bool	genericnames,
		SCIP_RESULT *	result
	)

writes problem to file

Parameters

scip	SCIP data structure
file	output file, or NULL if standard output should be used
name	problem name
transformed	TRUE iff problem is the transformed problem
objsense	objective sense
objoffset	objective offset from bound shifting and fixing
objscale	scalar applied to objective function; external objective value is extobj = objsense * objscale * (intobj + objoffset)
objoffsetexact	exact objective offset from bound shifting and fixing
objscaleexact	exact scalar applied to objective function; external objective value is extobjexact = objsense * objscaleexact * (intobjexact + objoffsetexact)
vars	array with active variables ordered binary, integer, implicit, continuous
nvars	number of active variables in the problem
nbinvars	number of binary variables
nintvars	number of general integer variables
nimplvars	number of implicit integer variables
ncontvars	number of continuous variables
fixedvars	array with fixed variables
nfixedvars	number of fixed and aggregated variables in the problem
conss	array with constraints of the problem
nconss	number of constraints in the problem
genericnames	should generic variable and constraint names be used
result	pointer to store the result of the file writing call

Definition at line 4632 of file reader_opb.c.

References computeAndConstraintInfos(), FALSE, INDICATORSLACKVARNAME, INDICATORVARNAME, NULL, SCIP_Bool, SCIP_CALL, SCIP_DIDNOTRUN, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_SUCCESS, SCIP_VARTYPE_INTEGER, SCIP_WRITEERROR, SCIPconshdlrGetNConss(), SCIPfindConshdlr(), SCIPfreeMemoryArray, SCIPprintOrigProblem(), SCIPprintTransProblem(), SCIPprintVar(), SCIPsortedvecFindPtr(), SCIPvarGetName(), SCIPvarGetType(), SCIPvarIsBinary(), SCIPwarningMessage(), TRUE, and writeOpb().

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPwritePbm()

SCIP_RETCODE SCIPwritePbm	(	SCIP *	scip,
		FILE *	file,
		const char *	name,
		SCIP_READERDATA *	readerdata,
		SCIP_Bool	transformed,
		int	nvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_RESULT *	result
	)

Parameters

scip	SCIP data structure
file	output file, or NULL if standard output should be used
name	problem name
readerdata	information for reader
transformed	TRUE iff problem is the transformed problem
nvars	number of active variables in the problem
conss	array with constraints of the problem
nconss	number of constraints in the problem
result	pointer to store the result of the file writing call

Definition at line 483 of file reader_pbm.c.

References BMSclearMemoryArray, clearLine(), drawScaledImage(), getActiveVariables2(), getSubmatrixSize(), NULL, PBM_MAX_LINELEN, printLinearCons(), printRow(), SCIP_Bool, SCIP_CALL, SCIP_Longint, SCIP_OKAY, SCIP_Real, SCIP_SUCCESS, SCIPallocBufferArray, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPconsIsEnabled(), SCIPconsIsTransformed(), SCIPfreeBufferArray, SCIPfreeBufferArrayNull, SCIPgetConsNVars(), SCIPgetConsVars(), SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetValsLinear(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPinfoMessage(), SCIPprintCons(), and SCIPwarningMessage().

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPreadPip()

SCIP_RETCODE SCIPreadPip	(	SCIP *	scip,
		SCIP_READER *	reader,
		const char *	filename,
		SCIP_RESULT *	result
	)

reads problem from file

Parameters

scip	SCIP data structure
reader	the file reader itself
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call

Definition at line 3256 of file reader_pip.c.

References FALSE, NULL, PIP_MAX_LINELEN, PIP_MAX_PUSHEDTOKENS, PIP_START, readPIPFile(), SCIP_CALL, SCIP_DIDNOTRUN, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_READERROR, SCIP_SUCCESS, SCIPallocBlockMemoryArray, SCIPfreeBlockMemoryArray, SCIPgetBoolParam(), and SCIPsetObjsense().

Referenced by SCIP_DECL_READERREAD().

◆ SCIPwritePip()

SCIP_RETCODE SCIPwritePip	(	SCIP *	scip,
		FILE *	file,
		const char *	name,
		SCIP_Bool	transformed,
		SCIP_OBJSENSE	objsense,
		SCIP_Real	objscale,
		SCIP_Real	objoffset,
		SCIP_VAR **	vars,
		int	nvars,
		int	nbinvars,
		int	nintvars,
		int	nimplvars,
		int	ncontvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_RESULT *	result
	)

writes problem to file

Parameters

scip	SCIP data structure
file	output file, or NULL if standard output should be used
name	problem name
transformed	TRUE iff problem is the transformed problem
objsense	objective sense
objscale	scalar applied to objective function; external objective value is extobj = objsense * objscale * (intobj + objoffset)
objoffset	objective offset from bound shifting and fixing
vars	array with active variables ordered binary, integer, implicit, continuous
nvars	number of active variables in the problem
nbinvars	number of binary variables
nintvars	number of general integer variables
nimplvars	number of implicit integer variables
ncontvars	number of continuous variables
conss	array with constraints of the problem
nconss	number of constraints in the problem
result	pointer to store the result of the file writing call

Definition at line 2726 of file reader_pip.c.

References appendLine(), checkConsnames(), checkVarnames(), clearLine(), collectAggregatedVars(), endLine(), FALSE, isExprPolynomial(), NULL, PIP_MAX_NAMELEN, PIP_MAX_PRINTLEN, printAggregatedCons(), printNonlinearCons(), printQuadraticCons(), printRowAnd(), SCIP_Bool, SCIP_CALL, SCIP_INVALIDDATA, SCIP_Longint, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_Real, SCIP_SETPPCTYPE_COVERING, SCIP_SETPPCTYPE_PACKING, SCIP_SETPPCTYPE_PARTITIONING, SCIP_SUCCESS, SCIP_VARSTATUS_NEGATED, SCIP_VARSTATUS_ORIGINAL, SCIP_VARTYPE_BINARY, SCIP_VARTYPE_CONTINUOUS, SCIP_VARTYPE_INTEGER, SCIPallocBufferArray, SCIPblkmem(), SCIPcalcMemGrowSize(), SCIPcheckExprQuadratic(), SCIPconsGetHdlr(), SCIPconsGetName(), SCIPconshdlrGetName(), SCIPconsIsEnabled(), SCIPconsIsTransformed(), SCIPduplicateExpr(), SCIPerrorMessage, SCIPexprAreQuadraticExprsVariables(), SCIPfreeBufferArray, SCIPgetCapacityKnapsack(), SCIPgetConsNVars(), SCIPgetConsVars(), SCIPgetExprNonlinear(), SCIPgetIntParam(), SCIPgetLhsLinear(), SCIPgetLhsNonlinear(), SCIPgetLhsVarbound(), SCIPgetNTotalVars(), SCIPgetNVarsAnd(), SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetResultantAnd(), SCIPgetRhsLinear(), SCIPgetRhsNonlinear(), SCIPgetRhsVarbound(), SCIPgetTypeSetppc(), SCIPgetValsLinear(), SCIPgetVarsAnd(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPhashtableCreate(), SCIPhashtableFree(), SCIPinfinity(), SCIPinfoMessage(), SCIPisInfinity(), SCIPisZero(), SCIPprintCons(), SCIPreallocBufferArray, SCIPreleaseExpr(), SCIPsimplifyExpr(), SCIPsnprintf(), SCIPvarGetImplType(), SCIPvarGetLbLocal(), SCIPvarGetLbOriginal(), SCIPvarGetName(), SCIPvarGetObj(), SCIPvarGetStatus(), SCIPvarGetType(), SCIPvarGetUbLocal(), SCIPvarGetUbOriginal(), SCIPwarningMessage(), and TRUE.

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPwritePpm()

SCIP_RETCODE SCIPwritePpm	(	SCIP *	scip,
		FILE *	file,
		const char *	name,
		SCIP_READERDATA *	readerdata,
		SCIP_Bool	transformed,
		SCIP_VAR **	vars,
		int	nvars,
		SCIP_CONS **	conss,
		int	nconss,
		SCIP_RESULT *	result
	)

writes problem to file

Parameters

scip	SCIP data structure
file	output file, or NULL if standard output should be used
name	problem name
readerdata	information for reader
transformed	TRUE iff problem is the transformed problem
vars	array with active variables ordered binary, integer, implicit, continuous
nvars	number of active variables in the problem
conss	array with constraints of the problem
nconss	number of constraints in the problem
result	pointer to store the result of the file writing call

Definition at line 541 of file reader_ppm.c.

References clearLine(), FALSE, NULL, PPM_MAX_LINELEN, printLinearCons(), SCIP_Bool, SCIP_CALL, SCIP_Longint, SCIP_OKAY, SCIP_Real, SCIP_SUCCESS, SCIPallocBufferArray, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPconsIsEnabled(), SCIPconsIsTransformed(), SCIPdebugMsgPrint, SCIPfreeBufferArray, SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetValsLinear(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPinfoMessage(), SCIPprintCons(), SCIPwarningMessage(), and TRUE.

Referenced by SCIP_DECL_READERWRITE().

◆ SCIPreadSto()

SCIP_RETCODE SCIPreadSto	(	SCIP *	scip,
		const char *	filename,
		SCIP_RESULT *	result
	)

reads the stochastic information for a stochastic program that is in SMPS format

Parameters

scip	SCIP data structure
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call

Definition at line 2822 of file reader_sto.c.

References freeReaderdata(), NULL, READER_NAME, readSto(), SCIP_CALL, SCIP_NOFILE, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_READERROR, SCIP_SUCCESS, SCIPfindReader(), and SCIPreaderGetData().

Referenced by SCIP_DECL_READERREAD().

◆ SCIPstoGetNScenarios()

int SCIPstoGetNScenarios ( SCIP * scip )

returns the total number of scenarios added to the problem

Parameters

scip	SCIP data structure

Definition at line 2861 of file reader_sto.c.

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

Referenced by SCIP_DECL_READERREAD().

◆ SCIPfreeReaderdataSto()

SCIP_RETCODE SCIPfreeReaderdataSto ( SCIP * scip )

frees the STO reader data

Parameters

scip	the SCIP data structure

Definition at line 2880 of file reader_sto.c.

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

Referenced by SCIP_DECL_READERREAD(), and SCIPreadCor().

◆ SCIPreadTim()

SCIP_RETCODE SCIPreadTim	(	SCIP *	scip,
		const char *	filename,
		SCIP_RESULT *	result
	)

reads the stage information for a stochastic programming instance in SMPS format

reads problem from file

Parameters

scip	SCIP data structure
filename	full path and name of file to read, or NULL if stdin should be used
result	pointer to store the result of the file reading call

Definition at line 893 of file reader_tim.c.

References createStages(), NULL, READER_NAME, readTim(), SCIP_CALL, SCIP_NOFILE, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_READERROR, SCIP_SUCCESS, SCIPfindReader(), SCIPreaderGetData(), and TRUE.

Referenced by SCIP_DECL_READERREAD().

SCIP

Detailed Description

List of readable file formats

How to add a file reader

Modules

Functions

Files

Function Documentation

◆ SCIPwriteCcg()

◆ SCIPreadCor()

◆ SCIPfreeReaderdataCor()

◆ SCIPcorHasRead()

◆ SCIPcorGetNVarNames()

◆ SCIPcorGetNConsNames()

◆ SCIPcorGetVarName()

◆ SCIPcorGetConsName()

◆ SCIPreadDiff()

◆ SCIPprintSolReaderFzn()

◆ SCIPwriteGms()

◆ SCIPreadLp()

◆ SCIPwriteLp()

◆ SCIPreadMps()

◆ SCIPwriteMps()

◆ SCIPreadOpb()

◆ SCIPwriteOpb()

◆ SCIPwritePbm()

◆ SCIPreadPip()

◆ SCIPwritePip()

◆ SCIPwritePpm()

◆ SCIPreadSto()

◆ SCIPstoGetNScenarios()

◆ SCIPfreeReaderdataSto()

◆ SCIPreadTim()