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

Class representing the cumulative distribution function of the normal distribution. More...

Inheritance diagram for bio_expression.bioNormalCdf:
bio_expression.Expression

Public Member Functions

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

 expression
 
 operatorIndex
 
- Public Attributes inherited from bio_expression.Expression
 operatorIndex
 

Detailed Description

Class representing the cumulative distribution function of the normal distribution.

The CDF of the normal distribution is

\[ \mbox{bioNormalCdf}(x) = \frac{1}{\sqrt{2\pi}}\int_{-\infty}^x \exp\left(\frac{-t^2}{2}\right) dt \]

A typical example is the probability of a binary probit model, which is computed as follows:

1 prob = normalCdf(V1-V2)

Definition at line 575 of file bio_expression.py.

Constructor & Destructor Documentation

def bio_expression.bioNormalCdf.__init__ (   self,
  expression 
)
Parameters
expressionany valid bio_expression

Definition at line 577 of file bio_expression.py.


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