biogeme.expressions.elementary_expressions module

Arithmetic expressions accepted by Biogeme: elementary expressions

Michel Bierlaire Tue Mar 25 17:34:47 2025

class biogeme.expressions.elementary_expressions.Elementary(name)[source]

Bases: Expression

Elementary expression.

It is typically defined by a name appearing in an expression. It can be a variable (from the database), or a parameter (fixed or to be estimated using maximum likelihood), a random variable for numerical integration, or Monte-Carlo integration.

Parameters:

name (str)

expression_type = None
get_elementary_expression(name)[source]
Returns:

an elementary expression from its name if it appears in the expression. None otherwise.

Return type:

biogeme.Expression

Parameters:

name (str)

name

The index should be unique for all elementary expressions appearing in a given set of formulas.

rename_elementary(old_name, new_name, elementary_type)[source]

Rename an elementary expression :rtype: int :return: number of modifications actually performed

Parameters:
Return type:

int

set_specific_id(name, specific_id, the_type)[source]

The elementary IDs identify the position of each element in the corresponding datab

Parameters:

the_type (TypeOfElementaryExpression)