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

- Packages that use CollectionStatistics
  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 CollectionStatistics in org.apache.lucene.search

    Methods in org.apache.lucene.search that return CollectionStatistics
    Modifier and Type | Method and Description
    --- | ---
    `CollectionStatistics` | IndexSearcher.`collectionStatistics(String field)` Returns `CollectionStatistics` for a field.

  - ### Uses of CollectionStatistics in org.apache.lucene.search.similarities

    Methods in org.apache.lucene.search.similarities with parameters of type CollectionStatistics
    Modifier and Type | Method and Description
    --- | ---
    `protected float` | BM25Similarity.`avgFieldLength(CollectionStatistics collectionStats)` The default implementation computes the average as `sumTotalTermFreq / maxDoc`, or returns `1` if the index does not store sumTotalTermFreq (Lucene 3.x indexes or any field that omits frequency information).
    `Similarity.SimWeight` | TFIDFSimilarity.`computeWeight(float queryBoost, CollectionStatistics collectionStats, TermStatistics... termStats)`
    `Similarity.SimWeight` | SimilarityBase.`computeWeight(float queryBoost, CollectionStatistics collectionStats, TermStatistics... termStats)`
    `abstract Similarity.SimWeight` | Similarity.`computeWeight(float queryBoost, CollectionStatistics collectionStats, TermStatistics... termStats)` Compute any collection-level weight (e.g.
    `Similarity.SimWeight` | PerFieldSimilarityWrapper.`computeWeight(float queryBoost, CollectionStatistics collectionStats, TermStatistics... termStats)`
    `Similarity.SimWeight` | MultiSimilarity.`computeWeight(float queryBoost, CollectionStatistics collectionStats, TermStatistics... termStats)`
    `Similarity.SimWeight` | BM25Similarity.`computeWeight(float queryBoost, CollectionStatistics collectionStats, TermStatistics... termStats)`
    `protected void` | SimilarityBase.`fillBasicStats(BasicStats stats, CollectionStatistics collectionStats, TermStatistics termStats)` Fills all member fields defined in `BasicStats` in `stats`.
    `protected void` | LMSimilarity.`fillBasicStats(BasicStats stats, CollectionStatistics collectionStats, TermStatistics termStats)` Computes the collection probability of the current term in addition to the usual statistics.
    `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 simple term and returns an explanation for that score factor.
    `Explanation` | TFIDFSimilarity.`idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)` Computes a score factor for a phrase.
    `Explanation` | BM25Similarity.`idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)` Computes a score factor for a phrase.

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.