Uses of Class
org.apache.lucene.search.Explanation
-
Packages that use Explanation Package Description 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. -
-
Uses of Explanation in org.apache.lucene.search
Methods in org.apache.lucene.search that return Explanation Modifier and Type Method Description ExplanationConstantScoreWeight. explain(LeafReaderContext context, int doc)ExplanationDisjunctionMaxQuery.DisjunctionMaxWeight. explain(LeafReaderContext context, int doc)Explain the score we computed for docExplanationDoubleValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)An explanation of the value for the named document.ExplanationFilterWeight. explain(LeafReaderContext context, int doc)ExplanationIndexSearcher. explain(Query query, int doc)Returns an Explanation that describes howdocscored againstquery.protected ExplanationIndexSearcher. explain(Weight weight, int doc)Expert: low-level implementation method Returns an Explanation that describes howdocscored againstweight.ExplanationIndriAndWeight. explain(LeafReaderContext context, int doc)ExplanationLeafSimScorer. explain(int doc, Explanation freqExpl)Explain the score for the provided document assuming the given term document frequency.ExplanationPhraseWeight. explain(LeafReaderContext context, int doc)ExplanationQueryRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)abstract ExplanationRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)Explains how the score for the specified document was computed.ExplanationSortRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)abstract ExplanationWeight. explain(LeafReaderContext context, int doc)An explanation of the score computation for the named document.Explanation[]Explanation. getDetails()The sub-nodes of this explanation node.static ExplanationExplanation. match(Number value, String description, Collection<Explanation> details)Create a new explanation for a match.static ExplanationExplanation. match(Number value, String description, Explanation... details)Create a new explanation for a match.static ExplanationExplanation. noMatch(String description, Collection<Explanation> details)Create a new explanation for a document which does not match.static ExplanationExplanation. 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 Modifier and Type Method Description ExplanationDoubleValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)An explanation of the value for the named document.ExplanationLeafSimScorer. explain(int doc, Explanation freqExpl)Explain the score for the provided document assuming the given term document frequency.ExplanationQueryRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)abstract ExplanationRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)Explains how the score for the specified document was computed.ExplanationSortRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)static ExplanationExplanation. match(Number value, String description, Explanation... details)Create a new explanation for a match.static ExplanationExplanation. 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 Modifier and Type Method Description static ExplanationExplanation. match(Number value, String description, Collection<Explanation> details)Create a new explanation for a match.static ExplanationExplanation. 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 Modifier and Type Method Description abstract ExplanationAfterEffect. explain(BasicStats stats, double tfn)Returns an explanation for the score.ExplanationAfterEffectB. explain(BasicStats stats, double tfn)ExplanationAfterEffectL. explain(BasicStats stats, double tfn)protected ExplanationAxiomatic. explain(BasicStats stats, Explanation freq, double docLen)abstract ExplanationBasicModel. explain(BasicStats stats, double tfn, double aeTimes1pTfn)Returns an explanation for the score.ExplanationBasicModelG. explain(BasicStats stats, double tfn, double aeTimes1pTfn)ExplanationBasicModelIF. explain(BasicStats stats, double tfn, double aeTimes1pTfn)ExplanationBasicModelIn. explain(BasicStats stats, double tfn, double aeTimes1pTfn)ExplanationBasicModelIne. explain(BasicStats stats, double tfn, double aeTimes1pTfn)protected ExplanationDFISimilarity. explain(BasicStats stats, Explanation freq, double docLen)protected ExplanationDFRSimilarity. explain(BasicStats stats, Explanation freq, double docLen)ExplanationDistribution. explain(BasicStats stats, double tfn, double lambda)Explains the score.protected ExplanationIBSimilarity. explain(BasicStats stats, Explanation freq, double docLen)abstract ExplanationLambda. explain(BasicStats stats)Explains the lambda parameter.ExplanationLambdaDF. explain(BasicStats stats)ExplanationLambdaTTF. explain(BasicStats stats)protected ExplanationLMDirichletSimilarity. explain(BasicStats stats, Explanation freq, double docLen)protected ExplanationLMJelinekMercerSimilarity. explain(BasicStats stats, Explanation freq, double docLen)ExplanationNormalization. explain(BasicStats stats, double tf, double len)Returns an explanation for the normalized term frequency.ExplanationNormalization.NoNormalization. explain(BasicStats stats, double tf, double len)ExplanationNormalizationH1. explain(BasicStats stats, double tf, double len)ExplanationNormalizationH2. explain(BasicStats stats, double tf, double len)ExplanationNormalizationH3. explain(BasicStats stats, double tf, double len)ExplanationNormalizationZ. explain(BasicStats stats, double tf, double len)ExplanationSimilarity.SimScorer. explain(Explanation freq, long norm)Explain the score for a single documentprotected ExplanationSimilarityBase. explain(BasicStats stats, Explanation freq, double docLen)Explains the score.protected abstract ExplanationAxiomatic. idfExplain(BasicStats stats, double freq, double docLen)Explain the score of the inverted document frequency component for a single documentprotected ExplanationAxiomaticF1EXP. idfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF1LOG. idfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2EXP. idfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2LOG. idfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3EXP. idfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3LOG. idfExplain(BasicStats stats, double freq, double docLen)ExplanationBM25Similarity. idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)Computes a score factor for a simple term and returns an explanation for that score factor.ExplanationBM25Similarity. idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)Computes a score factor for a phrase.ExplanationClassicSimilarity. idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)ExplanationTFIDFSimilarity. idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)Computes a score factor for a simple term and returns an explanation for that score factor.ExplanationTFIDFSimilarity. idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)Computes a score factor for a phrase.protected abstract ExplanationAxiomatic. lnExplain(BasicStats stats, double freq, double docLen)Explain the score of the document length component for a single documentprotected ExplanationAxiomaticF1EXP. lnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF1LOG. lnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2EXP. lnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2LOG. lnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3EXP. lnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3LOG. lnExplain(BasicStats stats, double freq, double docLen)protected abstract ExplanationAxiomatic. tfExplain(BasicStats stats, double freq, double docLen)Explain the score of the term frequency component for a single documentprotected ExplanationAxiomaticF1EXP. tfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF1LOG. tfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2EXP. tfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2LOG. tfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3EXP. tfExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3LOG. tfExplain(BasicStats stats, double freq, double docLen)protected abstract ExplanationAxiomatic. tflnExplain(BasicStats stats, double freq, double docLen)Explain the score of the mixed term frequency and document length component for a single documentprotected ExplanationAxiomaticF1EXP. tflnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF1LOG. tflnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2EXP. tflnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF2LOG. tflnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3EXP. tflnExplain(BasicStats stats, double freq, double docLen)protected ExplanationAxiomaticF3LOG. tflnExplain(BasicStats stats, double freq, double docLen)Methods in org.apache.lucene.search.similarities with parameters of type Explanation Modifier and Type Method Description protected ExplanationAxiomatic. explain(BasicStats stats, Explanation freq, double docLen)protected ExplanationDFISimilarity. explain(BasicStats stats, Explanation freq, double docLen)protected ExplanationDFRSimilarity. explain(BasicStats stats, Explanation freq, double docLen)protected ExplanationIBSimilarity. explain(BasicStats stats, Explanation freq, double docLen)protected ExplanationLMDirichletSimilarity. explain(BasicStats stats, Explanation freq, double docLen)protected ExplanationLMJelinekMercerSimilarity. explain(BasicStats stats, Explanation freq, double docLen)ExplanationSimilarity.SimScorer. explain(Explanation freq, long norm)Explain the score for a single documentprotected ExplanationSimilarityBase. explain(BasicStats stats, Explanation freq, double docLen)Explains the score.Method parameters in org.apache.lucene.search.similarities with type arguments of type Explanation Modifier and Type Method Description protected voidAxiomatic. explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)protected voidDFRSimilarity. explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)protected voidIBSimilarity. explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)protected voidIndriDirichletSimilarity. explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)protected voidLMDirichletSimilarity. explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)protected voidLMJelinekMercerSimilarity. explain(List<Explanation> subs, BasicStats stats, double freq, double docLen)protected voidLMSimilarity. explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen)protected voidSimilarityBase. explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen)Subclasses should implement this method to explain the score.
-