Record Class QRResult<E>

java.lang.Object
java.lang.Record
org.episteme.core.mathematics.linearalgebra.matrices.solvers.QRResult<E>
Type Parameters:
E - the element type
Record Components:
Q - the orthogonal matrix
R - the upper triangular matrix
public record QRResult<E>(Matrix<E> Q, Matrix<E> R) extends Record
Result of a QR decomposition.

A = Q * R

  • Constructor Details

    • QRResult

      public QRResult(Matrix<E> Q, Matrix<E> R)
      Creates an instance of a QRResult record class.
      Parameters:
      Q - the value for the Q record component
      R - the value for the R record component

  • Method Details

    • getQ

      public Matrix<E> getQ()

    • getR

      public Matrix<E> getR()

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

    • Q

      public Matrix<E> Q()
      Returns the value of the Q record component.
      Returns:
      the value of the Q record component

    • R

      public Matrix<E> R()
      Returns the value of the R record component.
      Returns:
      the value of the R record component