org.terrier.structures

Class SimpleNgramEntryStatistics

java.lang.Object

org.terrier.structures.SimpleNgramEntryStatistics

All Implemented Interfaces:

Serializable, org.apache.hadoop.io.Writable, EntryStatistics, NgramEntryStatistics

public class SimpleNgramEntryStatistics
extends Object
implements NgramEntryStatistics, org.apache.hadoop.io.Writable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleNgramEntryStatistics()
SimpleNgramEntryStatistics(EntryStatistics e)
SimpleNgramEntryStatistics(int ws)

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
int	getWindowSize()
EntryStatistics	getWritableEntryStatistics() Get a copy of these entry statistics that can be reused.
void	readFields(DataInput in)
void	setDocumentFrequency(int nt)
void	setFrequency(int F)
void	setMaxFrequencyInDocuments(int max)
void	setWindowSize(int ws)
void	subtract(EntryStatistics e) Decrement the statistics of this object by that of another
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleNgramEntryStatistics

public SimpleNgramEntryStatistics(EntryStatistics e)

SimpleNgramEntryStatistics

public SimpleNgramEntryStatistics()

SimpleNgramEntryStatistics

public SimpleNgramEntryStatistics(int ws)

Method Detail

getFrequency

public int getFrequency()

Description copied from interface: EntryStatistics

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

Specified by:

getFrequency in interface EntryStatistics

getDocumentFrequency

public int getDocumentFrequency()

Description copied from interface: EntryStatistics

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

Specified by:

getDocumentFrequency in interface EntryStatistics

getTermId

public int getTermId()

Description copied from interface: EntryStatistics

The id of the term

Specified by:

getTermId in interface EntryStatistics

add

public void add(EntryStatistics e)

Description copied from interface: EntryStatistics

Increment the statistics of this object by that of another

Specified by:

add in interface EntryStatistics

subtract

public void subtract(EntryStatistics e)

Description copied from interface: EntryStatistics

Decrement the statistics of this object by that of another

Specified by:

subtract in interface EntryStatistics

getWritableEntryStatistics

public EntryStatistics getWritableEntryStatistics()

Description copied from interface: EntryStatistics

Get a copy of these entry statistics that can be reused.

Specified by:

getWritableEntryStatistics in interface EntryStatistics

getWindowSize

public int getWindowSize()

Specified by:

getWindowSize in interface NgramEntryStatistics

setWindowSize

public void setWindowSize(int ws)

Specified by:

setWindowSize in interface NgramEntryStatistics

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

getMaxFrequencyInDocuments

public int getMaxFrequencyInDocuments()

Specified by:

getMaxFrequencyInDocuments in interface EntryStatistics

setMaxFrequencyInDocuments

public void setMaxFrequencyInDocuments(int max)

Specified by:

setMaxFrequencyInDocuments in interface EntryStatistics

toString

public String toString()

Overrides:

toString in class Object

setFrequency

public void setFrequency(int F)

Specified by:

setFrequency in interface EntryStatistics

setDocumentFrequency

public void setDocumentFrequency(int nt)

Specified by:

setDocumentFrequency in interface EntryStatistics