ShortestPath Class Reference
[Algorithms]

ShortestPath class. More...

Inheritance diagram for ShortestPath:

Inheritance graph

List of all members.

Public Member Functions

void SetMaximumHops (sparksee::gdb::int32_t maxhops)
 Sets the maximum hops restriction.
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 Run ()=0
 Runs the algorithm.
virtual ~ShortestPath ()
 Destructor.

Protected Member Functions

 ShortestPath (sparksee::gdb::Session &s)
 Creates a new instance.
void AssertEdgeType (sparksee::gdb::type_t edgetype)
 Check that the given edge type is valid.
void AssertAddedEdges ()
 Check that edges had been added.
void AssertAddedNodes ()
 Check that nodes had been added.
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.
void AssertNotComputed ()
 Check that the shortest path had not been calculated yet.
void AssertComputed ()
 Check that the shortest path had been calculated.
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.
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 hops restriction.
sparksee::gdb::bool_t computed
 True if the shortest path has been calculated.
sparksee::gdb::Objects * excludedNodes
 The set of excluded nodes.
sparksee::gdb::Objects * excludedEdges
 The set of excluded edges.
sparksee::gdb::bool_t areAllNodeTypesAllowed
 True if all the node types are allowed.


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.

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

ShortestPath::ShortestPath ( sparksee::gdb::Session &  s  )  [protected]

Creates a new instance.

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


Member Function Documentation

void ShortestPath::SetMaximumHops ( sparksee::gdb::int32_t  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.

virtual void ShortestPath::AddEdgeType ( sparksee::gdb::type_t  type,
sparksee::gdb::EdgesDirection  dir 
) [virtual]

Allows for traversing edges of the given type.

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

virtual void ShortestPath::AddAllEdgeTypes ( sparksee::gdb::EdgesDirection  dir  )  [virtual]

Allows for traversing all edge types of the graph.

Parameters:
dir [in] Edge direction.

virtual void ShortestPath::ExcludeNodes ( sparksee::gdb::Objects &  nodes  )  [virtual]

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 ShortestPath::ExcludeEdges ( sparksee::gdb::Objects &  edges  )  [virtual]

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 ShortestPath::Run (  )  [pure virtual]

Runs the algorithm.

This method can only be called once.

Implemented in SinglePairShortestPathBFS, and SinglePairShortestPathDijkstra.


Member Data Documentation

Maximum hops restriction.

It must be positive or zero. Zero means unlimited.


The documentation for this class was generated from the following file:

Generated on Fri Sep 12 13:36:41 2014 for Sparksee by  doxygen 1.5.6