traveler.demo.tour_mode.simple_choice.utility#

simple_choice.utility(store, *, choosers=None, param=None, debug=False, trace=False)[source]#

Compute utility values for the choice alternatives.

Parameters:

  • store (AbstractStore) – Store containing chooser and supporting model data.

  • choosers (WorkingTable or None, optional) – Choosers to evaluate. When omitted, use the model’s configured table.

  • param (dict[str, float] or None, optional) – Coefficients passed to the utility function. When omitted, use the model’s parameters.

  • debug (bool, optional) – Whether to bypass chunking and JIT compilation.

  • trace (bool, optional) – Whether to request trace information from utility functions that support a with_trace argument.

Returns:

Utility structure returned by the configured utility function.

Return type:

Any