Sparksee  5.2.0
STSTraversalBFS Class Reference

Breadth-First Search implementation of Traversal. More...

Inheritance diagram for STSTraversalBFS:
Inheritance graph
Collaboration diagram for STSTraversalBFS:
Collaboration graph

Instance Methods

(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.
 
(id) - initWithSession:node:
 Creates a new instance.
 
(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) - setMaximumHops:
 Sets the maximum hops restriction.
 
(void) - close
 Closes the Traversal instance.
 
(BOOL) - isClosed
 Check if the Traversal instance is closed.
 

Detailed Description

Breadth-First Search implementation of Traversal.

Starting from a source node, it visits all its neighbors at distance 1, then all its neighbors at distance 2, and so on.

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.

Implements STSTraversal.

- (BOOL) hasNext

Gets if there are more objects to be traversed.

Returns
TRUE if there are more objects, FALSE otherwise.

Implements STSTraversal.

- (id) initWithSession: (STSSession *)  session
node: (long long)  node 

Creates a new instance.

Parameters
session[in] Session to get the graph from and perform traversal.
node[in] Node to start traversal from.
- (long long) next

Gets the next object of the traversal.

Returns
A node or edge identifier.

Implements STSTraversal.

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