Public Member Functions | Public Attributes

bio_expression::Beta Class Reference

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

Inheritance diagram for bio_expression::Beta:
bio_expression::Expression

List of all members.

Public Member Functions

def __init__
def getExpression

Public Attributes

 name
 val
 lb
 ub
 st
 desc
 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:

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

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])

Member Function Documentation

def bio_expression::Beta::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