STSPageRank Class Reference

PageRank class. More...

Inheritance diagram for STSPageRank:

Collaboration diagram for STSPageRank:

Instance Methods
(id)	- initWithSession:
	Builds the PageRank. 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)	- setNumIterations:
	Sets the number of iterations to run the PageRank for. More...
(void)	- setTolerance:
	Sets the tolerance threashold to continue computing the PageRank after each iteration. More...
(void)	- setDamping:
	Sets the damping value for the PageRank. More...
(void)	- setInitialPageRankValue:
	Sets the initial PageRank value. More...
(void)	- setOutputAttributeType:
	Sets the output attribute type. 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)	- setStartingNode:
	Sets the starting node of the page rank to compute the Personalized PageRank variant. More...
(void)	- run
	Runs the algorithm. More...
(void)	- close
	Closes the PageRank instance. More...
(BOOL)	- isClosed
	Check if the PageRank instance is closed.

Detailed Description

PageRank class.

Implements the PageRank 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.

The direction is interpreted as in which direction an edge can be followed from a node to influence other nodes.

Parameters

dir	[in] Edge direction.

- (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 The direction is interpreted as in which direction an edge can be followed from a node to influence other nodes.

Parameters

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

Exceptions

System.ApplicationException

null

- (void) addNodeType:

(int)

type

Allows for traversing nodes of the given type.

Parameters

type

null

Exceptions

System.ApplicationException

null

- (void) close

Closes the PageRank instance.

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

- (id) initWithSession:

(STSSession *)

session

Builds the PageRank.

Parameters

session

[in] The session to use

- (void) run

Runs the algorithm.

sparksee::gdb::Error

Exceptions

System.ApplicationException

null

- (void) setDamping:

(double)

damping

Sets the damping value for the PageRank.

Parameters

damping

[in] The damping value. Default: 0.85

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

sparksee::gdb::Error

Parameters

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

Exceptions

System.ApplicationException

null

- (void) setInitialPageRankValue:

(double)

startValue

Sets the initial PageRank value.

If a starting node is set, this initial value is only set for the starting node and the rest of nodes are set to 0.0

Parameters

startValue

[in] The initial value to set. Default: 0.0

- (void) setNumIterations:

(int)

numIterations

Sets the number of iterations to run the PageRank for.

Parameters

numIterations

[in] The number of interations to set. Default: 20

- (void) setOutputAttributeType:

(int)

attr

Sets the output attribute type.

If the PageRank will run on more than one node type, then the output attribute must be of type GLOBAL_TYPE or NODES_TYPE. Otherwise, it must be a valid attribute for the used node type.

Parameters

attr	[in] The attribute to store the result. Default: InvalidAttribute

Exceptions

System.ApplicationException

null

- (void) setStartingNode:

(long long)

startNode

Sets the starting node of the page rank to compute the Personalized PageRank variant.

sparksee::gdb::Error

Parameters

startNode

null

Exceptions

System.ApplicationException

null

- (void) setTolerance:

(double)

tolerance

Sets the tolerance threashold to continue computing the PageRank after each iteration.

If all the changes to any PPR value after an iteration are below that tolerance threshold, the algorithm finishes.

Parameters

tolerance

[in] The tolerance to use normalized between 0 and 1. Default: 0.000001

---

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

• Sparksee.h