edu.uci.ics.jung.algorithms.importance

Class PageRankWithPriors

java.lang.Object

edu.uci.ics.jung.algorithms.IterativeProcess

edu.uci.ics.jung.algorithms.importance.AbstractRanker

edu.uci.ics.jung.algorithms.importance.RelativeAuthorityRanker

edu.uci.ics.jung.algorithms.importance.PageRank

edu.uci.ics.jung.algorithms.importance.PageRankWithPriors

public class PageRankWithPriors
extends PageRank

Algorithm that extends the PageRank algorithm by incorporating root nodes (priors). Whereas in PageRank the importance of a node is implicitly computed relative to all nodes in the graph now importance is computed relative to the specified root nodes.

Note: This algorithm uses the same key as PageRank for storing rank sccores

A simple example of usage is:

 PageRankWithPriors ranker = new PageRankWithPriors(someGraph,0.3,1,rootSet,null);
 ranker.evaluate();
 ranker.printRankings();
 

Running time: O(|E|*I) where |E| is the number of edges and I is the number of iterations until convergence

Author:

Scott White

See Also:

"Algorithms for Estimating Relative Importance in Graphs by Scott White and Padhraic Smyth, 2003"

Field Summary

Fields inherited from class edu.uci.ics.jung.algorithms.importance.PageRank

KEY

Fields inherited from class edu.uci.ics.jung.algorithms.importance.RelativeAuthorityRanker

PRIOR_KEY

Fields inherited from class edu.uci.ics.jung.algorithms.importance.AbstractRanker

DEFAULT_EDGE_WEIGHT_KEY

Constructor Summary

Constructors

Constructor and Description
PageRankWithPriors(DirectedGraph graph, double beta, java.util.Set priors, java.lang.String edgeWeightKeyName) Constructs an instance of the ranker.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	initializePriorWeights()
protected void	reinitialize()

Methods inherited from class edu.uci.ics.jung.algorithms.importance.PageRank

evaluateIteration, getRankScoreKey, initialize, initializeRankings, updateRankings

Methods inherited from class edu.uci.ics.jung.algorithms.importance.RelativeAuthorityRanker

finalizeIterations, getPriorRankScore, getPriorRankScoreKey, getPriors, setPriorRankScore, setPriors

Methods inherited from class edu.uci.ics.jung.algorithms.importance.AbstractRanker

assignDefaultEdgeTransitionWeights, getEdgeWeight, getEdgeWeightKeyName, getGraph, getRankings, getRankScore, getRankScores, getVertices, initialize, isRankingEdges, isRankingNodes, normalizeEdgeTransitionWeights, normalizeRankings, onFinalize, printRankings, setEdgeWeight, setNormalizeRankings, setRankScore, setRemoveRankScoresOnFinalize, setUserDefinedEdgeWeightKey

Methods inherited from class edu.uci.ics.jung.algorithms.IterativeProcess

evaluate, getDesiredPrecision, getIterations, getMaximumIterations, getPrecision, hasConverged, initializeIterations, relativePrecision, setDesiredPrecision, setMaximumIterations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageRankWithPriors

public PageRankWithPriors(DirectedGraph graph,
                  double beta,
                  java.util.Set priors,
                  java.lang.String edgeWeightKeyName)

Constructs an instance of the ranker.

Parameters:

graph - the graph whose nodes are being ranked

beta - the prior weight to put on the root nodes

priors - the set of root nodes

edgeWeightKeyName - the user datum key associated with any user-defined weights. If there are none, null should be passed in.

Method Detail

initializePriorWeights

protected void initializePriorWeights()

reinitialize

protected void reinitialize()

Overrides:

reinitialize in class PageRank