Biogeme: Python Library  2.5
Public Member Functions | Public Attributes | List of all members
bio_expression.DefineVariable Class Reference

Class representing the definition of a new variable. More...

Inheritance diagram for bio_expression.DefineVariable:
bio_expression.Expression

Public Member Functions

def __init__ (self, name, expression)
 
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

 name
 
 expression
 
 operatorIndex
 
- Public Attributes inherited from bio_expression.Expression
 operatorIndex
 

Detailed Description

Class representing the definition of a new variable.

Defining a new variable is equivalent to add a column to the data file. Note that the expression defining the new variable is computed during the processing of the data file, before the estimation, so that it saves computational time to define variables using this technique. Example:

1 TRAIN_TT_SCALED = DefineVariable('TRAIN_TT_SCALED', TRAIN_TT / 100.0)

will result in a more efficient estimation than the statement:

1 TRAIN_TT_SCALED = TRAIN_TT / 100.0

Definition at line 317 of file bio_expression.py.

Constructor & Destructor Documentation

def bio_expression.DefineVariable.__init__ (   self,
  name,
  expression 
)
Parameters
namename of the variable
expressionexpression to compute the value of the variable

Definition at line 320 of file bio_expression.py.


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