Class IterationInfo

java.lang.Object
org.wpilib.math.optimization.solver.IterationInfo

public class IterationInfo extends Object
Solver iteration information exposed to an iteration callback.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final org.ejml.simple.SimpleMatrix
    The equality constraint Jacobian (sparse internal storage).
    final org.ejml.simple.SimpleMatrix
    The inequality constraint Jacobian (sparse internal storage).
    final org.ejml.simple.SimpleMatrix
    The gradient of the cost function (sparse internal storage).
    final org.ejml.simple.SimpleMatrix
    The Hessian of the Lagrangian (sparse internal storage).
    final int
    The solver iteration.
    final org.ejml.simple.SimpleMatrix
    The decision variables (dense internal storage).
  • Constructor Summary

    Constructors
    Constructor
    Description
    IterationInfo(int iteration, org.ejml.simple.SimpleMatrix x, org.ejml.simple.SimpleMatrix g, org.ejml.simple.SimpleMatrix H, org.ejml.simple.SimpleMatrix A_e, org.ejml.simple.SimpleMatrix A_i)
    Constructs iteration info.
  • Method Summary

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • iteration

      public final int iteration
      The solver iteration.
    • x

      public final org.ejml.simple.SimpleMatrix x
      The decision variables (dense internal storage).
    • g

      public final org.ejml.simple.SimpleMatrix g
      The gradient of the cost function (sparse internal storage).
    • H

      public final org.ejml.simple.SimpleMatrix H
      The Hessian of the Lagrangian (sparse internal storage).
    • A_e

      public final org.ejml.simple.SimpleMatrix A_e
      The equality constraint Jacobian (sparse internal storage).
    • A_i

      public final org.ejml.simple.SimpleMatrix A_i
      The inequality constraint Jacobian (sparse internal storage).
  • Constructor Details

    • IterationInfo

      public IterationInfo(int iteration, org.ejml.simple.SimpleMatrix x, org.ejml.simple.SimpleMatrix g, org.ejml.simple.SimpleMatrix H, org.ejml.simple.SimpleMatrix A_e, org.ejml.simple.SimpleMatrix A_i)
      Constructs iteration info.
      Parameters:
      iteration - The solver iteration.
      x - The decision variables (dense internal storage).
      g - The gradient of the cost function (sparse internal storage).
      H - The Hessian of the Lagrangian (sparse internal storage).
      A_e - The equality constraint Jacobian (sparse internal storage).
      A_i - The inequality constraint Jacobian (sparse internal storage).