core/org.gnit.lucenekmp.search.similarities/AfterEffect

AfterEffect

abstract class AfterEffect

This class acts as the base class for the implementations of the first normalization of the informative content in the DFR framework. This component is also called the after effect and is defined by the formula Inf₂ = 1 - Prob₂, where Prob₂ measures the information gain.

See also

Inheritors

Constructors

constructor()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Functions

abstract fun explain(stats: BasicStats, tfn: Double): Explanation

Returns an explanation for the score.

scoreTimes1pTfn

abstract fun scoreTimes1pTfn(stats: BasicStats): Double

Returns the product of the after effect with 1+tfn. This may not depend on the value of tfn.

abstract override fun toString(): String

Subclasses must override this method to return the code of the after effect formula. Refer to the original paper for the list.