org.apache.lucene.search.similarities

Class LMSimilarity.LMStats

java.lang.Object

org.apache.lucene.search.similarities.Similarity.SimWeight

org.apache.lucene.search.similarities.BasicStats

org.apache.lucene.search.similarities.LMSimilarity.LMStats

Enclosing class:

LMSimilarity

public static class LMSimilarity.LMStats
extends BasicStats

Stores the collection distribution of the current term.

Field Summary

Fields

Modifier and Type	Field and Description
private float	collectionProbability The probability that the current term is generated by the collection.

Fields inherited from class org.apache.lucene.search.similarities.BasicStats

avgFieldLength, boost, docFreq, field, numberOfDocuments, numberOfFieldTokens, totalTermFreq

Constructor Summary

Constructors

Constructor and Description
LMStats(java.lang.String field) Creates LMStats for the provided field and query-time boost

Method Summary

Modifier and Type	Method and Description
float	getCollectionProbability() Returns the probability that the current term is generated by the collection.
void	setCollectionProbability(float collectionProbability) Sets the probability that the current term is generated by the collection.

Methods inherited from class org.apache.lucene.search.similarities.BasicStats

getAvgFieldLength, getBoost, getDocFreq, getNumberOfDocuments, getNumberOfFieldTokens, getTotalTermFreq, getValueForNormalization, normalize, rawNormalizationValue, setAvgFieldLength, setDocFreq, setNumberOfDocuments, setNumberOfFieldTokens, setTotalTermFreq

Methods inherited from class java.lang.Object

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

Field Detail

collectionProbability

private float collectionProbability

The probability that the current term is generated by the collection.

Constructor Detail

LMStats

public LMStats(java.lang.String field)

Creates LMStats for the provided field and query-time boost

Method Detail

getCollectionProbability

public final float getCollectionProbability()

Returns the probability that the current term is generated by the collection.

setCollectionProbability

public final void setCollectionProbability(float collectionProbability)

Sets the probability that the current term is generated by the collection.