com.sparsity.sparksee.algorithms.ShortestPath Class Reference

ShortestPath class. More...

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

Public Member Functions
void	AddEdgeType (int type, com.sparsity.sparksee.gdb.EdgesDirection dir)
	Allows for traversing edges of the given type.
void	Run ()
	Runs the algorithm.
void	ExcludeNodes (com.sparsity.sparksee.gdb.Objects nodes)
	Set which nodes can't be used.
void	AddAllEdgeTypes (com.sparsity.sparksee.gdb.EdgesDirection dir)
	Allows for traversing all edge types of the graph.
void	AddNodeType (int type)
	Allows for traversing nodes of the given type.
void	ExcludeEdges (com.sparsity.sparksee.gdb.Objects edges)
	Set which edges can't be used.
void	Close ()
	Closes the ShortestPath instance.
boolean	IsClosed ()
	Gets if ShortestPath instance has been closed or not.
void	SetMaximumHops (int maxhops)
	Sets the maximum hops restriction.
void	AddAllNodeTypes ()
	Allows for traversing all node types of the graph.

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

Member Function Documentation

AddAllEdgeTypes()

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

(

int

type

)

Allows for traversing nodes of the given type.

Parameters

type

null

Close()

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

(

)

Closes the ShortestPath instance.

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

ExcludeEdges()

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

IsClosed()

boolean com.sparsity.sparksee.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.

Run()

void com.sparsity.sparksee.algorithms.ShortestPath.Run

(

)

Runs the algorithm.

This method can only be called once.

SetMaximumHops()

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