Class SinglePairShortestPath

java.lang.Object
com.sparsity.sparksee.algorithms.ShortestPath
com.sparsity.sparksee.algorithms.SinglePairShortestPath
All Implemented Interfaces:
Closeable, AutoCloseable
Direct Known Subclasses:
SinglePairShortestPathBFS, SinglePairShortestPathDijkstra
public class SinglePairShortestPath extends ShortestPath
SinglePairShortestPath class.

Classes implementing this abstract class solve the shortest path problem in a graph from a given source node and to a given destination node.

Check out the 'Algorithms' section in the SPARKSEE User Manual for more details on this.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

  • Method Details

    • run

      public void run()
      Runs the algorithm.

      This method can only be called once.

      Overrides:
      run in class ShortestPath

    • excludeNodes

      public void excludeNodes(Objects nodes)
      Set which nodes can't be used.

      This will replace any previously specified set of excluded nodes. Should only be used to exclude the usage of specific nodes from allowed node types because it's less efficient than not allowing a node type.

      Overrides:
      excludeNodes in class ShortestPath
      Parameters:
      nodes - [in] A set of node identifiers that must be kept intact until the destruction of the class.

    • addAllEdgeTypes

      public void addAllEdgeTypes(EdgesDirection dir)
      Allows for traversing all edge types of the graph.

      Overrides:
      addAllEdgeTypes in class ShortestPath
      Parameters:
      dir - [in] Edge direction.

    • excludeEdges

      public void excludeEdges(Objects edges)
      Set which edges can't be used.

      This will replace any previously specified set of excluded edges. Should only be used to exclude the usage of specific edges from allowed edge types because it's less efficient than not allowing an edge type.

      Overrides:
      excludeEdges in class ShortestPath
      Parameters:
      edges - [in] A set of edge identifiers that must be kept intact until the destruction of the class.

    • addEdgeType

      public void addEdgeType(int type, EdgesDirection dir)
      Allows for traversing edges of the given type.

      Overrides:
      addEdgeType in class ShortestPath
      Parameters:
      type - [in] Edge type.
      dir - [in] Edge direction.

    • getPathAsNodes

      public OIDList getPathAsNodes()
      Gets the shortest path between the source node and the destination node as an ordered set of nodes.

      Returns:
      Ordered set of node identifiers.

    • getPathAsEdges

      public OIDList getPathAsEdges()
      Gets the shortest path between the source node and the destination node as an ordered set of edges.

      Returns:
      Ordered set of edge identifiers.

    • addNodeType

      public void addNodeType(int type)
      Allows for traversing nodes of the given type.

      Overrides:
      addNodeType in class ShortestPath
      Parameters:
      type - null

    • exists

      public boolean exists()
      Returns TRUE If a path exists or FALSE otherwise.

    • getCost

      public double getCost()
      Gets the cost of the shortest path.

      The cost for unweighted algorithms is the number of hops of the shortest path. For weighted algoritms, the cost is the sum of the costs of the edges of the shortest path.

      Returns:
      The cost of the shortest path.

    • setMaximumHops

      public void setMaximumHops(int maxhops)
      Sets the maximum hops restriction.

      All paths longer than the maximum hops restriction will be ignored.

      Overrides:
      setMaximumHops in class ShortestPath
      Parameters:
      maxhops - [in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.

    • addAllNodeTypes

      public void addAllNodeTypes()
      Allows for traversing all node types of the graph.

      Overrides:
      addAllNodeTypes in class ShortestPath