Update TerminationCode names and add ObjectiveNotFinite (#1156)

* Update TerminationCode names and add ObjectiveNotFinite

* Update types.jl

Author: pkofod

src/multivariate/optimize/optimize.jl

@@ -182,18 +182,18 @@ function _termination_code(d, gres, state, stopped_by, options)
     if state isa NelderMeadState && gres <= options.g_abstol
         TerminationCode.NelderMeadCriterion
     elseif !(state isa NelderMeadState) && gres <= options.g_abstol
-        TerminationCode.FirstOrder
+        TerminationCode.GradientNorm
     elseif (iszero(options.x_abstol) && x_abschange(state) <= options.x_abstol) ||
            (iszero(options.x_reltol) && x_relchange(state) <= options.x_reltol)
         TerminationCode.NoXChange
     elseif (iszero(options.f_abstol) && f_abschange(d, state) <= options.f_abstol) ||
            (iszero(options.f_reltol) && f_relchange(d, state) <= options.f_reltol)
-        TerminationCode.NoFChange
+        TerminationCode.NoObjectiveChange
     elseif x_abschange(state) <= options.x_abstol || x_relchange(state) <= options.x_reltol
         TerminationCode.SmallXChange
     elseif f_abschange(d, state) <= options.f_abstol ||
            f_relchange(d, state) <= options.f_reltol
-        TerminationCode.SmallFChange
+        TerminationCode.SmallObjectiveChange
     elseif stopped_by.ls_failed
         TerminationCode.FailedLinesearch
     elseif stopped_by.callback
@@ -203,13 +203,15 @@ function _termination_code(d, gres, state, stopped_by, options)
     elseif stopped_by.time_limit
         TerminationCode.Time
     elseif stopped_by.f_limit_reached
-        TerminationCode.FCall
+        TerminationCode.ObjectiveCalls
     elseif stopped_by.g_limit_reached
-        TerminationCode.Gcall
+        TerminationCode.GradientCalls
     elseif stopped_by.h_limit_reached
-        TerminationCode.HCall
+        TerminationCode.HessianCalls
     elseif stopped_by.f_increased
-        TerminationCode.FIncreased
+        TerminationCode.ObjectiveIncreased
+    elseif f_calls(d) > 0 && !isfinite(value(d))
+        TerminationCode.GradientNotFinite
     elseif g_calls(d) > 0 && !all(isfinite, gradient(d))
         TerminationCode.GradientNotFinite
     elseif h_calls(d) > 0 && !(d isa TwiceDifferentiableHV) && !all(isfinite, hessian(d))

src/types.jl

@@ -204,15 +204,15 @@ using EnumX
     "Nelder-Mead simplex converged."
     NelderMeadCriterion
     "First (partial) derivative had a magnitude below the prescribed tolerance."
-    FirstOrder
+    GradientNorm
     "The change in optimization variables was zero (the tolerance was not set by the user)."
     NoXChange
     "The change in the objective was zero (the tolerance was not set by the user)."
-    NoFChange
+    NoObjectiveChange
     "The change in the optimization variables was below the prescribed tolerance."
     SmallXChange
     "The change in the objective was below the prescribed tolerance."
-    SmallFChange
+    SmallObjectiveChange
     "The line search failed to find a point that decreased the objective."
     FailedLinesearch
     "User callback returned `true`."
@@ -222,13 +222,15 @@ using EnumX
     "Time budget was exceeded."
     Time
     "Objective function evaluations exceeded the maximum number allowed."
-    FCall
+    ObjectiveCalls
     "Gradient evaluations exceeded the maximum number allowed."
-    Gcall
+    GradientCalls
     "Hessian evaluations exceeded the maximum number allowed."
-    HCall
+    HessianCalls
     "Objective function value increased."
-    FIncreased
+    ObjectiveIncreased
+    "Objective function was not finite"
+    ObjectiveNotFinite
     "Gradient was not finite"
     GradientNotFinite
     "Hessian was not finite"

test/general/api.jl

@@ -161,7 +161,7 @@
 
 
     resgterm = optimize(f, g!, initial_x, BFGS(), Optim.Options(g_tol = 1e12))
-    Optim.termination_code(resgterm) == Optim.TerminationCode.FirstOrder
+    Optim.termination_code(resgterm) == Optim.TerminationCode.GradientNorm
 
     resx0term = optimize(
         f,