com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS Class Reference

SinglePairShortestPathBFS class. More...

Inheritance diagram for com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS:

Collaboration diagram for com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS:

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

Detailed Description

SinglePairShortestPathBFS class.

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

It is a unweighted algorithm, that is it assumes all edges have the same cost.

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

SinglePairShortestPathBFS()

com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.SinglePairShortestPathBFS	(	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

AddAllEdgeTypes()

void com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.AddAllEdgeTypes

(

com.sparsity.sparksee.gdb.EdgesDirection

dir

)

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

AddEdgeType()

void com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.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.

AddNodeType()

void com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.AddNodeType

(

int

type

)

Allows for traversing nodes of the given type.

Parameters

type

null

CheckOnlyExistence()

void com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.CheckOnlyExistence

(

)

Set that only the path existence must be calculated and not the path itself.

That method should improve the performance of the algorithm, but a call to GetPathAsNodes or GetPathAsEdges will generate an exception even if the path exists.

Close()

void com.sparsity.sparksee.algorithms.ShortestPath.Close ( )

inherited

Closes the ShortestPath instance.

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

ExcludeEdges()

void com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.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.

ExcludeNodes()

void com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.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.

GetCost()

double com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.GetCost

(

)

Gets the cost of the shortest path.

The cost is the number of hops of the shortest path.

Returns

The cost of the shortest path.

GetPathAsEdges()

com.sparsity.sparksee.gdb.OIDList com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.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.

GetPathAsNodes()

com.sparsity.sparksee.gdb.OIDList com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.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.

IsClosed()

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.

SetMaximumHops()

void com.sparsity.sparksee.algorithms.SinglePairShortestPathBFS.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.