Record Class Tuple<T>

java.lang.Object
java.lang.Record
org.flag4j.arrays.Tuple<T>
Type Parameters:
T - The type of the elements in the tuple.
Record Components:
data - The values of the tuple.
public record Tuple<T>(T[] data) extends Record

Data record to store an ordered list of values (i.e., an n-tuple).

Tuples are immutable.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Tuple(T... data)
    Creates an instance of a Tuple record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    T[]
    data()
    Returns the value of the data record component.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    int
    size()
    Gets the size of the tuple.
    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

    • Tuple

      public Tuple(T... data)
      Creates an instance of a Tuple record class.
      Parameters:
      data - the value for the data record component

  • Method Details

    • size

      public int size()
      Gets the size of the tuple.
      Returns:
      The size of this tuple.

    • hashCode

      public 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 boolean equals(Object obj)
      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 Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      obj - the object with which to compare
      Returns:
      true if this object is the same as the obj argument; false otherwise.

    • toString

      public 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

    • data

      public T[] data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component