Ranking

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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 and Description
`int`	`originalPos` The original (0-indexed) position of the instance being ranked
`double`	`rankScore` The actual rank score (normally between 0 and 1)

Constructor Summary

Constructors
Constructor and Description

Ranking(int originalPos, double rankScore, V ranked)
Constructor which allows values to be set on construction

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(java.lang.Object o)` 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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)
- 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 ranked
    rankScore - The actual rank score (normally between 0 and 1)
- Method Detail
  - compareTo
```
public int compareTo(java.lang.Object o)
```
    Compares two ranking based on the rank score.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Parameters:
    o - 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 class java.lang.Object
    
    Returns:
    the stringified rank score
  - getRanked
```
public V getRanked()
```
    Returns:
    the ranked
  - setRanked
```
public void setRanked(V ranked)
```
    Parameters:
    ranked - the ranked to set

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method