Package de.labathome.trustconstr.records

Record Class EqIneqSplit

java.lang.Object
java.lang.Record
de.labathome.trustconstr.records.EqIneqSplit
Record Components:
eq - equality component
ineq - inequality component
public record EqIneqSplit(Matrix eq, Matrix ineq) extends Record
Pair of canonical equality and inequality components produced by a CanonicalConstraint's fun(x) or jac(x). Mirrors scipy's tuple return shape from canonical_constraint.py.

For fun(x): eq is nEq x 1, ineq is nIneq x 1 (column vectors of canonical residuals).

For jac(x): eq is nEq x n, ineq is nIneq x n (canonical Jacobian blocks).

  • Constructor Summary

    Constructors
    Constructor
    Description
    EqIneqSplit(Matrix eq, Matrix ineq)
    Creates an instance of a EqIneqSplit record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Matrix
    eq()
    Returns the value of the eq 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.
    Matrix
    ineq()
    Returns the value of the ineq record component.
    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

    • EqIneqSplit

      public EqIneqSplit(Matrix eq, Matrix ineq)
      Creates an instance of a EqIneqSplit record class.
      Parameters:
      eq - the value for the eq record component
      ineq - the value for the ineq 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.

    • eq

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

    • ineq

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