Package de.labathome.trustconstr.records

Class StatefulResult

java.lang.Object
de.labathome.trustconstr.records.StatefulResult
public final class StatefulResult extends Object
Inner-loop result from EqualityConstrainedSQP.eqSQP(de.labathome.trustconstr.interfaces.IFunctionAndConstraint, de.labathome.trustconstr.interfaces.IGradientAndJacobian, de.labathome.trustconstr.interfaces.LagrangeHessian, de.labathome.trustconstr.matrix.Matrix, double, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.interfaces.StoppingCriterion, de.labathome.trustconstr.records.State, double, double, de.labathome.trustconstr.enums.ProjectionMethod, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.interfaces.LinearOperator) and TrustRegionInteriorPoint.trustRegionInteriorPoint(java.util.function.ToDoubleBiFunction<de.labathome.trustconstr.matrix.Matrix, java.lang.Object>, java.util.function.BiFunction<de.labathome.trustconstr.matrix.Matrix, java.lang.Object, de.labathome.trustconstr.matrix.Matrix>, de.labathome.trustconstr.interfaces.LagrangeHessian, int, int, int, de.labathome.trustconstr.interfaces.Constraint, de.labathome.trustconstr.interfaces.Jacobian, de.labathome.trustconstr.matrix.Matrix, double, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.matrix.Matrix, de.labathome.trustconstr.interfaces.GlobalStoppingCriteria, boolean[], double, de.labathome.trustconstr.records.State, double, double, double, double, de.labathome.trustconstr.enums.ProjectionMethod). Carries the final iterate, the threaded-through State, and the final Lagrange-multiplier vector.

  • Constructor Details

    • StatefulResult

      public StatefulResult(Matrix x, State state)
      Parameters:
      x - final iterate (n x 1)
      state - final outer-loop state

    • StatefulResult

      public StatefulResult(Matrix x, State state, Matrix v)
      Parameters:
      x - final iterate (n x 1)
      state - final outer-loop state
      v - final Lagrange multipliers (may be null)

  • Method Details

    • x

      public Matrix x()
      Returns:
      the final iterate

    • state

      public State state()
      Returns:
      the final outer-loop state

    • v

      public Matrix v()
      Final Lagrange multiplier vector from the inner SQP loop.

      For pure-equality problems this is the equality multiplier, length nEq. For interior-point dispatch it is the augmented-system multiplier from the last barrier subproblem, length nEq + nIneq -- first nEq entries are equality multipliers, remaining nIneq entries are inequality (slack-row) multipliers corresponding to the original problem's lambda.

      Returns:
      final multiplier vector, or null if not populated