Package io.github.kirstenali.deepj.nn

Record Class RecurrentResult

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.nn.RecurrentResult
public record RecurrentResult(Tensor sequence, RecurrentState state) extends Record
Batch-first sequence output and the final state of a recurrent layer.

  • Constructor Details

    • RecurrentResult

      public RecurrentResult(Tensor sequence, RecurrentState state)
      Creates an instance of a RecurrentResult record class.
      Parameters:
      sequence - the value for the sequence record component
      state - the value for the state 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • sequence

      public Tensor sequence()
      Returns the value of the sequence record component.
      Returns:
      the value of the sequence record component

    • state

      public RecurrentState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component