Biogeme: Python Library  2.5
Public Member Functions | List of all members
bio_iterator.drawIterator Class Reference

Iterates on the data file for generate the user defined draws (since biogeme 2.4) More...

Inheritance diagram for bio_iterator.drawIterator:
bio_iterator.iterator

Public Member Functions

def __init__ (self, iteratorName, name="__dataFile__", child="", variable="__rowId__")
 
- Public Member Functions inherited from bio_iterator.iterator
def __init__ (self, iteratorName, name, child, variable)
 
def __str__ (self)
 

Additional Inherited Members

- Public Attributes inherited from bio_iterator.iterator
 iteratorName
 
 name
 
 child
 
 variable
 

Detailed Description

Iterates on the data file for generate the user defined draws (since biogeme 2.4)

It is typically used with the DefineDraws expression to generate user defined draws. Typical usage:

1 drawIterator('drawIter')
2 TRIANG = DefineDraws('TRIANG', 0.5 * (bioDraws('BUNIF1')+bioDraws('BUNIF2')),'drawIter')

Definition at line 45 of file bio_iterator.py.

Constructor & Destructor Documentation

def bio_iterator.drawIterator.__init__ (   self,
  iteratorName,
  name = "__dataFile__",
  child = "",
  variable = "__rowId__" 
)
Parameters
iteratorNameName of the iterator.
nameName of the set of data that is being iterated. It is typically ignored for draw iterators. Use the default value.
childDraw iterators have no children. Use the default value.
variableVariable that contains the ID of the individuals in the data file. A different draw is generated for each different value of this variable.

Definition at line 50 of file bio_iterator.py.


The documentation for this class was generated from the following file:
Copyright 2016 Michel Bierlaire