biogeme.expressions.multiple_sum module

Arithmetic expressions accepted by Biogeme: multiple sum

Michel Bierlaire Sat Sep 9 15:29:36 2023

class biogeme.expressions.multiple_sum.MultipleSum(list_of_expressions)

Bases: Expression

This expression returns the sum of several other expressions.

It is a generalization of ‘Plus’ for more than two terms

Parameters:

list_of_expressions (list[ExpressionOrNumeric] | dict[Any: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:

MultipleSum

get_value()

Evaluates the value of the expression

Returns:

value of the expression

Return type:

float

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]