IndependenceSaturated (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.search.similarities, class: IndependenceSaturated

Package org.apache.lucene.search.similarities

# Class IndependenceSaturated

java.lang.Object
org.apache.lucene.search.similarities.Independence
org.apache.lucene.search.similarities.IndependenceSaturated

public class IndependenceSaturated extends Independence
Saturated measure of distance from independence

Described as: "for tasks that require high recall against long queries"

WARNING: This API is experimental and might change in incompatible ways in the next release.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `IndependenceSaturated()`
  Sole constructor.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `double`
  `score(double freq, double expected)`
  Computes distance from independence
  `String`
  `toString()`

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### IndependenceSaturated

    public IndependenceSaturated()
    Sole constructor.

- ## Method Details

  - ### score

    public double score(double freq, double expected)
    Description copied from class: `Independence`
    Computes distance from independence
    Specified by:
      `score` in class `Independence`
    Parameters:
      `freq` - actual term frequency
      `expected` - expected term frequency

  - ### toString

    public String toString()
    Specified by:
      `toString` in class `Independence`