Source code for passengersim.transforms.pricing

from __future__ import annotations

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from passengersim import Config



[docs]
def pricing_multiplier(cfg: Config, multiplier: float, *, inplace: bool = False) -> Config:
    """
    Scale fare prices and demand reference prices by a given multiplier.

    Parameters
    ----------
    cfg : Config
        The configuration object containing demands.
    multiplier : float, optional
        The multiplier to apply to the pricing.
    inplace : bool, optional
        Whether to modify the configuration in place or return a modified copy. Default is False.

    Returns
    -------
    Config
        The configuration object with scaled prices.
    """
    if not inplace:
        cfg = cfg.model_copy(deep=True)
    for d in cfg.demands:
        d.reference_price *= multiplier
    for f in cfg.fares:
        f.price *= multiplier
    return cfg