bio_expression.Enumerate Class Reference

Class performing a sample enumeration. More...

Inheritance diagram for bio_expression.Enumerate:

Public Member Functions
def	__init__ (self, term, iteratorName)
def	getExpression (self)
Public Member Functions inherited from bio_expression.Expression
def	__init__ (self)
	Constructor.
def	getExpression (self)
def	getID (self)
def	__str__ (self)
def	__neg__ (self)
def	__add__ (self, expression)
def	__radd__ (self, expression)
def	__sub__ (self, expression)
def	__rsub__ (self, expression)
def	__mul__ (self, expression)
def	__rmul__ (self, expression)
def	__div__ (self, expression)
def	__rdiv__ (self, expression)
def	__truediv__ (self, expression)
	Support for Python version 3.x. More...
def	__rtruediv__ (self, expression)
	Support for Python version 3.x. More...
def	__mod__ (self, expression)
def	__pow__ (self, expression)
def	__rpow__ (self, expression)
def	__and__ (self, expression)
def	__or__ (self, expression)
def	__eq__ (self, expression)
def	__ne__ (self, expression)
def	__le__ (self, expression)
def	__ge__ (self, expression)
def	__lt__ (self, expression)
def	__gt__ (self, expression)

Public Attributes
	theDict
	iteratorName
	operatorIndex
Public Attributes inherited from bio_expression.Expression
	operatorIndex

Detailed Description

Class performing a sample enumeration.

The concept of iterators (see the section "Iterators"), identifies a sequence such that, for each instance, the value of the variables is read from the data file, and an expression can be evaluated. In sample enumeration, expressions are computed for each instance in the sample and reported in a file. Example:

simulate = {'Prob. 1': P1, 'Prob. 2': P2, 'Util. 1': V1, 'Util. 2':V2, 'Diff. util.': V1-V2}
rowIterator('obsIter') 
BIOGEME_OBJECT.SIMULATE = Enumerate(simulate,'obsIter')

Note that this expression is used exclusively for simulation. Contrarily to all other expressions, it does not return any value and, consequently, cannot be included in another expression. Something like

X + Enumerate(V,'obsIter') / 2 

does not make any sense.

Definition at line 1065 of file bio_expression.py.

Constructor & Destructor Documentation

def bio_expression.Enumerate.__init__	(		self,
			term,
			iteratorName
	)

Parameters

term	a dictionary (see Python documentation)) of the form {label: expression, label: expression,...} where label is used to describe the results in the output file, and expression is a valid expression.
iteratorName	name of an iterator already defined.

Definition at line 1073 of file bio_expression.py.

---

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

• bio_expression.py