PathClass¶

class passengersim.core.PathClass¶

Bases: object

PathClass objects

Methods

`__init__`(args, *kwargs)
`add_fare`	Add a Fare to the PathClass
`current_tf_adjusted_fare_price`
`current_tf_raw_adjusted_fare_price`
`get_fcst_revenue`
`get_index`	Get the bucket mapping for one leg.
`initialize_q_forecast`	Initialize the Q-Forecast for this PathClass
`next_departure`	Direct call to CorePathClass::next_departure(), used for unit testing
`set_index`	Set one leg's bucket mapping without changing mappings for other legs.

Attributes

`adjusted_at`	Last forecast adjustment
`adjusted_marginal_revenue`
`booking_class`	Booking class for this PathClass, arbitrary string
`cabin_code`	Cabin Code for this PathClass, arbitrary string
`decision_fare`
`decision_price_rule`	How to determine decision price when using matrix procing or CP.
`fare`
`fare_price`
`fcst_mean`	Forecst mean until departure
`fcst_std_dev`	Standard deviation until departure
`forecast`
`forecast_multiplier`	Multiplier applied to all forecasts on this path-class.
`gt_revenue`	Grand Total revenue, excluding the burn samples
`gt_revenue_by_segment`	Grand total revenue by passenger segment, excluding the burn samples
`gt_sold`	Grand Total sold, excluding the burn samples
`gt_sold_by_segment`	Grand total sold by passenger segment, excluding the burn samples
`gt_sold_priceable`	Grand Total sold priceable, excluding the burn samples
`history`
`identifier`
`num_objects`	Number of objects allocated, was used for memory leak detection
`optimization_price`	Input price to optimization
`optimization_price_vector`	Vector of optimization price by DCP index
`path_id`	Unique integer ID for the Path.
`q_forecast`
`raw_adjusted_marginal_revenue`
`revenue_alpha`
`revenue_by_dcp`	Vector of revenue by DCP index
`sold`	Number sold, is reset after each sample
`sold_by_dcp`	Vector of sold price by DCP index
`sold_priceable`	Number sold priceable, is reset after each sample.
`y_forecast`

add_fare()¶: Add a Fare to the PathClass

adjusted_at¶: Last forecast adjustment

adjusted_marginal_revenue¶

booking_class¶: Booking class for this PathClass, arbitrary string

cabin_code¶: Cabin Code for this PathClass, arbitrary string

current_tf_adjusted_fare_price()¶

current_tf_raw_adjusted_fare_price()¶

decision_fare¶

decision_price_rule¶: How to determine decision price when using matrix procing or CP. ‘weighted’ or ‘lowest’

fare¶

fare_price¶

fcst_mean¶: Forecst mean until departure

fcst_std_dev¶: Standard deviation until departure

forecast¶

forecast_multiplier¶: Multiplier applied to all forecasts on this path-class.

get_fcst_revenue()¶

get_index()¶

Get the bucket mapping for one leg.

Parameters:

leg_number : int: Zero-based leg position in the mapping vector.

Returns:

int – Bucket index for this leg.

Raises:

IndexError – The leg position is negative or outside the mapping vector.

gt_revenue¶: Grand Total revenue, excluding the burn samples

gt_revenue_by_segment¶: Grand total revenue by passenger segment, excluding the burn samples

gt_sold¶: Grand Total sold, excluding the burn samples

gt_sold_by_segment¶: Grand total sold by passenger segment, excluding the burn samples

gt_sold_priceable¶: Grand Total sold priceable, excluding the burn samples

history¶

identifier¶

initialize_q_forecast()¶: Initialize the Q-Forecast for this PathClass

next_departure()¶: Direct call to CorePathClass::next_departure(), used for unit testing

num_objects¶: Number of objects allocated, was used for memory leak detection

optimization_price¶: Input price to optimization

optimization_price_vector¶: Vector of optimization price by DCP index

path_id¶: Unique integer ID for the Path. Can be set by the user, or will be created by the connection generator

q_forecast¶

raw_adjusted_marginal_revenue¶

revenue_alpha¶

revenue_by_dcp¶: Vector of revenue by DCP index

set_index()¶

Set one leg’s bucket mapping without changing mappings for other legs.

Parameters:

leg_number : int: Zero-based leg position. Storage grows as needed; new entries default to zero.
index : int: Nonnegative bucket index for this leg.

Returns:

int – Zero on success.

Raises:

IndexError – Either argument is negative.

sold¶: Number sold, is reset after each sample

sold_by_dcp¶: Vector of sold price by DCP index

sold_priceable¶: Number sold priceable, is reset after each sample. Priceable means that the lowest priced Offer was chosen

y_forecast¶