Inheritance diagram for sparksee.RandomWalk:

Collaboration diagram for sparksee.RandomWalk:

Public Member Functions
	exclude_nodes (self, nodes)
	Set which nodes can't be used.
	set_default_weight (self, weight)
	Sets the default weight for those cases when a given edge does not have a weight attribute set.
	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.
	set_seed (self, seed)
	Sets the seed of the random walk.
	set_edge_weight_attribute_type (self, attr)
	Sets the attribute to use as edge weight.
	set_in_out_parameter (self, val)
	Sets the In-Out parameter of the RandomWalk.
	add_edge_type (self, type, dir)
	Allows for traversing edges of the given type.
	__init__ (self, session, node)
	Builds the RandomWalk.
	add_node_type (self, type)
	Allows for traversing nodes of the given type.
	set_return_parameter (self, val)
	Sets the return parameter of the RandomWalk.
	next (self)
	Gets the next object of the traversal.
	has_next (self)
	Gets if there are more objects to be traversed.
	get_current_depth (self)
	Returns the depth of the current node.
	reset (self, start_node)
	Sets the starting node of the RandomWalk.
	add_all_node_types (self)
	Allows for traversing all node types of the graph.
	set_maximum_hops (self, maxhops)
	Sets the maximum hops restriction.
	__iter__ (self)
	Gets a new TraversalIterator.
	__next__ (self)
	Return the next item from the container.
	close (self)
	Closes the Traversal instance.
	is_closed (self)
	Gets if Traversal has been closed or not.

Detailed Description

RandomWalk class.

Implements the RandomWalk algorithm

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

Constructor & Destructor Documentation

◆ init()

sparksee.RandomWalk.__init__	(	self,
		session,
		node )

Builds the RandomWalk.

Parameters

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

Member Function Documentation

◆ iter()

sparksee.Traversal.__iter__ ( self )

inherited

Gets a new TraversalIterator.

Returns: TraversalIterator instance

◆ next()

sparksee.Traversal.__next__ ( self )

inherited

Return the next item from the container.

If there are no further items, raise the StopIteration exception.

Returns: The next element

◆ add_all_edge_types()

sparksee.RandomWalk.add_all_edge_types	(		self,
			dir )

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

Reimplemented from sparksee.Traversal.

◆ add_edge_type()

sparksee.RandomWalk.add_edge_type	(	self,
		type,
		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.

Reimplemented from sparksee.Traversal.

◆ add_node_type()

sparksee.RandomWalk.add_node_type	(		self,
			type )

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

Reimplemented from sparksee.Traversal.

◆ close()

sparksee.Traversal.close ( self )

inherited

Closes the Traversal instance.

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

◆ exclude_edges()

sparksee.RandomWalk.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.Traversal.

◆ exclude_nodes()

sparksee.RandomWalk.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.Traversal.

◆ get_current_depth()

sparksee.RandomWalk.get_current_depth ( self )

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.

Reimplemented from sparksee.Traversal.

◆ has_next()

sparksee.RandomWalk.has_next ( self )

Gets if there are more objects to be traversed.

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

Reimplemented from sparksee.Traversal.

◆ is_closed()

sparksee.Traversal.is_closed ( self )

inherited

Gets if Traversal has been closed or not.

See also: close()

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

◆ next()

sparksee.RandomWalk.next ( self )

Gets the next object of the traversal.

Returns: A node or edge identifier.

Reimplemented from sparksee.Traversal.

◆ reset()

sparksee.RandomWalk.reset	(		self,
			start_node )

Sets the starting node of the RandomWalk.

This method resets the RandomWalk.

sparksee::gdb::Error

Parameters

start_node null

◆ set_default_weight()

sparksee.RandomWalk.set_default_weight	(		self,
			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

◆ set_edge_weight_attribute_type()

sparksee.RandomWalk.set_edge_weight_attribute_type	(		self,
			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

◆ set_in_out_parameter()

sparksee.RandomWalk.set_in_out_parameter	(		self,
			val )

Sets the In-Out parameter of the RandomWalk.

Parameters

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

◆ set_maximum_hops()

sparksee.RandomWalk.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.Traversal.

◆ set_return_parameter()

sparksee.RandomWalk.set_return_parameter	(		self,
			val )

Sets the return parameter of the RandomWalk.

Parameters

val	The return parameter to set. Default: 1.0

◆ set_seed()

sparksee.RandomWalk.set_seed	(		self,
			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

◆ __init__()

Member Function Documentation

◆ __iter__()

◆ __next__()

◆ add_all_edge_types()

◆ add_edge_type()

◆ add_node_type()

◆ close()

◆ exclude_edges()

◆ exclude_nodes()

◆ get_current_depth()

◆ has_next()

◆ is_closed()

◆ next()

◆ reset()

◆ set_default_weight()

◆ set_edge_weight_attribute_type()

◆ set_in_out_parameter()

◆ set_maximum_hops()

◆ set_return_parameter()

◆ set_seed()

◆ init()

◆ iter()

◆ next()