Package de.labathome.trustconstr.matrix

Record Class QRResult

java.lang.Object
java.lang.Record
de.labathome.trustconstr.matrix.QRResult
public record QRResult(DenseMatrix Q, DenseMatrix R) extends Record
QR factorisation of a tall-or-square matrix A (m x n with m >= n): A = Q R with Q (m x n) having orthonormal columns and R (n x n) upper triangular.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QRResult(DenseMatrix Q, DenseMatrix R)
    Creates an instance of a QRResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    DenseMatrix
    Q()
    Returns the value of the Q record component.
    DenseMatrix
    R()
    Returns the value of the R record component.
    DenseMatrix
    solve(DenseMatrix rhs)
    Least-squares solve: returns the n x p matrix x that minimises ||A x - rhs||_2, where A = Q R was the original input.
    final 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

    • QRResult

      public QRResult(DenseMatrix Q, DenseMatrix 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

    • solve

      public DenseMatrix solve(DenseMatrix rhs)
      Least-squares solve: returns the n x p matrix x that minimises ||A x - rhs||_2, where A = Q R was the original input. Computes x = R^-^1 Q^T rhs.
      Parameters:
      rhs - right-hand side (m x p)
      Returns:
      least-squares solution (n x p)

    • 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 DenseMatrix Q()
      Returns the value of the Q record component.
      Returns:
      the value of the Q record component

    • R

      public DenseMatrix R()
      Returns the value of the R record component.
      Returns:
      the value of the R record component