Package de.labathome.trustconstr

Record Class CanonicalConstraint.InitialCanonical

java.lang.Object
java.lang.Record
de.labathome.trustconstr.CanonicalConstraint.InitialCanonical
Record Components:
cEq - equality residual at x0 (nEq x 1)
cIneq - inequality residual at x0 (nIneq x 1)
JEq - equality Jacobian at x0 (nEq x n)
JIneq - inequality Jacobian at x0 (nIneq x n)
Enclosing class:
CanonicalConstraint
public static record CanonicalConstraint.InitialCanonical(Matrix cEq, Matrix cIneq, Matrix JEq, Matrix JIneq) extends Record
Output shape of CanonicalConstraint.initialConstraintsAsCanonical(int, java.util.List<de.labathome.trustconstr.CanonicalConstraint>, de.labathome.trustconstr.matrix.Matrix, boolean): the four arrays (cEq, cIneq, JEq, JIneq) returned as a record. Mirrors scipy's 4-tuple return value.

  • Constructor Details

    • InitialCanonical

      public InitialCanonical(Matrix cEq, Matrix cIneq, Matrix JEq, Matrix JIneq)
      Creates an instance of a InitialCanonical record class.
      Parameters:
      cEq - the value for the cEq record component
      cIneq - the value for the cIneq record component
      JEq - the value for the JEq record component
      JIneq - the value for the JIneq 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.

    • cEq

      public Matrix cEq()
      Returns the value of the cEq record component.
      Returns:
      the value of the cEq record component

    • cIneq

      public Matrix cIneq()
      Returns the value of the cIneq record component.
      Returns:
      the value of the cIneq record component

    • JEq

      public Matrix JEq()
      Returns the value of the JEq record component.
      Returns:
      the value of the JEq record component

    • JIneq

      public Matrix JIneq()
      Returns the value of the JIneq record component.
      Returns:
      the value of the JIneq record component