Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class NormalizationH2

    Normalization model in which the term frequency is inversely related to the length.

    While this model is parameterless in the original article, the thesis introduces the parameterized variant. The default value for the c parameter is 1.

    Note

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

    Inheritance
    object
    Normalization
    NormalizationH2
    Inherited Members
    Normalization.Explain(BasicStats, float, float)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search.Similarities
    Assembly: Lucene.Net.dll
    Syntax
    public class NormalizationH2 : Normalization

    Constructors

    NormalizationH2()

    Calls NormalizationH2(1)

    Declaration
    public NormalizationH2()

    NormalizationH2(float)

    Creates NormalizationH2 with the supplied parameter c.

    Declaration
    public NormalizationH2(float c)
    Parameters
    Type Name Description
    float c

    Hyper-parameter that controls the term frequency normalization with respect to the document length.

    Properties

    C

    Returns the c parameter.

    Declaration
    public virtual float C { get; }
    Property Value
    Type Description
    float
    See Also
    NormalizationH2(float)

    Methods

    Tfn(BasicStats, float, float)

    Returns the normalized term frequency.

    Declaration
    public override sealed float Tfn(BasicStats stats, float tf, float len)
    Parameters
    Type Name Description
    BasicStats stats
    float tf
    float len

    the field length.

    Returns
    Type Description
    float
    Overrides
    Normalization.Tfn(BasicStats, float, float)

    ToString()

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

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    Normalization.ToString()
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.