Package rocks.palaiologos.maja.matrix

Record Class DoubleSVDResult

java.lang.Object
java.lang.Record
rocks.palaiologos.maja.matrix.DoubleSVDResult
@Desugar public record DoubleSVDResult(int rank, double norm, double conditionNumber, double inverseConditionNumber, double[] singularValues, DoubleMatrix U, DoubleMatrix V) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final double
    conditionNumber
    The field for the conditionNumber record component.
    private final double
    inverseConditionNumber
    The field for the inverseConditionNumber record component.
    private final double
    norm
    The field for the norm record component.
    private final int
    rank
    The field for the rank record component.
    private final double[]
    singularValues
    The field for the singularValues record component.
    private final DoubleMatrix
    U
    The field for the U record component.
    private final DoubleMatrix
    V
    The field for the V record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DoubleSVDResult(int rank, double norm, double conditionNumber, double inverseConditionNumber, double[] singularValues, DoubleMatrix U, DoubleMatrix V)
    Creates an instance of a DoubleSVDResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    conditionNumber()
    Returns the value of the conditionNumber record component.
    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.
    double
    inverseConditionNumber()
    Returns the value of the inverseConditionNumber record component.
    double
    norm()
    Returns the value of the norm record component.
    int
    rank()
    Returns the value of the rank record component.
    double[]
    singularValues()
    Returns the value of the singularValues record component.
    final String
    toString()
    Returns a string representation of this record class.
    DoubleMatrix
    U()
    Returns the value of the U record component.
    DoubleMatrix
    V()
    Returns the value of the V record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • rank

      private final int rank
      The field for the rank record component.

    • norm

      private final double norm
      The field for the norm record component.

    • conditionNumber

      private final double conditionNumber
      The field for the conditionNumber record component.

    • inverseConditionNumber

      private final double inverseConditionNumber
      The field for the inverseConditionNumber record component.

    • singularValues

      private final double[] singularValues
      The field for the singularValues record component.

    • U

      private final DoubleMatrix U
      The field for the U record component.

    • V

      private final DoubleMatrix V
      The field for the V record component.

  • Constructor Details

    • DoubleSVDResult

      public DoubleSVDResult(int rank, double norm, double conditionNumber, double inverseConditionNumber, double[] singularValues, DoubleMatrix U, DoubleMatrix V)
      Creates an instance of a DoubleSVDResult record class.
      Parameters:
      rank - the value for the rank record component
      norm - the value for the norm record component
      conditionNumber - the value for the conditionNumber record component
      inverseConditionNumber - the value for the inverseConditionNumber record component
      singularValues - the value for the singularValues record component
      U - the value for the U record component
      V - the value for the V 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • rank

      public int rank()
      Returns the value of the rank record component.
      Returns:
      the value of the rank record component

    • norm

      public double norm()
      Returns the value of the norm record component.
      Returns:
      the value of the norm record component

    • conditionNumber

      public double conditionNumber()
      Returns the value of the conditionNumber record component.
      Returns:
      the value of the conditionNumber record component

    • inverseConditionNumber

      public double inverseConditionNumber()
      Returns the value of the inverseConditionNumber record component.
      Returns:
      the value of the inverseConditionNumber record component

    • singularValues

      public double[] singularValues()
      Returns the value of the singularValues record component.
      Returns:
      the value of the singularValues record component

    • U

      public DoubleMatrix U()
      Returns the value of the U record component.
      Returns:
      the value of the U record component

    • V

      public DoubleMatrix V()
      Returns the value of the V record component.
      Returns:
      the value of the V record component