Package com.yahoo.prelude.query

Record Class DocumentFrequency

java.lang.Object
java.lang.Record
com.yahoo.prelude.query.DocumentFrequency
Record Components:
frequency - The number of documents in which an item occurs
count - The total number of documents in the corpus
public record DocumentFrequency(long frequency, long count) extends Record
The expected number of documents matching an item given a corpus of multiple documents. This is the raw data used to calculate variants of idf, used as significance.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentFrequency(long frequency, long count)
    Creates an instance of a DocumentFrequency record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    count()
    Returns the value of the count record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    frequency()
    Returns the value of the frequency record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DocumentFrequency

      public DocumentFrequency(long frequency, long count)
      Creates an instance of a DocumentFrequency record class.
      Parameters:
      frequency - the value for the frequency record component
      count - the value for the count record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • frequency

      public long frequency()
      Returns the value of the frequency record component.
      Returns:
      the value of the frequency record component

    • count

      public long count()
      Returns the value of the count record component.
      Returns:
      the value of the count record component