org.terrier.structures

Interface EntryStatistics

All Superinterfaces:

Serializable

All Known Subinterfaces:

BlockEntryStatistics, FieldEntryStatistics, NgramEntryStatistics

All Known Implementing Classes:

BasicLexiconEntry, BasicTermStatsLexiconEntry, FieldLexiconEntry, LexiconEntry, MemoryFieldsLexiconEntry, MemoryLexiconEntry, MultiLexiconEntry, SimpleNgramEntryStatistics, Tr3BlockFieldLexiconEntry, Tr3BlockLexiconEntry, Tr4BasicLexiconEntry, Tr4BasicTermStatsLexiconEntry, Tr4FieldLexiconEntry

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

Modifier and Type	Method and Description
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	getMaxFrequencyInDocuments()
int	getTermId() The id of the term
EntryStatistics	getWritableEntryStatistics() Get a copy of these entry statistics that can be reused.
void	setDocumentFrequency(int nt)
void	setFrequency(int F)
void	setMaxFrequencyInDocuments(int max)
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).

setFrequency

void setFrequency(int F)

getDocumentFrequency

int getDocumentFrequency()

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

setDocumentFrequency

void setDocumentFrequency(int nt)

getTermId

int getTermId()

The id of the term

getMaxFrequencyInDocuments

int getMaxFrequencyInDocuments()

setMaxFrequencyInDocuments

void setMaxFrequencyInDocuments(int max)

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