set_demand_reference_prices¶

passengersim.transforms.demands.set_demand_reference_prices(cfg: Config, mult_on_lowest_price: float = 1.0, *, inplace: bool = False, force: bool = False) → Config[source]¶

Set reference prices on all demands equal to a multiple of the lowest price in the market.

Parameters:

cfg : Config¶

mult_on_lowest_price : float¶

inplace : bool, default False¶

Modify the configuration in place if True, otherwise return a modified copy.

force : bool, default False¶

If True, set reference prices regardless of their current values. If False, raise an error if existing reference prices are not already some consistent multiple of the lowest price. Normally we will not want to globally manipulate the existing reference prices according to a homogenous algorithm if they have been set heterogeneously by some other mechanism.

Returns:

Config

Raises:

ValueError – If the existing reference prices are not consistent across segments.