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

Class generating the analytical derivative of an expression. More...

Inheritance diagram for bio_expression.Derive:
bio_expression.Expression

Public Member Functions

def __init__ (self, term, v)
 
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

 function
 
 variable
 
 operatorIndex
 
- Public Attributes inherited from bio_expression.Expression
 operatorIndex
 

Detailed Description

Class generating the analytical derivative of an expression.

This class generates the expression for

\[ \frac{\partial f(x)}{\partial x} \]

The computation of derivatives is usually not necessary for estimation, as Biogeme automatically generates the analytical derivatives of the log likelihood function. It is particularly usuful for simulation, to compute the elasticities of complex models. Example: The computation of the elasticity of a model prob with respect to the variable TRAIN_TT, say, is obtained as follows, whatever the model defined by prob:

1 elasticity = Derive(prob,'TRAIN_TT') * TRAIN_TT / prob

Definition at line 814 of file bio_expression.py.

Constructor & Destructor Documentation

def bio_expression.Derive.__init__ (   self,
  term,
  v 
)
Parameters
termany valid bio_expression to derive
vthe variable

Definition at line 817 of file bio_expression.py.


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