sparksee.TraversalDFS Class Reference

Depth-First Search (DFS) implementation of Traversal. More...

Inheritance diagram for sparksee.TraversalDFS:

Collaboration diagram for sparksee.TraversalDFS:

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

Detailed Description

Depth-First Search (DFS) implementation of Traversal.

Starting from a source or root node, it visits as far as possible along each branch before backtracking.

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

__init__()

sparksee.TraversalDFS.__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

__iter__()

sparksee.Traversal.__iter__ ( self )

inherited

Gets a new TraversalIterator.

Returns

TraversalIterator instance

__next__()

sparksee.Traversal.__next__ ( self )

inherited

Return the next item from the container.

If there are no further items, raise the StopIteration exception.

Returns

The next element

add_all_edge_types()

sparksee.TraversalDFS.add_all_edge_types	(		self,
			dir )

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

Reimplemented from sparksee.Traversal.

add_edge_type()

sparksee.TraversalDFS.add_edge_type	(		self,
			type,
			dir )

Allows for traversing edges of the given type.

Parameters

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

Reimplemented from sparksee.Traversal.

add_node_type()

sparksee.TraversalDFS.add_node_type	(		self,
			type )

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

Reimplemented from sparksee.Traversal.

close()

sparksee.Traversal.close ( self )

inherited

Closes the Traversal instance.

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

exclude_edges()

sparksee.TraversalDFS.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.

Reimplemented from sparksee.Traversal.

exclude_nodes()

sparksee.TraversalDFS.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.

Reimplemented from sparksee.Traversal.

get_current_depth()

sparksee.TraversalDFS.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.

Reimplemented from sparksee.Traversal.

has_next()

sparksee.TraversalDFS.has_next

(

self

)

Gets if there are more objects to be traversed.

Returns

TRUE if there are more objects, FALSE otherwise.

Reimplemented from sparksee.Traversal.

is_closed()

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.

next()

sparksee.TraversalDFS.next

(

self

)

Gets the next object of the traversal.

Returns

A node or edge identifier.

Reimplemented from sparksee.Traversal.

set_maximum_hops()

sparksee.TraversalDFS.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.

Reimplemented from sparksee.Traversal.