Record Class ScoredEntry

java.lang.Object
java.lang.Record
com.tnsai.memory.advanced.ScoredEntry
Record Components:
entry - the memory entry
score - the retrieval score (higher is more relevant)

public record ScoredEntry(MemoryEntry entry, double score) extends Record
A memory entry paired with a retrieval score.

Used as the return type for search and fusion operations. Score semantics depend on the retrieval method (cosine similarity, BM25, RRF fused score, etc.).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScoredEntry(MemoryEntry entry, double score)
    Creates an instance of a ScoredEntry record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the entry record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    double
    Returns the value of the score record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • ScoredEntry

      public ScoredEntry(MemoryEntry entry, double score)
      Creates an instance of a ScoredEntry record class.
      Parameters:
      entry - the value for the entry record component
      score - the value for the score 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.
    • entry

      public MemoryEntry entry()
      Returns the value of the entry record component.
      Returns:
      the value of the entry record component
    • score

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