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

ShortestPath class. More...

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

List of all members.

Public Member Functions

boolean IsClosed ()
 Gets if ShortestPath instance has been closed or not.
void AddAllNodeTypes ()
 Allows for traversing all node types of the graph.
void Close ()
 Closes the ShortestPath instance.
void AddAllEdgeTypes (com.sparsity.dex.gdb.EdgesDirection d)
 Allows for traversing all edge types of the graph.
void Run ()
 Runs the algorithm.
void ExcludeNodes (com.sparsity.dex.gdb.Objects nodes)
 Set which nodes can't be used.
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.
void SetMaximumHops (int maxhops)
 Sets the maximum hops restriction.
void ExcludeEdges (com.sparsity.dex.gdb.Objects edges)
 Set which edges can't be used.

Detailed Description

ShortestPath class.

Classes implementing this abstract class solve the shortest path problem in a graph.

The user must set which node and edge 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.

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

Member Function Documentation

void com::sparsity::dex::algorithms::ShortestPath::AddAllEdgeTypes ( com.sparsity.dex.gdb.EdgesDirection  d)
void com::sparsity::dex::algorithms::ShortestPath::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::SinglePairShortestPath, com::sparsity::dex::algorithms::SinglePairShortestPathBFS, and com::sparsity::dex::algorithms::SinglePairShortestPathDijkstra.

void com::sparsity::dex::algorithms::ShortestPath::AddNodeType ( int  t)
void com::sparsity::dex::algorithms::ShortestPath::Close ( )

Closes the ShortestPath instance.

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

void com::sparsity::dex::algorithms::ShortestPath::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::SinglePairShortestPath, com::sparsity::dex::algorithms::SinglePairShortestPathBFS, and com::sparsity::dex::algorithms::SinglePairShortestPathDijkstra.

void com::sparsity::dex::algorithms::ShortestPath::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::SinglePairShortestPath, com::sparsity::dex::algorithms::SinglePairShortestPathBFS, and com::sparsity::dex::algorithms::SinglePairShortestPathDijkstra.

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

Gets if ShortestPath instance has been closed or not.

See also:
Close()
Returns:
TRUE if the ShortestPath instance has been closed, FALSE otherwise.
void com::sparsity::dex::algorithms::ShortestPath::Run ( )
void com::sparsity::dex::algorithms::ShortestPath::SetMaximumHops ( int  maxhops)

Sets the maximum hops restriction.

All paths longer than the maximum hops restriction will be ignored. m[in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.

Parameters:
maxhopsnull

Reimplemented in com::sparsity::dex::algorithms::SinglePairShortestPath, com::sparsity::dex::algorithms::SinglePairShortestPathBFS, and com::sparsity::dex::algorithms::SinglePairShortestPathDijkstra.