sparksee.RandomWalk Class Reference

RandomWalk class. More...

Inheritance diagram for sparksee.RandomWalk:

Collaboration diagram for sparksee.RandomWalk:

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

Detailed Description

RandomWalk class.

Implements the RandomWalk algorithm

Author

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

Constructor & Destructor Documentation

def 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

def sparksee.Traversal.__iter__ (   self )

inherited

Gets a new TraversalIterator.

Returns

TraversalIterator instance

def sparksee.Traversal.__next__ (   self )

inherited

Used in next()

Returns

The next element

def sparksee.RandomWalk.add_all_edge_types	(		self,
			dir
	)

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

def 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.

def sparksee.RandomWalk.add_node_type	(		self,
			type
	)

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

def sparksee.Traversal.close (   self )

inherited

Closes the Traversal instance.

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

def 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.

def 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.

def 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.

def sparksee.RandomWalk.has_next

(

self

)

Gets if there are more objects to be traversed.

Returns

TRUE if there are more objects, FALSE otherwise.

def 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.

def sparksee.RandomWalk.next

(

self

)

Gets the next object of the traversal.

Returns

A node or edge identifier.

def 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

def 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

def 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

def 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

def 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.

def sparksee.RandomWalk.set_return_parameter	(		self,
			val
	)

Sets the return parameter of the RandomWalk.

Parameters

val	The return parameter to set. Default: 1.0

def 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