PageRank class. More...

Public Member Functions
void	SetDamping (double damping)
	Sets the damping value for the PageRank.

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

void	Run () throws System.ApplicationException
	Runs the algorithm.

void	AddAllEdgeTypes (com.sparsity.sparksee.gdb.EdgesDirection dir)
	Allows for traversing all edge types of the graph.

void	SetOutputAttributeType (int attr) throws System.ApplicationException
	Sets the output attribute type.

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

void	SetStartingNode (long startNode) throws System.ApplicationException
	Sets the starting node of the page rank to compute the Personalized PageRank variant.

void	SetInitialPageRankValue (double startValue)
	Sets the initial PageRank value.

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

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

void	SetNumIterations (int numIterations)
	Sets the number of iterations to run the PageRank for.

void	SetTolerance (double tolerance)
	Sets the tolerance threashold to continue computing the PageRank after each iteration.

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

	PageRank (com.sparsity.sparksee.gdb.Session session)
	Builds the PageRank.

void	Close ()
	Closes the PageRank instance.

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

Detailed Description

PageRank class.

Implements the PageRank algorithm

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

Constructor & Destructor Documentation

◆ PageRank()

com.sparsity.sparksee.algorithms.PageRank.PageRank ( com.sparsity.sparksee.gdb.Session session )

Builds the PageRank.

Parameters

session [in] The session to use

Member Function Documentation

◆ AddAllEdgeTypes()

void com.sparsity.sparksee.algorithms.PageRank.AddAllEdgeTypes ( com.sparsity.sparksee.gdb.EdgesDirection 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.

◆ AddEdgeType()

void com.sparsity.sparksee.algorithms.PageRank.AddEdgeType	(	int	type,
		com.sparsity.sparksee.gdb.EdgesDirection	dir ) throws System.ApplicationException

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

◆ AddNodeType()

void com.sparsity.sparksee.algorithms.PageRank.AddNodeType ( int type ) throws System.ApplicationException

Allows for traversing nodes of the given type.

Parameters

type null

Exceptions

System.ApplicationException null

◆ Close()

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

Closes the PageRank instance.

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

◆ IsClosed()

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

Gets if PageRank instance has been closed or not.

See also: Close()

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

◆ Run()

void com.sparsity.sparksee.algorithms.PageRank.Run ( ) throws System.ApplicationException

Runs the algorithm.

sparksee::gdb::Error

Exceptions

System.ApplicationException null

◆ SetDamping()

void com.sparsity.sparksee.algorithms.PageRank.SetDamping ( double damping )

Sets the damping value for the PageRank.

Parameters

damping [in] The damping value. Default: 0.85

◆ SetDefaultWeight()

void com.sparsity.sparksee.algorithms.PageRank.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.PageRank.SetEdgeWeightAttributeType ( int attr ) throws System.ApplicationException

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

◆ SetInitialPageRankValue()

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

◆ SetNumIterations()

void com.sparsity.sparksee.algorithms.PageRank.SetNumIterations ( int numIterations )

Sets the number of iterations to run the PageRank for.

Parameters

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

◆ SetOutputAttributeType()

void com.sparsity.sparksee.algorithms.PageRank.SetOutputAttributeType ( int attr ) throws System.ApplicationException

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

◆ SetStartingNode()

void com.sparsity.sparksee.algorithms.PageRank.SetStartingNode ( long startNode ) throws System.ApplicationException

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

sparksee::gdb::Error

Parameters

startNode null

Exceptions

System.ApplicationException null

◆ SetTolerance()

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PageRank()

Member Function Documentation

◆ AddAllEdgeTypes()

◆ AddEdgeType()

◆ AddNodeType()

◆ Close()

◆ IsClosed()

◆ Run()

◆ SetDamping()

◆ SetDefaultWeight()

◆ SetEdgeWeightAttributeType()

◆ SetInitialPageRankValue()

◆ SetNumIterations()

◆ SetOutputAttributeType()

◆ SetStartingNode()

◆ SetTolerance()