SinglePairShortestPathBFS class. More...
Instance Methods | |
| (void) | - run |
| Executes the algorithm. | |
| (STSOidList *) | - getPathAsNodes |
| Gets the shortest path between the source node and the destination node as an ordered set of nodes. More... | |
| (STSOidList *) | - getPathAsEdges |
| Gets the shortest path between the source node and the destination node as an ordered set of edges. More... | |
| (double) | - getCost |
| Gets the cost of the shortest path. More... | |
| (id) | - initWithSession:src:dst: |
| Creates a new instance. More... | |
| (void) | - checkOnlyExistence |
| Set that only the path existence must be calculated and not the path itself. More... | |
| (BOOL) | - exists |
| Returns TRUE If a path exists or FALSE otherwise. | |
| (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) | - close |
| Closes the ShortestPath instance. More... | |
| (BOOL) | - isClosed |
| Check if the ShortestPath instance is closed. | |
Detailed Description
SinglePairShortestPathBFS class.
It solves the single-pair shortest path problem using a BFS-based implementation.
It is a unweighted algorithm, that is it assumes all edges have the same cost.
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) checkOnlyExistence |
Set that only the path existence must be calculated and not the path itself.
That method should improve the performance of the algorithm, but a call to GetPathAsNodes or GetPathAsEdges will generate an exception even if the path exists.
| - (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 is the number of hops of the shortest path.
- Returns
- The cost of the shortest path.
Implements STSSinglePairShortestPath.
| - (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.
Implements STSSinglePairShortestPath.
| - (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.
Implements STSSinglePairShortestPath.
| - (id) initWithSession: | (STSSession *) | session | |
| src: | (long long) | src | |
| dst: | (long long) | dst | |
Creates a new instance.
- Parameters
-
session [in] Session to get the graph from and perform traversal. src [in] Source node. dst [dst] Destination node.
| - (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
