STSRandomWalk Class Reference

RandomWalk class. More...

Inheritance diagram for STSRandomWalk:

Collaboration diagram for STSRandomWalk:

Instance Methods
(id)	- initWithSession:node:
	Builds the RandomWalk. More...
(void)	- addEdgeType:dir:
	Allows for traversing edges of the given type. More...
(void)	- addAllEdgeTypes:
	Allows for traversing all edge types of the graph. More...
(void)	- addNodeType:
	Allows for traversing nodes of the given type. More...
(void)	- addAllNodeTypes
	Allows for traversing all node types of the graph.
(void)	- excludeNodes:
	Set which nodes can't be used. More...
(void)	- excludeEdges:
	Set which edges can't be used. More...
(long long)	- next
	Gets the next object of the traversal. More...
(BOOL)	- hasNext
	Gets if there are more objects to be traversed. More...
(int)	- getCurrentDepth
	Returns the depth of the current node. More...
(void)	- setEdgeWeightAttributeType:
	Sets the attribute to use as edge weight. More...
(void)	- setDefaultWeight:
	Sets the default weight for those cases when a given edge does not have a weight attribute set. More...
(void)	- reset:
	Sets the starting node of the RandomWalk. More...
(void)	- setReturnParameter:
	Sets the return parameter of the RandomWalk. More...
(void)	- setInOutParameter:
	Sets the In-Out parameter of the RandomWalk. More...
(void)	- setSeed:
	Sets the seed of the random walk. More...
(void)	- setMaximumHops:
	Sets the maximum hops restriction. More...
(void)	- close
	Closes the Traversal instance. More...
(BOOL)	- isClosed
	Check if the Traversal instance is closed.

Detailed Description

RandomWalk class.

Implements the RandomWalk algorithm

Author

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

Method Documentation

- (void) addAllEdgeTypes:

(enum STSEdgesDirection)

dir

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

Implements STSTraversal.

- (void) addEdgeType:		(int)	type
dir:		(enum STSEdgesDirection)	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.

Implements STSTraversal.

- (void) addNodeType:

(int)

type

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

Implements STSTraversal.

- (void) close

Closes the Traversal instance.

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

- (void) excludeEdges:

(STSObjects *)

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.

Implements STSTraversal.

- (void) excludeNodes:

(STSObjects *)

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.

Implements STSTraversal.

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

Implements STSTraversal.

- (BOOL) hasNext

Gets if there are more objects to be traversed.

Returns

TRUE if there are more objects, FALSE otherwise.

Implements STSTraversal.

- (id) initWithSession:		(STSSession *)	session
node:		(long long)	node

Builds the RandomWalk.

Parameters

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

- (long long) next

Gets the next object of the traversal.

Returns

A node or edge identifier.

Implements STSTraversal.

- (void) reset:

(long long)

startNode

Sets the starting node of the RandomWalk.

This method resets the RandomWalk.

sparksee::gdb::Error

Parameters

startNode

null

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

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

- (void) setInOutParameter:

(double)

val

Sets the In-Out parameter of the RandomWalk.

Parameters

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

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

- (void) setReturnParameter:

(double)

val

Sets the return parameter of the RandomWalk.

Parameters

val	The return parameter to set. Default: 1.0

- (void) setSeed:

(int)

seed

Sets the seed of the random walk.

Parameters

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

---

The documentation for this class was generated from the following file:

• Sparksee.h