hrdf_routing_engine/

isochrone.rs

mod circles;
mod constants;
mod contour_line;
pub(crate) mod externals;
mod models;
pub(crate) mod utils;

use std::collections::HashMap;
use std::time::Instant;

use crate::isochrone::utils::haversine_distance;
use crate::routing::Route;
use crate::routing::compute_routes_from_origin;
use crate::utils::compute_remaining_threads;
use constants::WALKING_SPEED_IN_KILOMETERS_PER_HOUR;
use geo::BooleanOps;
use geo::MultiPolygon;
use hrdf_parser::{CoordinateSystem, Coordinates, DataStorage, Hrdf, Stop};
pub use models::DisplayMode as IsochroneDisplayMode;
pub use models::IsochroneMap;

use chrono::{Duration, NaiveDateTime};

use models::Isochrone;
use orx_parallel::*;
use utils::lv95_to_wgs84;
use utils::time_to_distance;

use self::utils::NaiveDateTimeRange;
use self::utils::wgs84_to_lv95;

#[cfg(feature = "hectare")]
#[derive(Clone, Debug)]
pub struct IsochroneHectareArgs {
    /// Departure date and time
    pub departure_at: NaiveDateTime,
    /// Maximum time of the isochrone in minutes
    pub time_limit: Duration,
    /// Maximum number of connections
    pub max_num_explorable_connections: i32,
    /// Number of starting points
    pub num_starting_points: usize,
    /// Verbose on or off
    pub verbose: bool,
}

#[derive(Debug, Clone)]
pub struct IsochroneArgs {
    pub latitude: f64,
    pub longitude: f64,
    pub departure_at: NaiveDateTime,
    pub time_limit: Duration,
    pub interval: Duration,
    pub max_num_explorable_connections: i32,
    pub num_starting_points: usize,
    pub verbose: bool,
}

/// Computes the best isochrone in [departure_at - delta_time; departure_at + delta_time)
/// Best is defined by the maximal surface covered by the largest isochrone
pub fn compute_optimal_isochrones(
    hrdf: &Hrdf,
    excluded_polygons: &MultiPolygon,
    isochrone_args: IsochroneArgs,
    delta_time: Duration,
    display_mode: models::DisplayMode,
    num_threads: usize,
) -> IsochroneMap {
    let IsochroneArgs {
        latitude,
        longitude,
        departure_at,
        time_limit,
        interval: isochrone_interval,
        max_num_explorable_connections,
        num_starting_points,
        verbose,
    } = isochrone_args;

    if verbose {
        log::debug!(
            "longitude: {longitude}, latitude: {latitude}, departure_at: {departure_at}, time_limit: {}, isochrone_interval: {}, delta_time: {}, display_mode: {display_mode:?}, verbose: {verbose}",
            time_limit.num_minutes(),
            isochrone_interval.num_minutes(),
            delta_time.num_minutes(),
        );
    }
    let start_time = Instant::now();
    let min_date_time = departure_at - delta_time;
    let max_date_time = departure_at + delta_time;

    let isochrone_map = NaiveDateTimeRange::new(
        min_date_time + Duration::minutes(1),
        max_date_time,
        Duration::minutes(1),
    )
    .into_iter()
    .collect::<Vec<_>>();
    let num_dates = isochrone_map.len();

    let isochrone_map = isochrone_map
        .into_par()
        .num_threads(num_threads)
        .map(|dep| {
            compute_isochrones(
                hrdf,
                excluded_polygons,
                IsochroneArgs {
                    latitude,
                    longitude,
                    departure_at: dep,
                    time_limit,
                    interval: isochrone_interval,
                    max_num_explorable_connections,
                    num_starting_points,
                    verbose,
                },
                display_mode,
                compute_remaining_threads(num_threads, num_dates),
            )
        })
        .reduce(|lhs, rhs| {
            if lhs.compute_max_area() > rhs.compute_max_area() {
                lhs
            } else {
                rhs
            }
        });

    if verbose {
        log::debug!(
            "Time computing the optimal solution : {:.2?}",
            start_time.elapsed()
        );
    }
    isochrone_map.expect("No isochrone_map found.")
}

/// Computes the worst isochrone in [departure_at - delta_time; departure_at + delta_time)
/// Best is defined by the maximal surface covered by the largest isochrone
#[allow(clippy::too_many_arguments)]
pub fn compute_worst_isochrones(
    hrdf: &Hrdf,
    excluded_polygons: &MultiPolygon,
    isochrone_args: IsochroneArgs,
    delta_time: Duration,
    display_mode: models::DisplayMode,
    num_threads: usize,
) -> IsochroneMap {
    let IsochroneArgs {
        latitude,
        longitude,
        departure_at,
        time_limit,
        interval: isochrone_interval,
        max_num_explorable_connections,
        num_starting_points,
        verbose,
    } = isochrone_args;

    if verbose {
        log::debug!(
            "longitude: {longitude}, latitude: {latitude}, departure_at: {departure_at}, time_limit: {}, isochrone_interval: {}, delta_time: {}, display_mode: {display_mode:?}, verbose: {verbose}",
            time_limit.num_minutes(),
            isochrone_interval.num_minutes(),
            delta_time.num_minutes(),
        );
    }
    let start_time = Instant::now();
    let min_date_time = departure_at - delta_time;
    let max_date_time = departure_at + delta_time;

    let isochrone_map = NaiveDateTimeRange::new(
        min_date_time + Duration::minutes(1),
        max_date_time,
        Duration::minutes(1),
    )
    .into_iter()
    .collect::<Vec<_>>();
    let total_dates = isochrone_map.len();

    let isochrone_map = isochrone_map
        .into_par()
        .num_threads(num_threads)
        .map(|dep| {
            compute_isochrones(
                hrdf,
                excluded_polygons,
                IsochroneArgs {
                    latitude,
                    longitude,
                    departure_at: dep,
                    time_limit,
                    interval: isochrone_interval,
                    max_num_explorable_connections,
                    num_starting_points,
                    verbose,
                },
                display_mode,
                compute_remaining_threads(num_threads, total_dates),
            )
        })
        .reduce(|lhs, rhs| {
            if lhs.compute_max_area() < rhs.compute_max_area() {
                lhs
            } else {
                rhs
            }
        });

    if verbose {
        log::debug!(
            "Time computing the optimal solution : {:.2?}",
            start_time.elapsed()
        );
    }
    isochrone_map.expect("Could not find worst Isochrone Map")
}

/// Computes the average isochrone.
/// The point of origin is used to find the departure stop (the nearest stop).
/// The departure date and time must be within the timetable period.
#[allow(clippy::too_many_arguments)]
pub fn compute_average_isochrones(
    hrdf: &Hrdf,
    excluded_polygons: &MultiPolygon,
    isochrone_args: IsochroneArgs,
    delta_time: Duration,
    num_threads: usize,
) -> IsochroneMap {
    let IsochroneArgs {
        latitude,
        longitude,
        departure_at,
        time_limit,
        interval: isochrone_interval,
        max_num_explorable_connections,
        num_starting_points,
        verbose,
    } = isochrone_args;

    if verbose {
        log::debug!(
            "Computing average isochrone:\n longitude: {longitude}, latitude: {latitude},  departure_at: {departure_at}, time_limit: {}, isochrone_interval: {}, delta_time: {}, verbose: {verbose}",
            time_limit.num_minutes(),
            isochrone_interval.num_minutes(),
            delta_time.num_minutes()
        );
    }
    // If there is no departue stop found we just use the default
    let departure_coord = Coordinates::new(CoordinateSystem::WGS84, longitude, latitude);

    let (easting, northing) = wgs84_to_lv95(latitude, longitude);
    let departure_coord_lv95 = Coordinates::new(CoordinateSystem::LV95, easting, northing);

    let start_time = Instant::now();
    let min_date_time = departure_at - delta_time;
    let max_date_time = departure_at + delta_time;

    let data = NaiveDateTimeRange::new(
        min_date_time + Duration::minutes(1),
        max_date_time,
        Duration::minutes(1),
    )
    .into_iter()
    .collect::<Vec<_>>();

    let num_dates = data.len();

    let data = data
        .par()
        .num_threads(num_threads)
        .map(|dep| {
            let routes = compute_routes_from_origin(
                hrdf,
                latitude,
                longitude,
                *dep,
                time_limit,
                num_starting_points,
                compute_remaining_threads(num_threads, num_dates),
                max_num_explorable_connections,
                verbose,
            );

            unique_coordinates_from_routes(&routes, departure_at)
        })
        .collect::<Vec<_>>();
    let bounding_box = data.iter().fold(
        ((f64::MAX, f64::MAX), (f64::MIN, f64::MIN)),
        |cover_bb, d| {
            let bb = get_bounding_box(d, time_limit);
            let x0 = f64::min(cover_bb.0.0, bb.0.0);
            let x1 = f64::max(cover_bb.1.0, bb.1.0);
            let y0 = f64::min(cover_bb.0.1, bb.0.1);
            let y1 = f64::max(cover_bb.1.1, bb.1.1);
            ((x0, y0), (x1, y1))
        },
    );

    let num_points = 1500;
    let mut grids = data
        .into_iter()
        .map(|d| contour_line::create_grid(&d, bounding_box, time_limit, num_points, num_threads))
        .collect::<Vec<_>>();
    let timesteps = grids.len();
    let grid_ini = grids.pop().expect("Grids was empty");
    let (total_grid, nx, ny, dx) =
        grids
            .into_iter()
            .fold(grid_ini, |(total, nx, ny, dx), (g, _, _, _)| {
                let new_grid = g
                    .into_iter()
                    .zip(total)
                    .map(|((lc, ld), (_, rd))| (lc, (rd + ld)))
                    .collect::<Vec<_>>();
                (new_grid, nx, ny, dx)
            });
    let avg_grid = total_grid
        .into_iter()
        .map(|(c, d)| (c, d / timesteps as i32))
        .collect::<Vec<_>>();
    let isochrone_count = time_limit.num_minutes() / isochrone_interval.num_minutes();
    let isochrones = (0..isochrone_count)
        .map(|i| {
            let current_time_limit = Duration::minutes(isochrone_interval.num_minutes() * (i + 1));

            let polygons = contour_line::get_polygons(
                &avg_grid,
                nx,
                ny,
                bounding_box.0,
                current_time_limit,
                dx,
            );

            let polygons = polygons
                .into_iter()
                .map(|p| p.difference(excluded_polygons))
                .fold(MultiPolygon::new(vec![]), |res, p| res.union(&p));
            Isochrone::new(polygons, current_time_limit.num_minutes() as u32)
        })
        .collect::<Vec<_>>();

    let areas = isochrones.iter().map(|i| i.compute_area()).collect();
    let max_distances = isochrones
        .iter()
        .map(|i| {
            let ((x, y), max) = i.compute_max_distance(departure_coord_lv95);
            let (w_x, w_y) = lv95_to_wgs84(x, y);
            ((w_x, w_y), max)
        })
        .collect();

    if verbose {
        log::debug!(
            "Time for finding the isochrones : {:.2?}",
            start_time.elapsed()
        );
    }
    IsochroneMap::new(
        isochrones,
        areas,
        max_distances,
        departure_coord,
        departure_at,
        convert_bounding_box_to_wgs84(bounding_box),
    )
}

/// Computes the isochrones.
/// The point of origin is used to find the departure stop (the nearest stop).
/// The departure date and time must be within the timetable period.
#[allow(clippy::too_many_arguments)]
pub fn compute_isochrones(
    hrdf: &Hrdf,
    excluded_polygons: &MultiPolygon,
    isochrone_args: IsochroneArgs,
    display_mode: IsochroneDisplayMode,
    num_threads: usize,
) -> IsochroneMap {
    let IsochroneArgs {
        latitude,
        longitude,
        departure_at,
        time_limit,
        interval: isochrone_interval,
        max_num_explorable_connections,
        num_starting_points,
        verbose,
    } = isochrone_args;

    if verbose {
        log::debug!(
            "longitude: {longitude}, latitude : {latitude},  departure_at: {departure_at}, time_limit: {}, isochrone_interval: {}, display_mode: {display_mode:?}, max_num_explorable_connections: {max_num_explorable_connections}, verbose: {verbose}",
            time_limit.num_minutes(),
            isochrone_interval.num_minutes()
        );
    }
    // If there is no departue stop found we just use the default
    let departure_coord = Coordinates::new(CoordinateSystem::WGS84, longitude, latitude);

    let (easting, northing) = wgs84_to_lv95(latitude, longitude);
    let departure_coord_lv95 = Coordinates::new(CoordinateSystem::LV95, easting, northing);

    let start_time = Instant::now();

    let routes = compute_routes_from_origin(
        hrdf,
        latitude,
        longitude,
        departure_at,
        time_limit,
        num_starting_points,
        num_threads,
        max_num_explorable_connections,
        verbose,
    );

    if verbose {
        log::debug!("Time for finding the routes : {:.2?}", start_time.elapsed());
    }

    let start_time = Instant::now();

    // We get only the stop coordinates
    let data = unique_coordinates_from_routes(&routes, departure_at);

    let bounding_box = get_bounding_box(&data, time_limit);
    let num_points = 1500;

    let grid = if display_mode == models::DisplayMode::ContourLine {
        Some(contour_line::create_grid(
            &data,
            bounding_box,
            time_limit,
            num_points,
            num_threads,
        ))
    } else {
        None
    };

    let isochrone_count = time_limit.num_minutes() / isochrone_interval.num_minutes();
    let isochrones = (0..isochrone_count)
        .map(|i| {
            let current_time_limit = Duration::minutes(isochrone_interval.num_minutes() * (i + 1));

            let polygons = match display_mode {
                IsochroneDisplayMode::Circles => {
                    let num_points_circle = 6;
                    circles::get_polygons(&data, current_time_limit, num_points_circle, num_threads)
                }
                IsochroneDisplayMode::ContourLine => {
                    let (grid, num_points_x, num_points_y, dx) = grid.as_ref().unwrap();
                    contour_line::get_polygons(
                        grid,
                        *num_points_x,
                        *num_points_y,
                        bounding_box.0,
                        current_time_limit,
                        *dx,
                    )
                }
            };
            let polygons = polygons
                .into_iter()
                .map(|p| p.difference(excluded_polygons))
                .fold(MultiPolygon::new(vec![]), |res, p| res.union(&p));

            Isochrone::new(polygons, current_time_limit.num_minutes() as u32)
        })
        .collect::<Vec<_>>();

    let areas = isochrones.iter().map(|i| i.compute_area()).collect();
    let max_distances = isochrones
        .iter()
        .map(|i| {
            let ((x, y), max) = i.compute_max_distance(departure_coord_lv95);
            let (w_x, w_y) = lv95_to_wgs84(x, y);
            ((w_x, w_y), max)
        })
        .collect();

    if verbose {
        log::debug!(
            "Time for finding the isochrones : {:.2?}",
            start_time.elapsed()
        );
    }
    IsochroneMap::new(
        isochrones,
        areas,
        max_distances,
        departure_coord,
        departure_at,
        convert_bounding_box_to_wgs84(bounding_box),
    )
}

#[allow(dead_code)]
fn find_nearest_stop(
    data_storage: &DataStorage,
    origin_point_latitude: f64,
    origin_point_longitude: f64,
) -> &Stop {
    data_storage
        .stops()
        .entries()
        .into_iter()
        .filter(|stop| stop.wgs84_coordinates().is_some())
        .min_by(|a, b| {
            let coord_1 = a.wgs84_coordinates().unwrap();
            let distance_1 = haversine_distance(
                origin_point_latitude,
                origin_point_longitude,
                coord_1.latitude().expect("Wrong coordinate system"),
                coord_1.longitude().expect("Wrong coordinate system"),
            );

            let coord_2 = b.wgs84_coordinates().unwrap();
            let distance_2 = haversine_distance(
                origin_point_latitude,
                origin_point_longitude,
                coord_2.latitude().expect("Wrong coordinate system"),
                coord_2.longitude().expect("Wrong coordinate system"),
            );

            distance_1.partial_cmp(&distance_2).unwrap()
        })
        // The stop list cannot be empty.
        .unwrap()
}

/// Each coordinate should be kept only once with the minimum duration associated
fn unique_coordinates_from_routes(
    routes: &[Route],
    departure_at: NaiveDateTime,
) -> Vec<(Coordinates, Duration)> {
    let mut coordinates_duration: HashMap<i32, (Coordinates, chrono::Duration)> = HashMap::new();
    for route in routes {
        let arrival_stop = route.sections().last().expect("Route sections was empty");
        let arrival_stop_id = arrival_stop.arrival_stop_id();
        let arrival_stop_coords = if let Some(c) = arrival_stop.arrival_stop_lv95_coordinates() {
            c
        } else {
            continue;
        };
        let new_duration = route.arrival_at() - departure_at;
        if let Some((_, duration)) = coordinates_duration.get_mut(&arrival_stop_id) {
            // We want the shortest trip duration to be kept only
            if new_duration < *duration {
                *duration = new_duration;
            }
        } else {
            let _ =
                coordinates_duration.insert(arrival_stop_id, (arrival_stop_coords, new_duration));
        }
    }
    coordinates_duration.into_values().collect()
}

fn get_bounding_box(
    data: &[(Coordinates, Duration)],
    time_limit: Duration,
) -> ((f64, f64), (f64, f64)) {
    let min_x = data
        .iter()
        .fold(f64::INFINITY, |result, &(coord, duration)| {
            let candidate = coord.easting().expect("Wrong coordinate system")
                - time_to_distance(time_limit - duration, WALKING_SPEED_IN_KILOMETERS_PER_HOUR);
            f64::min(result, candidate)
        });

    let max_x = data
        .iter()
        .fold(f64::NEG_INFINITY, |result, &(coord, duration)| {
            let candidate = coord.easting().expect("Wrong coordinate system")
                + time_to_distance(time_limit - duration, WALKING_SPEED_IN_KILOMETERS_PER_HOUR);
            f64::max(result, candidate)
        });

    let min_y = data
        .iter()
        .fold(f64::INFINITY, |result, &(coord, duration)| {
            let candidate = coord.northing().expect("Wrong coordinate system")
                - time_to_distance(time_limit - duration, WALKING_SPEED_IN_KILOMETERS_PER_HOUR);
            f64::min(result, candidate)
        });

    let max_y = data
        .iter()
        .fold(f64::NEG_INFINITY, |result, &(coord, duration)| {
            let candidate = coord.northing().expect("Wrong coordinate system")
                + time_to_distance(time_limit - duration, WALKING_SPEED_IN_KILOMETERS_PER_HOUR);
            f64::max(result, candidate)
        });

    ((min_x, min_y), (max_x, max_y))
}

fn convert_bounding_box_to_wgs84(
    bounding_box: ((f64, f64), (f64, f64)),
) -> ((f64, f64), (f64, f64)) {
    (
        lv95_to_wgs84(bounding_box.0.0, bounding_box.0.1),
        lv95_to_wgs84(bounding_box.1.0, bounding_box.1.1),
    )
}