Record Class Relevance

java.lang.Object
java.lang.Record
smile.nlp.relevance.Relevance
Record Components:
text - the document to rank.
score - the relevance score.
All Implemented Interfaces:
Comparable<Relevance>
public record Relevance(Text text, double score) extends Record implements Comparable<Relevance>
In the context of information retrieval, relevance denotes how well a retrieved set of documents meets the information need of the user.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Relevance(Text text, double score)
    Creates an instance of a Relevance record class.

  • Method Summary

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

    Methods inherited from class Object

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

  • Constructor Details

    • Relevance

      public Relevance(Text text, double score)
      Creates an instance of a Relevance record class.
      Parameters:
      text - the value for the text record component
      score - the value for the score record component

  • Method Details

    • compareTo

      public int compareTo(Relevance o)
      Specified by:
      compareTo in interface Comparable<Relevance>

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • text

      public Text text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • score

      public double score()
      Returns the value of the score record component.
      Returns:
      the value of the score record component