Package de.labathome.trustconstr.records

Record Class ApproxDerivativeResult

java.lang.Object
java.lang.Record
de.labathome.trustconstr.records.ApproxDerivativeResult
Record Components:
jacobian - computed FD Jacobian (m x n)
info - metadata about the FD calculation; keys include "nfev" (Integer: number of function evaluations consumed) and "method" (FiniteDifferenceMethod)
public record ApproxDerivativeResult(Matrix jacobian, Map<String,Object> info) extends Record
Output shape of NumDiff.approxDerivativeFullOutput(java.util.function.BiFunction<de.labathome.trustconstr.matrix.Matrix, java.lang.Object, de.labathome.trustconstr.matrix.Matrix>, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.records.FiniteDifferenceOptions, java.lang.Object). Mirrors scipy's approx_derivative(..., full_output=True) 2-tuple (jac, info_dict).

  • Constructor Details

    • ApproxDerivativeResult

      public ApproxDerivativeResult(Matrix jacobian, Map<String,Object> info)
      Creates an instance of a ApproxDerivativeResult record class.
      Parameters:
      jacobian - the value for the jacobian record component
      info - the value for the info 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.

    • jacobian

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

    • info

      public Map<String,Object> info()
      Returns the value of the info record component.
      Returns:
      the value of the info record component