Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class BasicModelIn

    The basic tf-idf model of randomness.

    Note

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

    Inheritance
    object
    BasicModel
    BasicModelIn
    Inherited Members
    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 BasicModelIn : BasicModel

    Constructors

    BasicModelIn()

    Sole constructor: parameter-free

    Declaration
    public BasicModelIn()

    Methods

    Explain(BasicStats, float)

    Returns an explanation for the score.

    Most basic models use the number of documents and the total term frequency to compute Inf1. this method provides a generic explanation for such models. Subclasses that use other statistics must override this method.

    Declaration
    public override sealed Explanation Explain(BasicStats stats, float tfn)
    Parameters
    Type Name Description
    BasicStats stats
    float tfn
    Returns
    Type Description
    Explanation
    Overrides
    BasicModel.Explain(BasicStats, float)

    Score(BasicStats, float)

    Returns the informative content score.

    Declaration
    public override sealed float Score(BasicStats stats, float tfn)
    Parameters
    Type Name Description
    BasicStats stats
    float tfn
    Returns
    Type Description
    float
    Overrides
    BasicModel.Score(BasicStats, float)

    ToString()

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

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    BasicModel.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.