Enum Class ExitStatus

java.lang.Object
java.lang.Enum<ExitStatus>
org.wpilib.math.optimization.solver.ExitStatus
All Implemented Interfaces:
Serializable, Comparable<ExitStatus>, Constable
public enum ExitStatus extends Enum<ExitStatus>
Solver exit status. Negative values indicate failure.

  • Enum Constant Details

    • SUCCESS

      public static final ExitStatus SUCCESS
      Solved the problem to the desired tolerance.

    • CALLBACK_REQUESTED_STOP

      public static final ExitStatus CALLBACK_REQUESTED_STOP
      The solver returned its solution so far after the user requested a stop.

    • TOO_FEW_DOFS

      public static final ExitStatus TOO_FEW_DOFS
      The solver determined the problem to be overconstrained and gave up.

    • LOCALLY_INFEASIBLE

      public static final ExitStatus LOCALLY_INFEASIBLE
      The solver determined the problem to be locally infeasible and gave up.

    • GLOBALLY_INFEASIBLE

      public static final ExitStatus GLOBALLY_INFEASIBLE
      The problem setup frontend determined the problem to have an empty feasible region.

    • FACTORIZATION_FAILED

      public static final ExitStatus FACTORIZATION_FAILED
      The linear system factorization failed.

    • LINE_SEARCH_FAILED

      public static final ExitStatus LINE_SEARCH_FAILED
      The backtracking line search failed, and the problem isn't locally infeasible.

    • FEASIBILITY_RESTORATION_FAILED

      public static final ExitStatus FEASIBILITY_RESTORATION_FAILED
      The solver failed to reach the desired tolerance, and feasibility restoration failed to converge.

    • NONFINITE_INITIAL_GUESS

      public static final ExitStatus NONFINITE_INITIAL_GUESS
      The solver encountered nonfinite initial cost, constraints, or derivatives and gave up.

    • DIVERGING_ITERATES

      public static final ExitStatus DIVERGING_ITERATES
      The solver encountered diverging primal iterates xₖ and/or sₖ and gave up.

    • MAX_ITERATIONS_EXCEEDED

      public static final ExitStatus MAX_ITERATIONS_EXCEEDED
      The solver returned its solution so far after exceeding the maximum number of iterations.

    • TIMEOUT

      public static final ExitStatus TIMEOUT
      The solver returned its solution so far after exceeding the maximum elapsed wall clock time.

  • Field Details

    • value

      public final int value
      ExitStatus value.

  • Method Details

    • values

      public static ExitStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ExitStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromInt

      public static ExitStatus fromInt(int x)
      Converts integer to its corresponding enum value.
      Parameters:
      x - The integer.
      Returns:
      The enum value.