Record Class TensorDescriptor

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.tensor.TensorDescriptor

public record TensorDescriptor(DType dtype, int[] shape) extends Record
Validated logical checkpoint metadata; reading it never allocates tensor values.
  • Constructor Details

    • TensorDescriptor

      public TensorDescriptor(DType dtype, int[] shape)
      Creates an instance of a TensorDescriptor record class.
      Parameters:
      dtype - the value for the dtype record component
      shape - the value for the shape record component
  • Method Details

    • shape

      public int[] shape()
      Returns the value of the shape record component.
      Returns:
      the value of the shape record component
    • elements

      public int elements()
    • bytes

      public long bytes()
    • requireMatches

      public void requireMatches(Tensor tensor) throws IOException
      Throws:
      IOException
    • requireMatches

      public void requireMatches(DType expectedType, int[] expectedShape) throws IOException
      Throws:
      IOException
    • write

      public void write(DataOutput output) throws IOException
      Throws:
      IOException
    • read

      public static TensorDescriptor read(DataInput input) throws IOException
      Throws:
      IOException
    • equals

      public boolean equals(Object other)
      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:
      other - the object with which to compare
      Returns:
      true if this object is the same as the other argument; false otherwise.
    • 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
    • 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
    • dtype

      public DType dtype()
      Returns the value of the dtype record component.
      Returns:
      the value of the dtype record component