DexNet 4.7.0
Public Member Functions
com::sparsity::dex::algorithms::Traversal Class Reference

Traversal class. More...

Inheritance diagram for com::sparsity::dex::algorithms::Traversal:
Inheritance graph

List of all members.

Public Member Functions

bool HasNext ()
 Gets if there are more objects to be traversed.
void AddEdgeType (int t, com.sparsity.dex.gdb.EdgesDirection d)
 Allows for traversing edges of the given type.
void AddNodeType (int t)
 Allows for traversing nodes of the given type.
int GetCurrentDepth ()
 Returns the depth of the current node.
void ExcludeEdges (com.sparsity.dex.gdb.Objects edges)
 Set which edges can't be used.
boolean IsClosed ()
 Gets if Traversal instance has been closed or not.
void AddAllNodeTypes ()
 Allows for traversing all node types of the graph.
void AddAllEdgeTypes (com.sparsity.dex.gdb.EdgesDirection d)
 Allows for traversing all edge types of the graph.
void Close ()
 Closes the Traversal instance.
void ExcludeNodes (com.sparsity.dex.gdb.Objects nodes)
 Set which nodes can't be used.
long Next ()
 Gets the next object of the traversal.
void SetMaximumHops (int maxhops)
 Sets the maximum hops restriction.

Detailed Description

Traversal class.

Any class implementing this abstract class can be used to traverse a graph.

The user must set which edge types and node types can be used for the traversal. For the edge types, the user may specify how to navigate them:

(i) Just navigate through out-going edges from the current node.

(ii) Just navigate through in-going edges from the current node.

(iii) Navigate through both in-going and out-going edges from the current node.

Once the instance has been created and the allowed node and edge types has been set, it can be used as an iterator, retrieving the next object identifier of the traversal until there are no more.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

void com::sparsity::dex::algorithms::Traversal::AddAllEdgeTypes ( com.sparsity.dex.gdb.EdgesDirection  d)

Allows for traversing all edge types of the graph.

Parameters:
d[in] Edge direction.

Reimplemented in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

void com::sparsity::dex::algorithms::Traversal::AddEdgeType ( int  t,
com.sparsity.dex.gdb.EdgesDirection  d 
)

Allows for traversing edges of the given type.

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

Reimplemented in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

void com::sparsity::dex::algorithms::Traversal::AddNodeType ( int  t)

Allows for traversing nodes of the given type.

Parameters:
tnull

Reimplemented in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

void com::sparsity::dex::algorithms::Traversal::Close ( )

Closes the Traversal instance.

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

void com::sparsity::dex::algorithms::Traversal::ExcludeEdges ( com.sparsity.dex.gdb.Objects  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 in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

void com::sparsity::dex::algorithms::Traversal::ExcludeNodes ( com.sparsity.dex.gdb.Objects  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 in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

int com::sparsity::dex::algorithms::Traversal::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.

Reimplemented in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

bool com::sparsity::dex::algorithms::Traversal::HasNext ( )

Gets if there are more objects to be traversed.

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

Reimplemented in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

boolean com::sparsity::dex::algorithms::Traversal::IsClosed ( )

Gets if Traversal instance has been closed or not.

See also:
Close()
Returns:
TRUE if the Traversal instance has been closed, FALSE otherwise.
long com::sparsity::dex::algorithms::Traversal::Next ( )

Gets the next object of the traversal.

Returns:
A node or edge identifier.

Reimplemented in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.

void com::sparsity::dex::algorithms::Traversal::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.

Reimplemented in com::sparsity::dex::algorithms::TraversalBFS, and com::sparsity::dex::algorithms::TraversalDFS.