biogeme.expressions.belongs_to module

Arithmetic expressions accepted by Biogeme: belongs to

Michel Bierlaire Sat May 03 2025, 11:56:33

class biogeme.expressions.belongs_to.BelongsTo(child, the_set)

Bases: UnaryOperator

Check if a value belongs to a set

Parameters:

• child (ExpressionOrNumeric)

• the_set (set[float])

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:

BelongsTo

recursive_construct_jax_function(numerically_safe)

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