Class RelativeAuthorityRanker<V,E>
- java.lang.Object
-
- edu.uci.ics.jung.algorithms.util.IterativeProcess
-
- edu.uci.ics.jung.algorithms.importance.AbstractRanker<V,E>
-
- edu.uci.ics.jung.algorithms.importance.RelativeAuthorityRanker<V,E>
-
- All Implemented Interfaces:
IterativeContext
- Direct Known Subclasses:
KStepMarkov
public abstract class RelativeAuthorityRanker<V,E> extends AbstractRanker<V,E>
This class provides basic infrastructure for relative authority algorithms that compute the importance of nodes relative to one or more root nodes. The services provided are:- The set of root nodes (priors) is stored and maintained
- Getters and setters for the prior rank score are provided
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Set<V>
mPriors
protected java.util.Map<V,java.lang.Number>
priorRankScoreMap
The default key used for the user datum key corresponding to prior rank scores.-
Fields inherited from class edu.uci.ics.jung.algorithms.importance.AbstractRanker
edgeRankScores, vertexRankScores
-
-
Constructor Summary
Constructors Constructor Description RelativeAuthorityRanker()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
finalizeIterations()
Cleans up all of the prior rank scores on finalize.protected double
getPriorRankScore(V v)
Retrieves the value of the prior rank score.protected java.util.Set<V>
getPriors()
Retrieves the set of priors.void
setPriorRankScore(V v, double value)
Allows the user to specify a value to set for the prior rank scoreprotected void
setPriors(java.util.Set<V> priors)
Specifies which vertices are root nodes (priors).-
Methods inherited from class edu.uci.ics.jung.algorithms.importance.AbstractRanker
assignDefaultEdgeTransitionWeights, getEdgeRankScore, getEdgeRankScore, getEdgeRankScores, getEdgeRankScores, getEdgeWeight, getEdgeWeights, getGraph, getRankings, getRankScoreKey, getRankScores, getVertexCount, getVertexRankScore, getVertexRankScore, getVertexRankScores, getVertexRankScores, getVertices, initialize, isRankingEdges, isRankingNodes, normalizeEdgeTransitionWeights, normalizeRankings, onFinalize, printRankings, removeEdgeRankScore, removeEdgeRankScore, removeVertexRankScore, removeVertexRankScore, reset, setEdgeRankScore, setEdgeRankScore, setEdgeWeight, setEdgeWeights, setNormalizeRankings, setRemoveRankScoresOnFinalize, setVertexRankScore, setVertexRankScore
-
Methods inherited from class edu.uci.ics.jung.algorithms.util.IterativeProcess
done, evaluate, getDesiredPrecision, getIterations, getMaximumIterations, getPrecision, hasConverged, initializeIterations, relativePrecision, setDesiredPrecision, setMaximumIterations, setPrecision, step
-
-
-
-
Method Detail
-
finalizeIterations
protected void finalizeIterations()
Cleans up all of the prior rank scores on finalize.- Overrides:
finalizeIterations
in classAbstractRanker<V,E>
-
getPriorRankScore
protected double getPriorRankScore(V v)
Retrieves the value of the prior rank score.- Parameters:
v
- the root node (prior)- Returns:
- the prior rank score
-
setPriorRankScore
public void setPriorRankScore(V v, double value)
Allows the user to specify a value to set for the prior rank score- Parameters:
v
- the root node (prior)value
- the score to set to
-
getPriors
protected java.util.Set<V> getPriors()
Retrieves the set of priors.- Returns:
- the set of root nodes (priors)
-
setPriors
protected void setPriors(java.util.Set<V> priors)
Specifies which vertices are root nodes (priors).- Parameters:
priors
- the root nodes
-
-