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

BasicModelIF

class BasicModelIF : BasicModel

An approximation of the I(n_e) model.

Constructors

BasicModelIF

constructor()

Sole constructor: parameter-free

Functions

explain

open override fun explain(stats: BasicStats, tfn: Double, aeTimes1pTfn: Double): Explanation

Returns an explanation for the score. Subclasses must override this method.

score

open override fun score(stats: BasicStats, tfn: Double, aeTimes1pTfn: Double): Double

Returns the informative content score combined with the after effect, more specifically informationContentScore * aeTimes1pTfn / (1 + tfn). This function must be non-decreasing with tfn.

toString

open override fun toString(): String

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