Traversal class. More...
Instance Methods | |
| (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... | |
| (long long) | - next |
| Gets the next object of the traversal. More... | |
| (BOOL) | - hasNext |
| Gets if there are more objects to be traversed. More... | |
| (int) | - getCurrentDepth |
| Returns the depth of the current node. More... | |
| (void) | - setMaximumHops: |
| Sets the maximum hops restriction. More... | |
| (void) | - close |
| Closes the Traversal instance. More... | |
| (BOOL) | - isClosed |
| Check if the Traversal instance is closed. | |
Detailed Description
Traversal class.
Any class implementing this abstract class can be used to traverse a graph.
Once the instance has been created and the allowed node and edge types has been set, it can be used as an iterator, retrieving the next object identifier of the traversal until there are no more.
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.
Implemented in STSRandomWalk.
| - (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.
Implemented in STSRandomWalk.
| - (void) addNodeType: | (int) | type |
Allows for traversing nodes of the given type.
- Parameters
-
type The node type to add
Implemented in STSRandomWalk.
| - (void) close |
Closes the Traversal 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.
Implemented in STSRandomWalk.
| - (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.
Implemented in STSRandomWalk.
| - (int) getCurrentDepth |
Returns the depth of the current node.
That is, it returns the depth of the node returned in the last call to Next().
- Returns
- The depth of the current node.
Implemented in STSRandomWalk, STSTraversalBFS, and STSTraversalDFS.
| - (BOOL) hasNext |
Gets if there are more objects to be traversed.
- Returns
- TRUE if there are more objects, FALSE otherwise.
Implemented in STSRandomWalk, STSTraversalBFS, and STSTraversalDFS.
| - (long long) next |
Gets the next object of the traversal.
- Returns
- A node or edge identifier.
Implemented in STSRandomWalk, STSTraversalBFS, and STSTraversalDFS.
| - (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
