Interface SpatialTemporalRoutingAlgorithm<E>

Type Parameters:
E - the edge type
All Known Implementing Classes:
Dijkstra
public interface SpatialTemporalRoutingAlgorithm<E>
An algorithm which can find a route between two vertices on an explorable spatial-temporal graph.
Author:
Lee A. Christie

  • Method Summary

    Modifier and Type
    Method
    Description
    <ST,S> List<ST>
    stPath(Explorable<ST,E> graph, ST source, Predicate<ST> target, E maxCost, SpatialTemporalMapping<S,E,ST> stMapping)
    Finds a route from the specified source to the specified target(s) by predicate which returns true if a given vertex is a target, within a given maximum cost.
    <ST,S> List<ST>
    stPath(Explorable<ST,E> graph, ST source, Predicate<ST> target, SpatialTemporalMapping<S,E,ST> stMapping)
    Finds a route from the specified source to the specified target(s) by predicate which returns true if a given vertex is a target.
    <ST,S> List<ST>
    stPath(Explorable<ST,E> graph, ST source, ST target, E maxCost, SpatialTemporalMapping<S,E,ST> stMapping)
    Deprecated, for removal: This API element is subject to removal in a future version.
    <ST,S> List<ST>
    stPath(Explorable<ST,E> graph, ST source, ST target, SpatialTemporalMapping<S,E,ST> stMapping)
    Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • stPath

      @Deprecated(forRemoval=true) <ST,S> List<ST> stPath(Explorable<ST,E> graph, ST source, ST target, SpatialTemporalMapping<S,E,ST> stMapping) throws TargetUnreachableException, InterruptedException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds a route from the specified source to the specified target.
      Type Parameters:
      ST - the type of the spatial-temporal vertex
      S - the type of the spatial component of the vertex
      Parameters:
      graph - the graph on which to route, not null
      source - the source vertex, in graph, not null
      target - the target vertex, in graph, not null
      stMapping - a spatial-temporal mapping
      Returns:
      a list of vertices describing each step in the path
      Throws:
      TargetUnreachableException - if no route could be found from source to target
      InterruptedException - if the thread is interrupted, and the implementation supports interruption

    • stPath

      @Deprecated(forRemoval=true) <ST,S> List<ST> stPath(Explorable<ST,E> graph, ST source, ST target, E maxCost, SpatialTemporalMapping<S,E,ST> stMapping) throws TargetUnreachableException, InterruptedException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds a route from the specified source to the specified target within a given maximum cost.
      Type Parameters:
      ST - the type of the spatial-temporal vertex
      S - the type of the spatial component of the vertex
      Parameters:
      graph - the graph on which to route, not null
      source - the source vertex, in graph, not null
      target - the target vertex, in graph, not null
      maxCost - the maximum cost, considered unlimited if null
      stMapping - a spatial-temporal mapping
      Returns:
      a list of vertices describing each step in the path
      Throws:
      TargetUnreachableException - if no route could be found from source to target
      InterruptedException - if the thread is interrupted, and the implementation supports interruption

    • stPath

      <ST,S> List<ST> stPath(Explorable<ST,E> graph, ST source, Predicate<ST> target, SpatialTemporalMapping<S,E,ST> stMapping) throws TargetUnreachableException, InterruptedException
      Finds a route from the specified source to the specified target(s) by predicate which returns true if a given vertex is a target.
      Type Parameters:
      ST - the type of the spatial-temporal vertex
      S - the type of the spatial component of the vertex
      Parameters:
      graph - the graph on which to route, not null
      source - the source vertex, in graph, not null
      target - the criteria to identify a target vertex, in graph, not null
      stMapping - a spatial-temporal mapping
      Returns:
      a list of vertices describing each step in the path
      Throws:
      TargetUnreachableException - if no route could be found from source to target
      InterruptedException - if the thread is interrupted, and the implementation supports interruption

    • stPath

      <ST,S> List<ST> stPath(Explorable<ST,E> graph, ST source, Predicate<ST> target, E maxCost, SpatialTemporalMapping<S,E,ST> stMapping) throws TargetUnreachableException, InterruptedException
      Finds a route from the specified source to the specified target(s) by predicate which returns true if a given vertex is a target, within a given maximum cost.
      Type Parameters:
      ST - the type of the spatial-temporal vertex
      S - the type of the spatial component of the vertex
      Parameters:
      graph - the graph on which to route, not null
      source - the source vertex, in graph, not null
      target - the target vertex, in graph, not null
      maxCost - the maximum cost, considered unlimited if null
      stMapping - a spatial-temporal mapping
      Returns:
      a list of vertices describing each step in the path
      Throws:
      TargetUnreachableException - if no route could be found from source to target
      InterruptedException - if the thread is interrupted, and the implementation supports interruption