Class Ranking<V>
- java.lang.Object
-
- edu.uci.ics.jung.algorithms.importance.Ranking<V>
-
- All Implemented Interfaces:
java.lang.Comparable
public class Ranking<V> extends java.lang.Object implements java.lang.Comparable
Abstract data container for ranking objects. Stores common data relevant to both node and edge rankings, namely, the original position of the instance in the list and the actual ranking score.
-
-
Field Summary
Fields Modifier and Type Field Description int
originalPos
The original (0-indexed) position of the instance being rankedprivate V
ranked
what is being rankeddouble
rankScore
The actual rank score (normally between 0 and 1)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(java.lang.Object other)
Compares two ranking based on the rank score.V
getRanked()
void
setRanked(V ranked)
java.lang.String
toString()
Returns the rank score as a string.
-
-
-
Field Detail
-
originalPos
public int originalPos
The original (0-indexed) position of the instance being ranked
-
rankScore
public double rankScore
The actual rank score (normally between 0 and 1)
-
ranked
private V ranked
what is being ranked
-
-
Constructor Detail
-
Ranking
public Ranking(int originalPos, double rankScore, V ranked)
Constructor which allows values to be set on construction- Parameters:
originalPos
- The original (0-indexed) position of the instance being rankedrankScore
- The actual rank score (normally between 0 and 1)ranked
- the vertex being ranked
-
-
Method Detail
-
compareTo
public int compareTo(java.lang.Object other)
Compares two ranking based on the rank score.- Specified by:
compareTo
in interfacejava.lang.Comparable<V>
- Parameters:
other
- The other ranking- Returns:
- -1 if the other ranking is higher, 0 if they are equal, and 1 if this ranking is higher
-
toString
public java.lang.String toString()
Returns the rank score as a string.- Overrides:
toString
in classjava.lang.Object
- Returns:
- the stringified rank score
-
getRanked
public V getRanked()
- Returns:
- the ranked element
-
setRanked
public void setRanked(V ranked)
- Parameters:
ranked
- the ranked to set
-
-