# Uses of Class
org.apache.lucene.search.similarities.BasicStats

Packages that use BasicStats
Package
Description
org.apache.lucene.search.similarities
This package contains the various ranking models that can be used in Lucene.

## Uses of BasicStats in org.apache.lucene.search.similarities

Subclasses of BasicStats in org.apache.lucene.search.similarities
Modifier and Type
Class
Description
`static class`
`LMSimilarity.LMStats`
Stores the collection distribution of the current term.
Methods in org.apache.lucene.search.similarities that return BasicStats
Modifier and Type
Method
Description
`protected BasicStats`
LMSimilarity.`newStats(String field, double boost)`
`protected BasicStats`
SimilarityBase.`newStats(String field, double boost)`
Factory method to return a custom stats object
Methods in org.apache.lucene.search.similarities with parameters of type BasicStats
Modifier and Type
Method
Description
`double`
IndriDirichletSimilarity.IndriCollectionModel.`computeProbability(BasicStats stats)`
`double`
LMSimilarity.CollectionModel.`computeProbability(BasicStats stats)`
Computes the probability `p(w|C)` according to the language model strategy for the current term.
`double`
LMSimilarity.DefaultCollectionModel.`computeProbability(BasicStats stats)`
`abstract Explanation`
AfterEffect.`explain(BasicStats stats, double tfn)`
Returns an explanation for the score.
`final Explanation`
AfterEffectB.`explain(BasicStats stats, double tfn)`
`final Explanation`
AfterEffectL.`explain(BasicStats stats, double tfn)`
`protected void`
Axiomatic.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected Explanation`
Axiomatic.`explain(BasicStats stats, Explanation freq, double docLen)`
`abstract Explanation`
BasicModel.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
Returns an explanation for the score.
`Explanation`
BasicModelG.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`Explanation`
BasicModelIF.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`final Explanation`
BasicModelIn.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`Explanation`
BasicModelIne.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`protected Explanation`
DFISimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected void`
DFRSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected Explanation`
DFRSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`Explanation`
Distribution.`explain(BasicStats stats, double tfn, double lambda)`
Explains the score.
`protected void`
IBSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected Explanation`
IBSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected void`
IndriDirichletSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`abstract Explanation`
Lambda.`explain(BasicStats stats)`
Explains the lambda parameter.
`final Explanation`
LambdaDF.`explain(BasicStats stats)`
`final Explanation`
LambdaTTF.`explain(BasicStats stats)`
`protected void`
LMDirichletSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected Explanation`
LMDirichletSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected void`
LMJelinekMercerSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected Explanation`
LMJelinekMercerSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected void`
LMSimilarity.`explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen)`
`Explanation`
Normalization.`explain(BasicStats stats, double tf, double len)`
Returns an explanation for the normalized term frequency.
`Explanation`
Normalization.NoNormalization.`explain(BasicStats stats, double tf, double len)`
`Explanation`
NormalizationH1.`explain(BasicStats stats, double tf, double len)`
`Explanation`
NormalizationH2.`explain(BasicStats stats, double tf, double len)`
`Explanation`
NormalizationH3.`explain(BasicStats stats, double tf, double len)`
`Explanation`
NormalizationZ.`explain(BasicStats stats, double tf, double len)`
`protected void`
SimilarityBase.`explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen)`
Subclasses should implement this method to explain the score.
`protected Explanation`
SimilarityBase.`explain(BasicStats stats, Explanation freq, double docLen)`
Explains the score.
`protected void`
LMSimilarity.`fillBasicStats(BasicStats stats, CollectionStatistics collectionStats, TermStatistics termStats)`
Computes the collection probability of the current term in addition to the usual statistics.
`protected void`
SimilarityBase.`fillBasicStats(BasicStats stats, CollectionStatistics collectionStats, TermStatistics termStats)`
Fills all member fields defined in `BasicStats` in `stats`.
`protected abstract double`
Axiomatic.`gamma(BasicStats stats, double freq, double docLen)`
compute the gamma component (only for F3EXp and F3LOG)
`protected double`
AxiomaticF1EXP.`gamma(BasicStats stats, double freq, double docLen)`
compute the gamma component
`protected double`
AxiomaticF1LOG.`gamma(BasicStats stats, double freq, double docLen)`
compute the gamma component
`protected double`
AxiomaticF2EXP.`gamma(BasicStats stats, double freq, double docLen)`
compute the gamma component
`protected double`
AxiomaticF2LOG.`gamma(BasicStats stats, double freq, double docLen)`
compute the gamma component
`protected double`
AxiomaticF3EXP.`gamma(BasicStats stats, double freq, double docLen)`
compute the gamma component
`protected double`
AxiomaticF3LOG.`gamma(BasicStats stats, double freq, double docLen)`
compute the gamma component
`protected abstract double`
Axiomatic.`idf(BasicStats stats, double freq, double docLen)`
compute the inverted document frequency component
`protected double`
AxiomaticF1EXP.`idf(BasicStats stats, double freq, double docLen)`
compute the inverted document frequency component
`protected double`
AxiomaticF1LOG.`idf(BasicStats stats, double freq, double docLen)`
compute the inverted document frequency component
`protected double`
AxiomaticF2EXP.`idf(BasicStats stats, double freq, double docLen)`
compute the inverted document frequency component
`protected double`
AxiomaticF2LOG.`idf(BasicStats stats, double freq, double docLen)`
compute the inverted document frequency component
`protected double`
AxiomaticF3EXP.`idf(BasicStats stats, double freq, double docLen)`
compute the inverted document frequency component
`protected double`
AxiomaticF3LOG.`idf(BasicStats stats, double freq, double docLen)`
compute the inverted document frequency component
`protected abstract Explanation`
Axiomatic.`idfExplain(BasicStats stats, double freq, double docLen)`
Explain the score of the inverted document frequency component for a single document
`protected Explanation`
AxiomaticF1EXP.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF1LOG.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2EXP.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2LOG.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3EXP.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3LOG.`idfExplain(BasicStats stats, double freq, double docLen)`
`abstract float`
Lambda.`lambda(BasicStats stats)`
Computes the lambda parameter.
`final float`
LambdaDF.`lambda(BasicStats stats)`
`final float`
LambdaTTF.`lambda(BasicStats stats)`
`protected abstract double`
Axiomatic.`ln(BasicStats stats, double freq, double docLen)`
compute the document length component
`protected double`
AxiomaticF1EXP.`ln(BasicStats stats, double freq, double docLen)`
compute the document length component
`protected double`
AxiomaticF1LOG.`ln(BasicStats stats, double freq, double docLen)`
compute the document length component
`protected double`
AxiomaticF2EXP.`ln(BasicStats stats, double freq, double docLen)`
compute the document length component
`protected double`
AxiomaticF2LOG.`ln(BasicStats stats, double freq, double docLen)`
compute the document length component
`protected double`
AxiomaticF3EXP.`ln(BasicStats stats, double freq, double docLen)`
compute the document length component
`protected double`
AxiomaticF3LOG.`ln(BasicStats stats, double freq, double docLen)`
compute the document length component
`protected abstract Explanation`
Axiomatic.`lnExplain(BasicStats stats, double freq, double docLen)`
Explain the score of the document length component for a single document
`protected Explanation`
AxiomaticF1EXP.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF1LOG.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2EXP.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2LOG.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3EXP.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3LOG.`lnExplain(BasicStats stats, double freq, double docLen)`
`double`
Axiomatic.`score(BasicStats stats, double freq, double docLen)`
`abstract double`
BasicModel.`score(BasicStats stats, double tfn, double aeTimes1pTfn)`
Returns the informative content score combined with the after effect, more specifically `informationContentScore * aeTimes1pTfn / (1 + tfn)`.
`final double`
BasicModelG.`score(BasicStats stats, double tfn, double aeTimes1pTfn)`
`final double`
BasicModelIF.`score(BasicStats stats, double tfn, double aeTimes1pTfn)`
`final double`
BasicModelIn.`score(BasicStats stats, double tfn, double aeTimes1pTfn)`
`final double`
BasicModelIne.`score(BasicStats stats, double tfn, double aeTimes1pTfn)`
`protected double`
DFISimilarity.`score(BasicStats stats, double freq, double docLen)`
`protected double`
DFRSimilarity.`score(BasicStats stats, double freq, double docLen)`
`abstract double`
Distribution.`score(BasicStats stats, double tfn, double lambda)`
Computes the score.
`final double`
DistributionLL.`score(BasicStats stats, double tfn, double lambda)`
`final double`
DistributionSPL.`score(BasicStats stats, double tfn, double lambda)`
`protected double`
IBSimilarity.`score(BasicStats stats, double freq, double docLen)`
`protected double`
IndriDirichletSimilarity.`score(BasicStats stats, double freq, double docLen)`
`protected double`
LMDirichletSimilarity.`score(BasicStats stats, double freq, double docLen)`
`protected double`
LMJelinekMercerSimilarity.`score(BasicStats stats, double freq, double docLen)`
`protected abstract double`
SimilarityBase.`score(BasicStats stats, double freq, double docLen)`
Scores the document `doc`.
`abstract double`
AfterEffect.`scoreTimes1pTfn(BasicStats stats)`
Returns the product of the after effect with `1+tfn`.
`final double`
AfterEffectB.`scoreTimes1pTfn(BasicStats stats)`
`final double`
AfterEffectL.`scoreTimes1pTfn(BasicStats stats)`
`protected abstract double`
Axiomatic.`tf(BasicStats stats, double freq, double docLen)`
compute the term frequency component
`protected double`
AxiomaticF1EXP.`tf(BasicStats stats, double freq, double docLen)`
compute the term frequency component
`protected double`
AxiomaticF1LOG.`tf(BasicStats stats, double freq, double docLen)`
compute the term frequency component
`protected double`
AxiomaticF2EXP.`tf(BasicStats stats, double freq, double docLen)`
compute the term frequency component
`protected double`
AxiomaticF2LOG.`tf(BasicStats stats, double freq, double docLen)`
compute the term frequency component
`protected double`
AxiomaticF3EXP.`tf(BasicStats stats, double freq, double docLen)`
compute the term frequency component
`protected double`
AxiomaticF3LOG.`tf(BasicStats stats, double freq, double docLen)`
compute the term frequency component
`protected abstract Explanation`
Axiomatic.`tfExplain(BasicStats stats, double freq, double docLen)`
Explain the score of the term frequency component for a single document
`protected Explanation`
AxiomaticF1EXP.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF1LOG.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2EXP.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2LOG.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3EXP.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3LOG.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected abstract double`
Axiomatic.`tfln(BasicStats stats, double freq, double docLen)`
compute the mixed term frequency and document length component
`protected double`
AxiomaticF1EXP.`tfln(BasicStats stats, double freq, double docLen)`
compute the mixed term frequency and document length component
`protected double`
AxiomaticF1LOG.`tfln(BasicStats stats, double freq, double docLen)`
compute the mixed term frequency and document length component
`protected double`
AxiomaticF2EXP.`tfln(BasicStats stats, double freq, double docLen)`
compute the mixed term frequency and document length component
`protected double`
AxiomaticF2LOG.`tfln(BasicStats stats, double freq, double docLen)`
compute the mixed term frequency and document length component
`protected double`
AxiomaticF3EXP.`tfln(BasicStats stats, double freq, double docLen)`
compute the mixed term frequency and document length component
`protected double`
AxiomaticF3LOG.`tfln(BasicStats stats, double freq, double docLen)`
compute the mixed term frequency and document length component
`protected abstract Explanation`
Axiomatic.`tflnExplain(BasicStats stats, double freq, double docLen)`
Explain the score of the mixed term frequency and document length component for a single document
`protected Explanation`
AxiomaticF1EXP.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF1LOG.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2EXP.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF2LOG.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3EXP.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation`
AxiomaticF3LOG.`tflnExplain(BasicStats stats, double freq, double docLen)`
`double`
Normalization.NoNormalization.`tfn(BasicStats stats, double tf, double len)`
`abstract double`
Normalization.`tfn(BasicStats stats, double tf, double len)`
Returns the normalized term frequency.
`final double`
NormalizationH1.`tfn(BasicStats stats, double tf, double len)`
`final double`
NormalizationH2.`tfn(BasicStats stats, double tf, double len)`
`double`
NormalizationH3.`tfn(BasicStats stats, double tf, double len)`
`double`
NormalizationZ.`tfn(BasicStats stats, double tf, double len)`