Struct TransitionLengths 

pub struct TransitionLengths {
    pub straightline_distance: f64,
    pub route_length: f64,
}

Fields

straightline_distance: f64

The great circle distance between source and target

route_length: f64

The path of the optimal route between candidates

Implementations

impl TransitionLengths

pub fn deviance(&self) -> f64

Calculates the deviance in straightline distance to the length of the entire route. Returns values between 0 and 1. Where values closer to 1 represent more optimal distances, whilst those closer to 0 represent less optimal distances.

The route length is defined as the cumulative distance between nodes in the optimal transition path, plus the offsets into the edges by which the candidates live.

The straightline distance is defined as the haversine (great circle) distance between the two candidates.

Therefore, our deviance is defined as the ratio of straightline distance to the route length, which measures how much farther the actual route was than a virtual path directly between the candidates.

For example:

• If two candidates were 100m apart, but had a most optimal route between them of 130m, the deviance would be ~0.77.
• If two alternate candidates were 100m apart but instead had an optimal route between them of 250m, the deviance is 0.4.

Note that a lower deviance score means the values are less aligned.