sparksee.TraversalBFS Class Reference

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

Inheritance diagram for sparksee.TraversalBFS:

Collaboration diagram for sparksee.TraversalBFS:

Public Member Functions
def	add_edge_type (self, type, dir)
	Allows for traversing edges of the given type. More...
def	exclude_nodes (self, nodes)
	Set which nodes can't be used. More...
def	add_all_edge_types (self, dir)
	Allows for traversing all edge types of the graph. More...
def	add_node_type (self, type)
	Allows for traversing nodes of the given type. More...
def	exclude_edges (self, edges)
	Set which edges can't be used. More...
def	next (self)
	Gets the next object of the traversal. More...
def	has_next (self)
	Gets if there are more objects to be traversed. More...
def	get_current_depth (self)
	Returns the depth of the current node. More...
def	__init__ (self, session, node)
	Creates a new instance. More...
def	add_all_node_types (self)
	Allows for traversing all node types of the graph.
def	set_maximum_hops (self, maxhops)
	Sets the maximum hops restriction. More...
def	__iter__ (self)
	Gets a new TraversalIterator. More...
def	__next__ (self)
	Used in next() More...
def	close (self)
	Closes the Traversal instance. More...
def	is_closed (self)
	Gets if Traversal has been closed or not. More...

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

Constructor & Destructor Documentation

def sparksee.TraversalBFS.__init__	(		self,
			session,
			node
	)

Creates a new instance.

Parameters

session	[in] Session to get the graph from and perform traversal.
node	[in] Node to start traversal from.

Member Function Documentation

def sparksee.Traversal.__iter__ (   self )

inherited

Gets a new TraversalIterator.

Returns

TraversalIterator instance

def sparksee.Traversal.__next__ (   self )

inherited

Used in next()

Returns

The next element

def sparksee.TraversalBFS.add_all_edge_types	(		self,
			dir
	)

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

def sparksee.TraversalBFS.add_edge_type	(		self,
			type,
			dir
	)

Allows for traversing edges of the given type.

Parameters

type	[in] Edge type.
dir	[in] Edge direction.

def sparksee.TraversalBFS.add_node_type	(		self,
			type
	)

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

def sparksee.Traversal.close (   self )

inherited

Closes the Traversal instance.

It must be called to ensure the integrity of all data.

def sparksee.TraversalBFS.exclude_edges	(		self,
			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.

def sparksee.TraversalBFS.exclude_nodes	(		self,
			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.

def sparksee.TraversalBFS.get_current_depth

(

self

)

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.

def sparksee.TraversalBFS.has_next

(

self

)

Gets if there are more objects to be traversed.

Returns

TRUE if there are more objects, FALSE otherwise.

def sparksee.Traversal.is_closed (   self )

inherited

Gets if Traversal has been closed or not.

See also

close()

Returns

TRUE if the Traversal instance has been closed, FALSE otherwise.

def sparksee.TraversalBFS.next

(

self

)

Gets the next object of the traversal.

Returns

A node or edge identifier.

def sparksee.TraversalBFS.set_maximum_hops	(		self,
			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.