org.terrier.structures
Interface EntryStatistics

All Superinterfaces:
Serializable
All Known Subinterfaces:
BlockEntryStatistics, FieldEntryStatistics
All Known Implementing Classes:
BasicLexiconEntry, BasicTermStatsLexiconEntry, BlockFieldLexiconEntry, BlockLexiconEntry, FieldLexiconEntry, LexiconEntry

public interface EntryStatistics
extends Serializable

An interface for basic statistics about a lexical entry (usually a term)

Since:
3.0
Author:
Craig Macdonald

Method Summary
 void add(EntryStatistics e)
          Increment the statistics of this object by that of another
 int getDocumentFrequency()
          The number of documents that the entry (term) occurred in
 int getFrequency()
          The frequency (total number of occurrences) of the entry (term).
 int getTermId()
          The id of the term
 EntryStatistics getWritableEntryStatistics()
          Get a copy of these entry statistics that can be reused.
 void subtract(EntryStatistics e)
          Decrement the statistics of this object by that of another
 

Method Detail

getFrequency

int getFrequency()
The frequency (total number of occurrences) of the entry (term).


getDocumentFrequency

int getDocumentFrequency()
The number of documents that the entry (term) occurred in


getTermId

int getTermId()
The id of the term


add

void add(EntryStatistics e)
Increment the statistics of this object by that of another


subtract

void subtract(EntryStatistics e)
Decrement the statistics of this object by that of another


getWritableEntryStatistics

EntryStatistics getWritableEntryStatistics()
Get a copy of these entry statistics that can be reused.

Since:
3.6


Terrier 3.6. Copyright © 2004-2011 University of Glasgow