Sparksee  5.2.0
STSTraversal Class Reference

Traversal class. More...

Inheritance diagram for STSTraversal:
Inheritance graph
Collaboration diagram for STSTraversal:
Collaboration graph

Instance Methods

(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.
 
(long long) - next
 Gets the next object of the traversal.
 
(BOOL) - hasNext
 Gets if there are more objects to be traversed.
 
(int) - getCurrentDepth
 Returns the depth of the current node.
 
(void) - setMaximumHops:
 Sets the maximum hops restriction.
 
(void) - close
 Closes the Traversal instance.
 
(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.

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 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.
- (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.
- (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 STSTraversalDFS, and STSTraversalBFS.

- (BOOL) hasNext

Gets if there are more objects to be traversed.

Returns
TRUE if there are more objects, FALSE otherwise.

Implemented in STSTraversalDFS, and STSTraversalBFS.

- (long long) next

Gets the next object of the traversal.

Returns
A node or edge identifier.

Implemented in STSTraversalDFS, and STSTraversalBFS.

- (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: