## Uses of Class
org.apache.lucene.search.Explanation

Packages that use Explanation
org.apache.lucene.search: Code to search indices.
org.apache.lucene.search.similarities: This package contains the various ranking models that can be used in Lucene.
org.apache.lucene.search.spans: The calculus of spans.

### Uses of Explanation in org.apache.lucene.search

Methods in org.apache.lucene.search that return Explanation
`Explanation` QueryRescorer.`explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)`
`abstract Explanation` Rescorer.`explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)` Explains how the score for the specified document was computed.
`Explanation` SortRescorer.`explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)`
`Explanation` LeafSimScorer.`explain(int doc, Explanation freqExpl)` Explain the score for the provided document assuming the given term document frequency.
`Explanation` DisjunctionMaxQuery.DisjunctionMaxWeight.`explain(LeafReaderContext context, int doc)` Explain the score we computed for doc
`abstract Explanation` Weight.`explain(LeafReaderContext context, int doc)` An explanation of the score computation for the named document.
`Explanation` ConstantScoreWeight.`explain(LeafReaderContext context, int doc)`
`Explanation` FilterWeight.`explain(LeafReaderContext context, int doc)`
`Explanation` DoubleValuesSource.`explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)` An explanation of the value for the named document.
`Explanation` IndexSearcher.`explain(Query query, int doc)` Returns an Explanation that describes how `doc` scored against `query`.
`protected Explanation` IndexSearcher.`explain(Weight weight, int doc)` Expert: low-level implementation method Returns an Explanation that describes how `doc` scored against `weight`.
`Explanation[]` Explanation.`getDetails()` The sub-nodes of this explanation node.
`static Explanation` Explanation.`match(Number value, String description, Collection<Explanation> details)` Create a new explanation for a match.
`static Explanation` Explanation.`match(Number value, String description, Explanation... details)` Create a new explanation for a match.
`static Explanation` Explanation.`noMatch(String description, Collection<Explanation> details)` Create a new explanation for a document which does not match.
`static Explanation` Explanation.`noMatch(String description, Explanation... details)` Create a new explanation for a document which does not match.

Methods in org.apache.lucene.search with parameters of type Explanation
`Explanation` QueryRescorer.`explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)`
`abstract Explanation` Rescorer.`explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)` Explains how the score for the specified document was computed.
`Explanation` SortRescorer.`explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)`
`Explanation` LeafSimScorer.`explain(int doc, Explanation freqExpl)` Explain the score for the provided document assuming the given term document frequency.
`Explanation` DoubleValuesSource.`explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)` An explanation of the value for the named document.
`static Explanation` Explanation.`match(Number value, String description, Explanation... details)` Create a new explanation for a match.
`static Explanation` Explanation.`noMatch(String description, Explanation... details)` Create a new explanation for a document which does not match.

Method parameters in org.apache.lucene.search with type arguments of type Explanation
`static Explanation` Explanation.`match(Number value, String description, Collection<Explanation> details)` Create a new explanation for a match.
`static Explanation` Explanation.`noMatch(String description, Collection<Explanation> details)` Create a new explanation for a document which does not match.

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

Methods in org.apache.lucene.search.similarities that return Explanation
`abstract Explanation` Lambda.`explain(BasicStats stats)` Explains the lambda parameter.
`Explanation` LambdaDF.`explain(BasicStats stats)`
`Explanation` LambdaTTF.`explain(BasicStats stats)`
`Explanation` AfterEffectL.`explain(BasicStats stats, double tfn)`
`abstract Explanation` AfterEffect.`explain(BasicStats stats, double tfn)` Returns an explanation for the score.
`Explanation` AfterEffectB.`explain(BasicStats stats, double tfn)`
`Explanation` NormalizationH2.`explain(BasicStats stats, double tf, double len)`
`Explanation` NormalizationZ.`explain(BasicStats stats, double tf, double len)`
`Explanation` Distribution.`explain(BasicStats stats, double tfn, double lambda)` Explains the score.
`Explanation` BasicModelG.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`Explanation` BasicModelIn.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`Explanation` NormalizationH3.`explain(BasicStats stats, double tf, double len)`
`abstract Explanation` BasicModel.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)` Returns an explanation for the score.
`Explanation` BasicModelIF.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`Explanation` NormalizationH1.`explain(BasicStats stats, double tf, double len)`
`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` BasicModelIne.`explain(BasicStats stats, double tfn, double aeTimes1pTfn)`
`protected Explanation` Axiomatic.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` DFISimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` IBSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` DFRSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` LMJelinekMercerSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` SimilarityBase.`explain(BasicStats stats, Explanation freq, double docLen)` Explains the score.
`protected Explanation` LMDirichletSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`Explanation` Similarity.SimScorer.`explain(Explanation freq, long norm)` Explain the score for a single document
`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` AxiomaticF2EXP.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3LOG.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1EXP.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3EXP.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF2LOG.`idfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1LOG.`idfExplain(BasicStats stats, double freq, double docLen)`
`Explanation` BM25Similarity.`idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)` Computes a score factor for a simple term and returns an explanation for that score factor.
`Explanation` ClassicSimilarity.`idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)`
`Explanation` TFIDFSimilarity.`idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)` Computes a score factor for a simple term and returns an explanation for that score factor.
`Explanation` BM25Similarity.`idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)` Computes a score factor for a phrase.
`Explanation` TFIDFSimilarity.`idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)` Computes a score factor for a phrase.
`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` AxiomaticF2EXP.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3LOG.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1EXP.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3EXP.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF2LOG.`lnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1LOG.`lnExplain(BasicStats stats, double freq, double docLen)`
`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` AxiomaticF2EXP.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3LOG.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1EXP.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3EXP.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF2LOG.`tfExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1LOG.`tfExplain(BasicStats stats, double freq, double docLen)`
`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` AxiomaticF2EXP.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3LOG.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1EXP.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF3EXP.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF2LOG.`tflnExplain(BasicStats stats, double freq, double docLen)`
`protected Explanation` AxiomaticF1LOG.`tflnExplain(BasicStats stats, double freq, double docLen)`

Methods in org.apache.lucene.search.similarities with parameters of type Explanation
`protected Explanation` Axiomatic.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` DFISimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` IBSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` DFRSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` LMJelinekMercerSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`protected Explanation` SimilarityBase.`explain(BasicStats stats, Explanation freq, double docLen)` Explains the score.
`protected Explanation` LMDirichletSimilarity.`explain(BasicStats stats, Explanation freq, double docLen)`
`Explanation` Similarity.SimScorer.`explain(Explanation freq, long norm)` Explain the score for a single document

Method parameters in org.apache.lucene.search.similarities with type arguments of type Explanation
`protected void` Axiomatic.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected void` LMSimilarity.`explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen)`
`protected void` IBSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected void` DFRSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected void` LMJelinekMercerSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`
`protected void` SimilarityBase.`explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen)` Subclasses should implement this method to explain the score.
`protected void` LMDirichletSimilarity.`explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)`

### Uses of Explanation in org.apache.lucene.search.spans

Methods in org.apache.lucene.search.spans that return Explanation
`Explanation` SpanWeight.`explain(LeafReaderContext context, int doc)`