Package io.github.kirstenali.deepj.tokenizers.bpe

Record Class TokenPair

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.tokenizers.bpe.TokenPair
All Implemented Interfaces:
Comparable<TokenPair>
public record TokenPair(int left, int right) extends Record implements Comparable<TokenPair>

  • Constructor Summary

    Constructors
    Constructor
    Description
    TokenPair(int left, int right)
    Creates an instance of a TokenPair record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(TokenPair other)
     
    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.
    int
    left()
    Returns the value of the left record component.
    int
    right()
    Returns the value of the right record component.
    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

    • TokenPair

      public TokenPair(int left, int right)
      Creates an instance of a TokenPair record class.
      Parameters:
      left - the value for the left record component
      right - the value for the right record component

  • Method Details

    • compareTo

      public int compareTo(TokenPair other)
      Specified by:
      compareTo in interface Comparable<TokenPair>

    • 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.

    • left

      public int left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • right

      public int right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component