biogeme.expressions.elem module

Arithmetic expressions accepted by Biogeme: Elem

Michel Bierlaire Fri Apr 25 2025, 10:33:58

class biogeme.expressions.elem.Elem(dict_of_expressions, key_expression)

Bases: Expression

This returns the element of a dictionary. The key is evaluated from an expression and must return an integer, possibly negative.

Parameters:

• dict_of_expressions (dict[int, ExpressionOrNumeric])

• key_expression (ExpressionOrNumeric)

deep_flat_copy()

Provides a copy of the expression. It is deep in the sense that it generates copies of the children. It is flat in the sense that any MultipleExpression is transformed into the currently selected expression. The flat part is irrelevant for this expression.

Return type:

Elem

dict_of_expressions

dict of expressions

get_value()

Evaluates the value of the expression

Returns:

value of the expression

Return type:

float

Raises:

BiogemeError – if the calculated key is not present in the dictionary.

recursive_construct_jax_function(numerically_safe)

Generates recursively a function to be used by biogeme_jax. Must be overloaded by each expression :rtype: Callable[[Array, Array, Array, Array], array] :return: the function takes two parameters: the parameters, and one row of the database.

Parameters:

numerically_safe (bool)

Return type:

Callable[[Array, Array, Array, Array], array]