smile.nlp.relevance

Class Relevance

java.lang.Object

smile.nlp.relevance.Relevance

All Implemented Interfaces:

java.lang.Comparable<Relevance>

public class Relevance
extends java.lang.Object
implements java.lang.Comparable<Relevance>

In the context of information retrieval, relevance denotes how well a retrieved set of documents meets the information need of the user.

Constructor Summary

Constructors

Constructor and Description
Relevance(Text doc, double score) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Relevance o)
Text	doc() Returns the document to rank.
double	score() Returns the relevance score.

Methods inherited from class java.lang.Object

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

Constructor Detail

Relevance

public Relevance(Text doc,
                 double score)

Constructor.

Parameters:

doc - the document to rank.

score - the relevance score.

Method Detail

doc

public Text doc()

Returns the document to rank.

score

public double score()

Returns the relevance score.

compareTo

public int compareTo(Relevance o)

Specified by:

compareTo in interface java.lang.Comparable<Relevance>