sparksee.SinglePairShortestPath Class Reference

SinglePairShortestPath class. More...

Inheritance diagram for sparksee.SinglePairShortestPath:

Inheritance graph
Collaboration diagram for sparksee.SinglePairShortestPath:

Collaboration graph

List of all members.

Public Member Functions

def exists
 Returns TRUE If a path exists or FALSE otherwise.
def add_edge_type
 Allows for traversing edges of the given type.
def exclude_nodes
 Set which nodes can't be used.
def run
 Runs the algorithm.
def add_all_edge_types
 Allows for traversing all edge types of the graph.
def add_node_type
 Allows for traversing nodes of the given type.
def get_path_as_edges
 Gets the shortest path between the source node and the destination node as an ordered set of edges.
def set_maximum_hops
 Sets the maximum hops restriction.
def add_all_node_types
 Allows for traversing all node types of the graph.
def get_cost
 Gets the cost of the shortest path.
def get_path_as_nodes
 Gets the shortest path between the source node and the destination node as an ordered set of nodes.
def exclude_edges
 Set which edges can't be used.
def is_closed
 Gets if ShortestPath has been closed or not.
def close
 Closes the ShortestPath instance.


Detailed Description

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

Member Function Documentation

def sparksee.SinglePairShortestPath.add_edge_type (   self,
  t,
  d 
)

Allows for traversing edges of the given type.

Parameters:
t [in] Edge type.
d [in] Edge direction.

Reimplemented from sparksee.ShortestPath.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.exclude_nodes (   self,
  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.

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

Reimplemented from sparksee.ShortestPath.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.run (   self  ) 

Runs the algorithm.

This method can only be called once.

Reimplemented from sparksee.ShortestPath.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.add_all_edge_types (   self,
  d 
)

Allows for traversing all edge types of the graph.

Parameters:
d [in] Edge direction.

Reimplemented from sparksee.ShortestPath.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.add_node_type (   self,
  t 
)

Allows for traversing nodes of the given type.

Parameters:
t null

Reimplemented from sparksee.ShortestPath.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.get_path_as_edges (   self  ) 

Gets the shortest path between the source node and the destination node as an ordered set of edges.

Returns:
Ordered set of edge identifiers.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.set_maximum_hops (   self,
  maxhops 
)

Sets the maximum hops restriction.

All paths longer than the maximum hops restriction will be ignored. m[in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.

Parameters:
maxhops null

Reimplemented from sparksee.ShortestPath.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.get_cost (   self  ) 

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.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.get_path_as_nodes (   self  ) 

Gets the shortest path between the source node and the destination node as an ordered set of nodes.

Returns:
Ordered set of node identifiers.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.SinglePairShortestPath.exclude_edges (   self,
  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.

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

Reimplemented from sparksee.ShortestPath.

Reimplemented in sparksee.SinglePairShortestPathBFS, and sparksee.SinglePairShortestPathDijkstra.

def sparksee.ShortestPath.is_closed (   self  )  [inherited]

Gets if ShortestPath has been closed or not.

See also:
close()
Returns:
TRUE if the ShortestPath instance has been closed, FALSE otherwise.

def sparksee.ShortestPath.close (   self  )  [inherited]

Closes the ShortestPath instance.

It must be called to ensure the integrity of all data.


Generated on Fri Feb 7 13:22:13 2014 for SparkseePython by  doxygen 1.5.6