Sparksee  5.2.0
STSSinglePairShortestPath Class Reference

SinglePairShortestPath class. More...

Inheritance diagram for STSSinglePairShortestPath:
Inheritance graph
Collaboration diagram for STSSinglePairShortestPath:
Collaboration graph

Instance Methods

(STSOidList *) - getPathAsNodes
 Gets the shortest path between the source node and the destination node as an ordered set of nodes.
 
(STSOidList *) - getPathAsEdges
 Gets the shortest path between the source node and the destination node as an ordered set of edges.
 
(double) - getCost
 Gets the cost of the shortest path.
 
(BOOL) - exists
 Returns TRUE If a path exists or FALSE otherwise.
 
(void) - setMaximumHops:
 Sets the maximum hops restriction.
 
(void) - addEdgeType:dir:
 Allows for traversing edges of the given type.
 
(void) - addAllEdgeTypes:
 Allows for traversing all edge types of the graph.
 
(void) - addNodeType:
 Allows for traversing nodes of the given type.
 
(void) - addAllNodeTypes
 Allows for traversing all node types of the graph.
 
(void) - excludeNodes:
 Set which nodes can't be used.
 
(void) - excludeEdges:
 Set which edges can't be used.
 
(void) - run
 Runs the algorithm.
 
(void) - close
 Closes the ShortestPath instance.
 
(BOOL) - isClosed
 Check if the ShortestPath instance is closed.
 

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

Method Documentation

- (void) addAllEdgeTypes: (enum STSEdgesDirection)  dir

Allows for traversing all edge types of the graph.

Parameters
dir[in] Edge direction.
- (void) addEdgeType: (int)  type
dir: (enum STSEdgesDirection)  dir 

Allows for traversing edges of the given type.

Parameters
type[in] Edge type.
dir[in] Edge direction.
- (void) addNodeType: (int)  type

Allows for traversing nodes of the given type.

Parameters
typenull
- (void) close

Closes the ShortestPath instance.

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

- (void) excludeEdges: (STSObjects *)  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.
- (void) excludeNodes: (STSObjects *)  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.
- (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.

Implemented in STSSinglePairShortestPathDijkstra, and STSSinglePairShortestPathBFS.

- (STSOidList*) 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.

Implemented in STSSinglePairShortestPathDijkstra, and STSSinglePairShortestPathBFS.

- (STSOidList*) 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.

Implemented in STSSinglePairShortestPathDijkstra, and STSSinglePairShortestPathBFS.

- (void) run

Runs the algorithm.

This method can only be called once.

Implemented in STSSinglePairShortestPathDijkstra, and STSSinglePairShortestPathBFS.

- (void) setMaximumHops: (int)  maxhops

Sets the maximum hops restriction.

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

Parameters
maxhops[in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.

The documentation for this class was generated from the following file: