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

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

Public Member Functions
void	ExcludeNodes (com.sparsity.sparksee.gdb.Objects nodes)
	Set which nodes can't be used.

void	SetDefaultWeight (double weight)
	Sets the default weight for those cases when a given edge does not have a weight attribute set.

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.

void	SetSeed (int seed)
	Sets the seed of the random walk.

void	SetEdgeWeightAttributeType (int attr)
	Sets the attribute to use as edge weight.

void	SetInOutParameter (double val)
	Sets the In-Out parameter of the RandomWalk.

void	AddEdgeType (int type, com.sparsity.sparksee.gdb.EdgesDirection dir)
	Allows for traversing edges of the given type.

	RandomWalk (com.sparsity.sparksee.gdb.Session session, long node)
	Builds the RandomWalk.

void	AddNodeType (int type)
	Allows for traversing nodes of the given type.

void	SetReturnParameter (double val)
	Sets the return parameter of the RandomWalk.

long	Next ()
	Gets the next object of the traversal.

bool	HasNext ()
	Gets if there are more objects to be traversed.

int	GetCurrentDepth ()
	Returns the depth of the current node.

void	Reset (long startNode)
	Sets the starting node of the RandomWalk.

void	AddAllNodeTypes ()
	Allows for traversing all node types of the graph.

void	SetMaximumHops (int maxhops)
	Sets the maximum hops restriction.

boolean	IsClosed ()
	Gets if Traversal instance has been closed or not.

void	Close ()
	Closes the Traversal instance.

Detailed Description

RandomWalk class.

Implements the RandomWalk algorithm

Author: Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

◆ RandomWalk()

com.sparsity.sparksee.algorithms.RandomWalk.RandomWalk	(	com.sparsity.sparksee.gdb.Session	session,
		long	node )

Builds the RandomWalk.

Parameters

session	[in] The session to use
node	[in] The starting node of the traversal

Member Function Documentation

◆ AddAllEdgeTypes()

void com.sparsity.sparksee.algorithms.RandomWalk.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.RandomWalk.AddEdgeType	(	int	type,
		com.sparsity.sparksee.gdb.EdgesDirection	dir )

Allows for traversing edges of the given type.

If the edge type was already added, the existing direction is overwritten

Parameters

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

◆ AddNodeType()

void com.sparsity.sparksee.algorithms.RandomWalk.AddNodeType ( int type )

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

◆ Close()

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

inherited

Closes the Traversal instance.

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

◆ ExcludeEdges()

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

◆ GetCurrentDepth()

int com.sparsity.sparksee.algorithms.RandomWalk.GetCurrentDepth ( )

Returns the depth of the current node.

That is, it returns the depth of the node returned in the last call to Next().

Returns: The depth of the current node.

◆ HasNext()

bool com.sparsity.sparksee.algorithms.RandomWalk.HasNext ( )

Gets if there are more objects to be traversed.

Returns: TRUE if there are more objects, FALSE otherwise.

◆ IsClosed()

boolean com.sparsity.sparksee.algorithms.Traversal.IsClosed ( )

inherited

Gets if Traversal instance has been closed or not.

See also: Close()

Returns: TRUE if the Traversal instance has been closed, FALSE otherwise.

◆ Next()

long com.sparsity.sparksee.algorithms.RandomWalk.Next ( )

Gets the next object of the traversal.

Returns: A node or edge identifier.

◆ Reset()

void com.sparsity.sparksee.algorithms.RandomWalk.Reset ( long startNode )

Sets the starting node of the RandomWalk.

This method resets the RandomWalk.

sparksee::gdb::Error

Parameters

startNode null

◆ SetDefaultWeight()

void com.sparsity.sparksee.algorithms.RandomWalk.SetDefaultWeight ( double weight )

Sets the default weight for those cases when a given edge does not have a weight attribute set.

Default: 0.0

Parameters

weight [in] The default weight

◆ SetEdgeWeightAttributeType()

void com.sparsity.sparksee.algorithms.RandomWalk.SetEdgeWeightAttributeType ( int attr )

Sets the attribute to use as edge weight.

If the multiple edge are set for traversal, this attribute must be of type GLOBAL_TYPE or EDGES_TYPE. Additionally, the attribute must be of type Double. Finally, negative weights are treated as non existing, so the default weight applies.

Parameters

attr	[in] The attribute type to use as a weight. Default: InvalidAttribute

◆ SetInOutParameter()

void com.sparsity.sparksee.algorithms.RandomWalk.SetInOutParameter ( double val )

Sets the In-Out parameter of the RandomWalk.

Parameters

val	The In-Out parameter to set. Default: 1.0

◆ SetMaximumHops()

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

◆ SetReturnParameter()

void com.sparsity.sparksee.algorithms.RandomWalk.SetReturnParameter ( double val )

Sets the return parameter of the RandomWalk.

Parameters

val	The return parameter to set. Default: 1.0

◆ SetSeed()

void com.sparsity.sparksee.algorithms.RandomWalk.SetSeed ( int seed )

Sets the seed of the random walk.

Parameters

seed	The seed to generate the random numbers that drive the random walk

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RandomWalk()

Member Function Documentation

◆ AddAllEdgeTypes()

◆ AddEdgeType()

◆ AddNodeType()

◆ Close()

◆ ExcludeEdges()

◆ ExcludeNodes()

◆ GetCurrentDepth()

◆ HasNext()

◆ IsClosed()

◆ Next()

◆ Reset()

◆ SetDefaultWeight()

◆ SetEdgeWeightAttributeType()

◆ SetInOutParameter()

◆ SetMaximumHops()

◆ SetReturnParameter()

◆ SetSeed()