SparkseeNet  5.1.0
Public Member Functions | List of all members
com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra Class Reference

SinglePairShortestPathDijkstra class. More...

Inheritance diagram for com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra:
Inheritance graph
Collaboration diagram for com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra:
Collaboration graph

Public Member Functions

bool Exists ()
 Returns TRUE If a path exists or FALSE otherwise.
 
void AddNodeType (int type)
 Allows for traversing nodes of the given type. More...
 
void ExcludeNodes (com.sparsity.sparksee.gdb.Objects nodes)
 Set which nodes can't be used. More...
 
com.sparsity.sparksee.gdb.OIDList GetPathAsEdges ()
 Gets the shortest path between the source node and the destination node as an ordered set of edges. More...
 
com.sparsity.sparksee.gdb.OIDList GetPathAsNodes ()
 Gets the shortest path between the source node and the destination node as an ordered set of nodes. More...
 
void SetUnweightedEdgeCost (double weight)
 Sets the weight assigned to the unweighted edges. More...
 
void SetMaximumHops (int maxhops)
 Sets the maximum hops restriction. More...
 
void AddAllEdgeTypes (com.sparsity.sparksee.gdb.EdgesDirection dir)
 Allows for traversing all edge types of the graph. More...
 
double GetCost ()
 Gets the cost of the shortest path. More...
 
 SinglePairShortestPathDijkstra (com.sparsity.sparksee.gdb.Session session, long src, long dst)
 Creates a new instance. More...
 
void AddWeightedEdgeType (int type, com.sparsity.sparksee.gdb.EdgesDirection dir, int attr)
 Allows for traversing edges of the given type using the given attribute as the weight. More...
 
void AddAllNodeTypes ()
 Allows for traversing all node types of the graph.
 
void AddEdgeType (int type, com.sparsity.sparksee.gdb.EdgesDirection dir)
 Allows for traversing edges of the given type. More...
 
void Run ()
 Executes the algorithm.
 
void ExcludeEdges (com.sparsity.sparksee.gdb.Objects edges)
 Set which edges can't be used. More...
 
boolean IsClosed ()
 Gets if ShortestPath instance has been closed or not. More...
 
void Close ()
 Closes the ShortestPath instance. More...
 

Detailed Description

SinglePairShortestPathDijkstra class.

It solves the single-pair shortest path problem using a Dijkstra-based implementation.

It is a weighted algorithm, so it takes into account the cost of the edges to compute a minimum-cost shortest path. That is, the user may set for each edge type which attribute should be used to retrieve the cost of the edge. If no attribute is given for an edge type, this will assume the edge has a fixed cost (the default is 1). Only numerical attribute can be set as weight attributes (that is Long, Integer or Double attributes are allowed).

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

com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.SinglePairShortestPathDijkstra ( com.sparsity.sparksee.gdb.Session  session,
long  src,
long  dst 
)

Creates a new instance.

Parameters
session[in] Session to get the graph from and perform traversal.
src[in] Source node.
dst[dst] Destination node.

Member Function Documentation

void com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.AddAllEdgeTypes ( com.sparsity.sparksee.gdb.EdgesDirection  dir)

Allows for traversing all edge types of the graph.

Parameters
dir[in] Edge direction.
void com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.AddEdgeType ( int  type,
com.sparsity.sparksee.gdb.EdgesDirection  dir 
)

Allows for traversing edges of the given type.

Parameters
type[in] Edge type.
dir[in] Edge direction.
void com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.AddNodeType ( int  type)

Allows for traversing nodes of the given type.

Parameters
typenull
void com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.AddWeightedEdgeType ( int  type,
com.sparsity.sparksee.gdb.EdgesDirection  dir,
int  attr 
)

Allows for traversing edges of the given type using the given attribute as the weight.

Parameters
type[in] Edge type.
dir[in] Edge direction.
attr[in] Attribute to be used as the weight. It must be a global attribute or an attribute of the given edge type.
void com.sparsity.sparksee.algorithms.ShortestPath.Close ( )
inherited

Closes the ShortestPath instance.

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

void com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.ExcludeEdges ( com.sparsity.sparksee.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.
void com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.ExcludeNodes ( com.sparsity.sparksee.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.
double com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.GetCost ( )

Gets the cost of the shortest path.

The cost is the sum of the weights of the edges in the shortest path.

Returns
The cost of the shortest path.
com.sparsity.sparksee.gdb.OIDList com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.GetPathAsEdges ( )

Gets the shortest path between the source node and the destination node as an ordered set of edges.

Returns
Ordered set of edge identifiers.
com.sparsity.sparksee.gdb.OIDList com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.GetPathAsNodes ( )

Gets the shortest path between the source node and the destination node as an ordered set of nodes.

Returns
Ordered set of node identifiers.
boolean com.sparsity.sparksee.algorithms.ShortestPath.IsClosed ( )
inherited

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.sparksee.algorithms.SinglePairShortestPathDijkstra.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.
void com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstra.SetUnweightedEdgeCost ( double  weight)

Sets the weight assigned to the unweighted edges.

All the edges from the types added without an explicit weight attribute will get this weight. The default weight for this edges is 1.

Parameters
weight[in] The weight value for unweighted edges.