Defining the model

Functions
	pyconopt.ModelData.setProblemDimension (self, numvar, numcons, numnz, numnlnz)
	sets the problem dimension.
	pyconopt.ModelData.addConstraint (self, *args)
	Overload 1: adds a constraint to the problem.
	pyconopt.ModelData.addVariable (self, *args)
	Overload 1: adds a variable to the model.
	pyconopt.ModelData.setObjectiveElement (self, elem, elemindex)
	sets the index for the objective variable or constraint
	pyconopt.ModelData.setOptimizationSense (self, sense)
	sets the optimisation direction.
	pyconopt.ModelData.setInitialStatusOption (self, inistat)
	the setting to indicate how the initial status of the variables and slack variables will be handled.

Detailed Description

Methods that are used to define the model to be solved by CONOPT.

The model is defined by iteratively adding variables and constraints using the pyconopt.ModeData.addConstraint and pyconopt.ModeData.addVariable methods.

Function Documentation

setProblemDimension()

pyconopt.ModelData.setProblemDimension	(		self,
			numvar,
			numcons,
			numnz,
			numnlnz )

sets the problem dimension.

This is called if the user wants to implement a custom readMatrix() method.

NOTE: it is not possible to call setProblemDimension() and addConstraint() or addVariable(). The latter functions can only be used if the problem dimension is not set and the default readMatrix() method is used.

Parameters

numvar	the number of variables in the problem
numcons	the number of constraints in the problem
numnz	the number of non-zeros in the constraint matrix
numnlnz	the number of nonlinear non-zeros in the constraint matrix

Reimplemented from pyconopt.ConoptModelData.

Definition at line 2590 of file pyconopt.py.

addConstraint()

pyconopt.ModelData.addConstraint	(		self,
		*	args )

Overload 1: adds a constraint to the problem.

The non-zero coefficients are added later

Parameters

constype	the type of constraint, 0: ==, 1: >=, 2: <=, 3: free
rhs	the right hand side
slackstatus	initial status of the slack variables, see IniStat

|

Overload 2: adds a constraint to the problem. The non-zero coefficients are added later

Parameters

constype	the type of constraint, 0: ==, 1: >=, 2: <=, 3: free
rhs	the right hand side
slackstatus	initial status of the slack variables, see IniStat

|

Overload 3: adds a constraint to the problem. The matrix non-zeros are added based on the supplied variables

Parameters

constype	the type of constraint, 0: ==, 1: >=, 2: <=, 3: free
rhs	the right hand side
varindex	the variables this constraint has non-zero coefficients
value	the non-zero of the variable
nlflag	flag to set whether the variable belongs to a non-linear term
slackstatus	initial status of the slack variables, see IniStat

|

Overload 4: adds a constraint to the problem. The matrix non-zeros are added based on the supplied variables

Parameters

constype	the type of constraint, 0: ==, 1: >=, 2: <=, 3: free
rhs	the right hand side
varindex	the variables this constraint has non-zero coefficients
value	the non-zero of the variable
nlflag	flag to set whether the variable belongs to a non-linear term
slackstatus	initial status of the slack variables, see IniStat

Reimplemented from pyconopt.ConoptModelData.

Definition at line 2607 of file pyconopt.py.

addVariable()

pyconopt.ModelData.addVariable	(		self,
		*	args )

Overload 1: adds a variable to the model.

The non-zero coefficients are added later.

Parameters

lower	lower bound for the variable
upper	upper bound for the variable
curr	initial value of the variable, can be set to 0
varstatus	initial status of the variable, see IniStat

|

Overload 2: adds a variable to the model. The non-zero coefficients are added later.

Parameters

lower	lower bound for the variable
upper	upper bound for the variable
curr	initial value of the variable, can be set to 0
varstatus	initial status of the variable, see IniStat

|

Overload 3: adds a variable to the model. The non-zero coefficients are added later.

Parameters

lower	lower bound for the variable
upper	upper bound for the variable
curr	initial value of the variable, can be set to 0
varstatus	initial status of the variable, see IniStat

|

Overload 4: adds a variable to the problem. The matrix non-zeros are added based on the supplied constraints.

Parameters

lower	lower bound for the variable
upper	upper bound for the variable
consindex	the constraints this variable has non-zero coefficients
value	the non-zero of the variable
nlflag	flag to set whether the variable belongs to a non-linear term
curr	initial value of the variable, can be set to 0
varstatus	initial status of the variable, see IniStat

|

Overload 5: adds a variable to the problem. The matrix non-zeros are added based on the supplied constraints.

Parameters

lower	lower bound for the variable
upper	upper bound for the variable
consindex	the constraints this variable has non-zero coefficients
value	the non-zero of the variable
nlflag	flag to set whether the variable belongs to a non-linear term
curr	initial value of the variable, can be set to 0
varstatus	initial status of the variable, see IniStat

|

Overload 6: adds a variable to the problem. The matrix non-zeros are added based on the supplied constraints.

Parameters

lower	lower bound for the variable
upper	upper bound for the variable
consindex	the constraints this variable has non-zero coefficients
value	the non-zero of the variable
nlflag	flag to set whether the variable belongs to a non-linear term
curr	initial value of the variable, can be set to 0
varstatus	initial status of the variable, see IniStat

Reimplemented from pyconopt.ConoptModelData.

Definition at line 2663 of file pyconopt.py.

setObjectiveElement()

pyconopt.ModelData.setObjectiveElement	(		self,
			elem,
			elemindex )

sets the index for the objective variable or constraint

Reimplemented from pyconopt.ConoptModelData.

Definition at line 2752 of file pyconopt.py.

setOptimizationSense()

pyconopt.ModelData.setOptimizationSense	(		self,
			sense )

sets the optimisation direction.

Reimplemented from pyconopt.ConoptModelData.

Definition at line 2761 of file pyconopt.py.

setInitialStatusOption()

pyconopt.ModelData.setInitialStatusOption	(		self,
			inistat )

the setting to indicate how the initial status of the variables and slack variables will be handled.

The initial status is set in the addVariable() and addConstraint() methods, or in the readMatrix() method if the classical model input approach is used. By default, the value of inistat is 0, which means that the variable and slack status is ignored.

If inistat == 1: The variable status has the following behaviour:

• 0: The variable is initialized non-basic (if curr = lower or curr = upper) or super-basic, and
• 1: The variable is initialized basic The slack status has the following behaviour:
• 0: The slack is initialized non-basic (if the constraint is binding in the initial point) or super-basic,
• 1: The slack is initialized basic

If inistat == 2: The variable status has the following behaviour:

• 0: The variable is initialized at lower bound
• 1: The variable is initialized at upper bound
• 2: The variable is initialized basic, and
• 3: The variable is initialized superbasic. The slack status has the following behaviour:
• 0: The slack is initialized at lower bound.
• 1: The slack is initialized at upper bound.
• 2: The slack is initialized basic, and
• 3: The slack is initialized superbasic.

Reimplemented from pyconopt.ConoptModelData.

Definition at line 2770 of file pyconopt.py.