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

Class representing a parameter to be estimated. More...

Inheritance diagram for bio_expression.Beta:
bio_expression.Expression

Public Member Functions

def __init__ (self, name, value, lowerbound, upperbound, status, desc='')
 
def getExpression (self)
 
def getID (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
 
 val
 
 lb
 
 ub
 
 st
 
 desc
 
 operatorIndex
 
- Public Attributes inherited from bio_expression.Expression
 operatorIndex
 

Detailed Description

Class representing a parameter to be estimated.

It is highly recommended to use the same name as an argument as the name of the python variable on the left of the equal sign. Indeed, Biogeme has no access to the name of the python variable, and the report will use only the name provided as an argument. Example:

1 beta = Beta( 'beta', 0.0, -10000, 10000, 0)

Definition at line 359 of file bio_expression.py.

Constructor & Destructor Documentation

def bio_expression.Beta.__init__ (   self,
  name,
  value,
  lowerbound,
  upperbound,
  status,
  desc = '' 
)
Parameters
namename of the parameter
valuestarting value of the parameter
lowerboundminimum value that the parameter can take
upperboundmaximum value that the parameter can take
status0 if the parameter must be estimated, 1 if the starting value is maintained
desctext used in the LaTeX output file (optional, default value:'' [empty string])

Definition at line 366 of file bio_expression.py.


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