cat.lump.ir.index

Class Ranking

java.lang.Object

cat.lump.ir.index.Ranking

public class Ranking
extends java.lang.Object

A class that implements a ranking of identifiers (documents) and their relevance.

Adding and removing entries is possible. It is able to generate (partial) ranks according to top number of desired entries or threshold.

Version:

0.2

Author:

albarron

Constructor Summary

Constructors

Constructor and Description
Ranking()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String id, double relevance) Insert a new document to the ranking
double	get(java.lang.String id)
java.util.Map<java.lang.String,java.lang.Double>	getBottomK(int k)
java.util.Map<java.lang.String,java.lang.Double>	getInverseRank()
java.util.Map<java.lang.String,java.lang.Double>	getOverThreshold(double threshold)
java.util.Map<java.lang.String,java.lang.Double>	getRank()
java.util.Map<java.lang.String,java.lang.Double>	getTopK(int k)
void	remove(java.lang.String id) Remove a document from the ranking
void	reset() Start a new ranking
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Ranking

public Ranking()

Method Detail

add

public void add(java.lang.String id,
       double relevance)

Insert a new document to the ranking

Parameters:

id -

relevance -

get

public double get(java.lang.String id)

Parameters:

id -

Returns:

relevance of a given document

remove

public void remove(java.lang.String id)

Remove a document from the ranking

Parameters:

id -

reset

public void reset()

Start a new ranking

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

size

public int size()

getInverseRank

public java.util.Map<java.lang.String,java.lang.Double> getInverseRank()

Returns:

entire ranking bottom-up

getRank

public java.util.Map<java.lang.String,java.lang.Double> getRank()

Returns:

entire ranking

getTopK

public java.util.Map<java.lang.String,java.lang.Double> getTopK(int k)

Parameters:

k - number of elements to return

Returns:

the top k documents in the ranking (or the entire ranking if k > number of documents.

getBottomK

public java.util.Map<java.lang.String,java.lang.Double> getBottomK(int k)

Parameters:

k - number of elements to return

Returns:

the top k documents in the ranking (or the entire ranking if k > number of documents.

getOverThreshold

public java.util.Map<java.lang.String,java.lang.Double> getOverThreshold(double threshold)

Parameters:

threshold - minimum required relevance

Returns:

sorted entries with a relevance over a given threshold; empty of no entry surpasses it.