sparksee.SinglePairShortestPathBFS Class Reference

SinglePairShortestPathBFS class. More...

Inheritance diagram for sparksee.SinglePairShortestPathBFS:

Collaboration diagram for sparksee.SinglePairShortestPathBFS:

Public Member Functions
	exclude_nodes (self, nodes)
	Set which nodes can't be used.
	get_cost (self)
	Gets the cost of the shortest path.
	run (self)
	Executes the algorithm.
	add_all_edge_types (self, dir)
	Allows for traversing all edge types of the graph.
	exclude_edges (self, edges)
	Set which edges can't be used.
	__init__ (self, session, src, dst)
	Creates a new instance.
	add_edge_type (self, type, dir)
	Allows for traversing edges of the given type.
	get_path_as_nodes (self)
	Gets the shortest path between the source node and the destination node as an ordered set of nodes.
	add_node_type (self, type)
	Allows for traversing nodes of the given type.
	exists (self)
	Returns TRUE If a path exists or FALSE otherwise.
	check_only_existence (self)
	Set that only the path existence must be calculated and not the path itself.
	get_path_as_edges (self)
	Gets the shortest path between the source node and the destination node as an ordered set of edges.
	set_maximum_hops (self, maxhops)
	Sets the maximum hops restriction.
	add_all_node_types (self)
	Allows for traversing all node types of the graph.
	close (self)
	Closes the ShortestPath instance.
	is_closed (self)
	Gets if ShortestPath 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

__init__()

sparksee.SinglePairShortestPathBFS.__init__	(		self,
			session,
			src,
			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

add_all_edge_types()

sparksee.SinglePairShortestPathBFS.add_all_edge_types	(		self,
			dir )

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

Reimplemented from sparksee.SinglePairShortestPath.

add_edge_type()

sparksee.SinglePairShortestPathBFS.add_edge_type	(		self,
			type,
			dir )

Allows for traversing edges of the given type.

Parameters

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

Reimplemented from sparksee.SinglePairShortestPath.

add_node_type()

sparksee.SinglePairShortestPathBFS.add_node_type	(		self,
			type )

Allows for traversing nodes of the given type.

Parameters

type

null

Reimplemented from sparksee.SinglePairShortestPath.

check_only_existence()

sparksee.SinglePairShortestPathBFS.check_only_existence

(

self

)

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()

sparksee.ShortestPath.close ( self )

inherited

Closes the ShortestPath instance.

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

exclude_edges()

sparksee.SinglePairShortestPathBFS.exclude_edges	(		self,
			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 from sparksee.SinglePairShortestPath.

exclude_nodes()

sparksee.SinglePairShortestPathBFS.exclude_nodes	(		self,
			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 from sparksee.SinglePairShortestPath.

get_cost()

sparksee.SinglePairShortestPathBFS.get_cost

(

self

)

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.

Reimplemented from sparksee.SinglePairShortestPath.

get_path_as_edges()

sparksee.SinglePairShortestPathBFS.get_path_as_edges

(

self

)

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

Returns

Ordered set of edge identifiers.

Reimplemented from sparksee.SinglePairShortestPath.

get_path_as_nodes()

sparksee.SinglePairShortestPathBFS.get_path_as_nodes

(

self

)

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

Returns

Ordered set of node identifiers.

Reimplemented from sparksee.SinglePairShortestPath.

is_closed()

sparksee.ShortestPath.is_closed ( self )

inherited

Gets if ShortestPath has been closed or not.

See also

close()

Returns

TRUE if the ShortestPath instance has been closed, FALSE otherwise.

set_maximum_hops()

sparksee.SinglePairShortestPathBFS.set_maximum_hops	(		self,
			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 from sparksee.SinglePairShortestPath.