Skip to main contentModule planner
Source - PathPlanner
- Path planner that resolves [
DestinationRouting] to [ResolvedTransportRouting]. - PathPlannerConfig
- Configuration for
PathPlannerβs internal path cache. - WeightingParams π
- Parameters that shape how per-path aggregates modulate the
WeightedCollection weight.
- MIN_SHARE_SHIFT π
- Smallest change in a candidateβs share of the draws that counts as traffic having moved.
- capacity_factor π
- Continuous, monotonically increasing capacity factor, bounded in (0.05, 1.0].
- composite_weight π
- Composite selection weight for a candidate path.
- latency_factor π
- Continuous, monotonically decreasing latency factor, bounded in (0, 1].
- pick_uniform_index π
- Picks a uniformly random index over
len entries. - pick_weighted_index π
- Picks an index into
weights with probability proportional to the weight; None if all are
non-positive. - rebuild_candidates π
- Rebuilds the weighted candidate collection for one
(source, destination, hops) triple from
whatever the graph currently says. - shares_by_route π
- Each candidateβs share of the total weight, keyed by the route it takes.
- should_explore π
- Whether this draw should explore β ignore the weights and pick uniformly.
- temper_weights π
- Flattens
weights by raising each to temper, compressing the spread between good and bad
candidates without reordering them. - validate_unit_interval π
- validate_weight_temper π
- Rejects a temper exponent outside
(0, 1]. - weights_moved π
- Whether re-weighting would send a materially different share of the draws somewhere else.
- PlannerCacheKey π
- Cache key for the path planner:
(source, destination, hops). - PlannerCacheValue π