Public Member Functions | Public Attributes

bio_expression::bioLogit Class Reference

Class calculating a logit choice probability. More...

Inheritance diagram for bio_expression::bioLogit:
bio_expression::Expression

List of all members.

Public Member Functions

def __init__
def getExpression

Public Attributes

 prob
 av
 choice
 operatorIndex

Detailed Description

Class calculating a logit choice probability.

Computes the probability given by the logit model, that is

\[ \frac{a_i e^{V_i}}{\sum_{j=1}^{J} a_j e^{V_j}} \]

Example:

 V = {1: V1, 2: V2, 3: V3}
 av = {1: av_1, 2: 1, 3: av_3}
 prob = bioLogit(V,av,CHOICE) 

Constructor & Destructor Documentation

def bio_expression::bioLogit::__init__ (   self,
  util,
  av,
  choice 
)
Parameters:
utildictionary (see Python documentation) containing the utility functions $V_i$.
avdictionary (see Python documentation) containing the availability conditions for each alternative $a_i$ (if 0, alternative is not available, if different from zero, it is available). The number of entries and the labeling must be consistent with utilities.
choiceexpression providing the index of the alternative for which the probability is being computed.

Member Function Documentation

def bio_expression::bioLogit::getExpression (   self )
Returns:
Return the string representation of the current expression

Reimplemented from bio_expression::Expression.


Member Data Documentation

Reimplemented from bio_expression::Expression.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables