Package io.github.kirstenali.deepj.nn

Record Class RecurrentState

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.nn.RecurrentState
public record RecurrentState(Tensor hidden, Tensor cell) extends Record
Explicit caller-owned state. Cell memory is present only for LSTM.

  • Constructor Details

    • RecurrentState

      public RecurrentState(Tensor hidden, Tensor cell)
      Creates an instance of a RecurrentState record class.
      Parameters:
      hidden - the value for the hidden record component
      cell - the value for the cell record component

    • RecurrentState

      public RecurrentState(Tensor hidden)

  • Method Details

    • detach

      public RecurrentState detach()

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

    • hidden

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

    • cell

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