ShortestPath class. More...
Instance Methods | |
| (void) | - setMaximumHops: |
| Sets the maximum hops restriction. More... | |
| (void) | - addEdgeType:dir: |
| Allows for traversing edges of the given type. More... | |
| (void) | - addAllEdgeTypes: |
| Allows for traversing all edge types of the graph. More... | |
| (void) | - addNodeType: |
| Allows for traversing nodes of the given type. More... | |
| (void) | - addAllNodeTypes |
| Allows for traversing all node types of the graph. | |
| (void) | - excludeNodes: |
| Set which nodes can't be used. More... | |
| (void) | - excludeEdges: |
| Set which edges can't be used. More... | |
| (void) | - run |
| Runs the algorithm. More... | |
| (void) | - close |
| Closes the ShortestPath instance. More... | |
| (BOOL) | - isClosed |
| Check if the ShortestPath instance is closed. | |
Detailed Description
ShortestPath class.
Classes implementing this abstract class solve the shortest path problem in a graph.
The user must set which node and edge types can be used for the traversal.
Check out the 'Algorithms' section in the SPARKSEE User Manual for more details on this.
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
-
type null
| - (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.
| - (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:
- Sparksee.h
