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

#include <TraversalBFS.h>

Inheritance diagram for TraversalBFS:

Collaboration diagram for TraversalBFS:

Public Member Functions
virtual sparksee::gdb::oid_t	Next ()
	Gets the next object of the traversal.
virtual sparksee::gdb::bool_t	HasNext ()
	Gets if there are more objects to be traversed.
virtual	~TraversalBFS ()
	Destructor.
virtual sparksee::gdb::int32_t	GetCurrentDepth () const
	Returns the depth of the current node.
	TraversalBFS (sparksee::gdb::Session &session, sparksee::gdb::oid_t node)
	Creates a new instance.
virtual void	AddEdgeType (sparksee::gdb::type_t type, sparksee::gdb::EdgesDirection dir)
	Allows for traversing edges of the given type.
virtual void	AddAllEdgeTypes (sparksee::gdb::EdgesDirection dir)
	Allows for traversing all edge types of the graph.
virtual void	AddNodeType (sparksee::gdb::type_t type)
	Allows for traversing nodes of the given type.
virtual void	AddAllNodeTypes ()
	Allows for traversing all node types of the graph.
virtual void	ExcludeNodes (sparksee::gdb::Objects &nodes)
	Set which nodes can't be used.
virtual void	ExcludeEdges (sparksee::gdb::Objects &edges)
	Set which edges can't be used.
virtual void	SetMaximumHops (sparksee::gdb::int32_t maxhops)
	Sets the maximum hops restriction.

Protected Member Functions
void	AssertAddedEdges ()
	Check that edges had been added.
void	AssertAddedNodes ()
	Check that nodes had been added.
void	AssertEdgeType (sparksee::gdb::type_t edgetype)
	Check that the given edge type is valid.
void	AssertNodeType (sparksee::gdb::type_t nodetype)
	Check that the given node type is valid.
sparksee::gdb::bool_t	IsNodeTypeAllowed (sparksee::gdb::oid_t nodeId)
	Check if the given node has an allowed type.
sparksee::gdb::bool_t	IsNodeExcluded (sparksee::gdb::oid_t node)
	Check if the given node is forbidden.
sparksee::gdb::bool_t	IsEdgeExcluded (sparksee::gdb::oid_t edge)
	Check if the given edge is forbidden.

Protected Attributes
sparksee::gdb::Session *	sess
	Session.
sparksee::gdb::Graph *	graph
	Graph.
sparksee::gdb::oid_t	src
	Source node of the traversal.
std::map< sparksee::gdb::type_t, sparksee::gdb::EdgesDirection >	edgeTypes
	Allowed edge types.
std::vector< sparksee::gdb::type_t >	nodeTypes
	Allowed node types.
sparksee::gdb::int32_t	maxHops
	Maximum number of hops allowed.
sparksee::gdb::Objects *	excludedNodes
	The set of excluded nodes.
sparksee::gdb::Objects *	excludedEdges
	The set of excluded edges.

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

◆ TraversalBFS()

TraversalBFS::TraversalBFS	(	sparksee::gdb::Session &	session,
		sparksee::gdb::oid_t	node )

Creates a new instance.

Parameters

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

References TraversalBFS().

Referenced by TraversalBFS().

Member Function Documentation

◆ AddAllEdgeTypes()

virtual void Traversal::AddAllEdgeTypes ( sparksee::gdb::EdgesDirection dir )

virtualinherited

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

Reimplemented in RandomWalk.

◆ AddEdgeType()

virtual void Traversal::AddEdgeType	(	sparksee::gdb::type_t	type,
		sparksee::gdb::EdgesDirection	dir )

virtualinherited

Allows for traversing edges of the given type.

Parameters

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

Reimplemented in RandomWalk.

◆ AddNodeType()

virtual void Traversal::AddNodeType ( sparksee::gdb::type_t type )

virtualinherited

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

Reimplemented in RandomWalk.

◆ ExcludeEdges()

virtual void Traversal::ExcludeEdges ( sparksee::gdb::Objects & edges )

virtualinherited

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 in RandomWalk.

◆ ExcludeNodes()

virtual void Traversal::ExcludeNodes ( sparksee::gdb::Objects & nodes )

virtualinherited

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 in RandomWalk.

◆ GetCurrentDepth()

virtual sparksee::gdb::int32_t TraversalBFS::GetCurrentDepth ( ) const

virtual

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 Traversal.

◆ HasNext()

virtual sparksee::gdb::bool_t TraversalBFS::HasNext ( )

virtual

Gets if there are more objects to be traversed.

Returns: TRUE if there are more objects, FALSE otherwise.

Implements Traversal.

◆ Next()

virtual sparksee::gdb::oid_t TraversalBFS::Next ( )

virtual

Gets the next object of the traversal.

Returns: A node or edge identifier.

Implements Traversal.

◆ SetMaximumHops()

virtual void Traversal::SetMaximumHops ( sparksee::gdb::int32_t maxhops )

virtualinherited

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:

TraversalBFS.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TraversalBFS()

Member Function Documentation

◆ AddAllEdgeTypes()

◆ AddEdgeType()

◆ AddNodeType()

◆ ExcludeEdges()

◆ ExcludeNodes()

◆ GetCurrentDepth()

◆ HasNext()

◆ Next()

◆ SetMaximumHops()