pyconopt.Variable Class Reference

the variable data More...

Public Member Functions
	__init__ (self, idx, low, up, cur=0, varstat=-1)
	init(Variable self, int idx, double low, double up, double cur=0, int varstat=-1) -> Variable
	addNonzero (self, conindex, value, nlflag)
	adds a non-zero to the variable data
	sortNonzeros (self)
	sorts the non-zeros by constraint index.

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	index = property(libconopt4_python.Variable_index_get, libconopt4_python.Variable_index_set, doc=)
	lower = property(libconopt4_python.Variable_lower_get, libconopt4_python.Variable_lower_set, doc=)
	upper = property(libconopt4_python.Variable_upper_get, libconopt4_python.Variable_upper_set, doc=)
	curr = property(libconopt4_python.Variable_curr_get, libconopt4_python.Variable_curr_set, doc=)
	varstatus = property(libconopt4_python.Variable_varstatus_get, libconopt4_python.Variable_varstatus_set, doc=)
	consindex_ = property(libconopt4_python.Variable_consindex__get, libconopt4_python.Variable_consindex__set, doc=)
	value_ = property(libconopt4_python.Variable_value__get, libconopt4_python.Variable_value__set, doc=)
	nlflag_ = property(libconopt4_python.Variable_nlflag__get, libconopt4_python.Variable_nlflag__set, doc=)
	sortorder_ = property(libconopt4_python.Variable_sortorder__get, libconopt4_python.Variable_sortorder__set, doc=)

Detailed Description

the variable data

This struct is used internally for supplying the variable data to CONOPT. The user is able to query this data from the ConoptModelData object. However, the user is not able to change the data after the variable has been added to CONOPT.

Definition at line 1857 of file pyconopt.py.

Constructor & Destructor Documentation

__init__()

pyconopt.Variable.__init__	(		self,
			idx,
			low,
			up,
			cur = 0,
			varstat = -1 )

init(Variable self, int idx, double low, double up, double cur=0, int varstat=-1) -> Variable

Parameters

idx: int low: double up: double cur: double varstat: int

Definition at line 1872 of file pyconopt.py.

Member Function Documentation

addNonzero()

pyconopt.Variable.addNonzero	(		self,
			conindex,
			value,
			nlflag )

adds a non-zero to the variable data

Notes: this is used internally.

Definition at line 1887 of file pyconopt.py.

sortNonzeros()

pyconopt.Variable.sortNonzeros

(

self

)

sorts the non-zeros by constraint index.

Notes: this is used internally.

Definition at line 1895 of file pyconopt.py.

Property Documentation

thisown

pyconopt.Variable.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 1869 of file pyconopt.py.

index

pyconopt.Variable.index = property(libconopt4_python.Variable_index_get, libconopt4_python.Variable_index_set, doc=)

static

Definition at line 1902 of file pyconopt.py.

lower

pyconopt.Variable.lower = property(libconopt4_python.Variable_lower_get, libconopt4_python.Variable_lower_set, doc=)

static

Definition at line 1903 of file pyconopt.py.

upper

pyconopt.Variable.upper = property(libconopt4_python.Variable_upper_get, libconopt4_python.Variable_upper_set, doc=)

static

Definition at line 1904 of file pyconopt.py.

curr

pyconopt.Variable.curr = property(libconopt4_python.Variable_curr_get, libconopt4_python.Variable_curr_set, doc=)

static

Definition at line 1905 of file pyconopt.py.

varstatus

pyconopt.Variable.varstatus = property(libconopt4_python.Variable_varstatus_get, libconopt4_python.Variable_varstatus_set, doc=)

static

Definition at line 1906 of file pyconopt.py.

consindex_

pyconopt.Variable.consindex_ = property(libconopt4_python.Variable_consindex__get, libconopt4_python.Variable_consindex__set, doc=)

static

Definition at line 1907 of file pyconopt.py.

value_

pyconopt.Variable.value_ = property(libconopt4_python.Variable_value__get, libconopt4_python.Variable_value__set, doc=)

static

Definition at line 1908 of file pyconopt.py.

nlflag_

pyconopt.Variable.nlflag_ = property(libconopt4_python.Variable_nlflag__get, libconopt4_python.Variable_nlflag__set, doc=)

static

Definition at line 1909 of file pyconopt.py.

sortorder_

pyconopt.Variable.sortorder_ = property(libconopt4_python.Variable_sortorder__get, libconopt4_python.Variable_sortorder__set, doc=)

static

Definition at line 1910 of file pyconopt.py.

---

The documentation for this class was generated from the following file:

• /builds/devel/conopt/conopt/build/lib/pyconopt.py