bio_iterator.iterator Class Reference

Generic class for an iterator. More...

Inheritance diagram for bio_iterator.iterator:

Public Member Functions
def	__init__ (self, iteratorName, name, child, variable)
def	__str__ (self)

Public Attributes
	iteratorName
	name
	child
	variable

Detailed Description

Generic class for an iterator.

Iterators are designed to define loops on the entries of the data file. It is assumed that the data file is composed of rows, each containing the same number of numeric entries. The first row of the file contains the headers, labeling each of these entries. There are three types of iterators:

• row iterators are designed to iterate on rows of the data file. This is the most common type of iterators.
• meta iterators are designed to iterate on group of rows of the data file. They are typically used for panel data, where several rows correspond to the same individual.
• draw iterators are designed to iterate on the data file when user defined draws are generated. Note that this is valid only since biogeme 2.4. Before, this iterator was used for the calculation of the integral itself, together with an Operator Sum.

Hierarchical nesting of iterators is possible, so that iterators may have a parent and a child.

Definition at line 23 of file bio_iterator.py.

---

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

• bio_iterator.py