TraversalDFS Class Reference
[Algorithms]

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

Inheritance diagram for TraversalDFS:

Inheritance graph
Collaboration diagram for TraversalDFS:

Collaboration graph

List of all members.

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 sparksee::gdb::int32_t GetCurrentDepth () const
 Returns the depth of the current node.
virtual ~TraversalDFS ()
 Destructor.
 TraversalDFS (sparksee::gdb::Session &s, sparksee::gdb::oid_t node)
 Creates a new instance.
virtual void AddEdgeType (sparksee::gdb::type_t t, sparksee::gdb::EdgesDirection d)
 Allows for traversing edges of the given type.
virtual void AddAllEdgeTypes (sparksee::gdb::EdgesDirection d)
 Allows for traversing all edge types of the graph.
virtual void AddNodeType (sparksee::gdb::type_t t)
 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.

Classes

class  NeighborsInfo
 Store neighbors information.


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

TraversalDFS::TraversalDFS ( sparksee::gdb::Session &  s,
sparksee::gdb::oid_t  node 
)

Creates a new instance.

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


Member Function Documentation

virtual sparksee::gdb::oid_t TraversalDFS::Next (  )  [virtual]

Gets the next object of the traversal.

Returns:
A node or edge identifier.

Implements Traversal.

virtual sparksee::gdb::bool_t TraversalDFS::HasNext (  )  [virtual]

Gets if there are more objects to be traversed.

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

Implements Traversal.

virtual sparksee::gdb::int32_t TraversalDFS::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.

virtual void Traversal::AddEdgeType ( sparksee::gdb::type_t  t,
sparksee::gdb::EdgesDirection  d 
) [virtual, inherited]

Allows for traversing edges of the given type.

Parameters:
t [in] Edge type.
d [in] Edge direction.

virtual void Traversal::AddAllEdgeTypes ( sparksee::gdb::EdgesDirection  d  )  [virtual, inherited]

Allows for traversing all edge types of the graph.

Parameters:
d [in] Edge direction.

virtual void Traversal::ExcludeNodes ( sparksee::gdb::Objects &  nodes  )  [virtual, inherited]

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.

virtual void Traversal::ExcludeEdges ( sparksee::gdb::Objects &  edges  )  [virtual, inherited]

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.

virtual void Traversal::SetMaximumHops ( sparksee::gdb::int32_t  maxhops  )  [virtual, inherited]

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:

Generated on Fri Feb 7 13:10:11 2014 for Sparksee by  doxygen 1.5.6