add return from callback field in result struct

m3g · Jul 22, 2023 · 3b4b779 · 3b4b779
1 parent 97ad246
commit 3b4b779
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/src/SPGBoxResult.jl b/src/SPGBoxResult.jl
@@ -29,13 +29,14 @@ struct SPGBoxResult{T,F,G}
     nit::Int64
     nfeval::Int64
     ierr::Int64
+    return_from_callback::Bool
 end
 
 function Base.show(io::IO, R::SPGBoxResult)
     println("")
     println(" SPGBOX RESULT: ")
     println("")
-    R.ierr == 0 && println(" Convergence achieved. ")
+    R.ierr == 0 && println(" Convergence achieved (Return from callback: $return_from_callback). ")
     R.ierr == 1 && println(" Maximum number of iterations (nitmax) reached.")
     R.ierr == 2 && println(" Maximum number of function evaluations (nfevalmax) reached.")
     println("")

diff --git a/src/spgbox_main.jl b/src/spgbox_main.jl
@@ -199,7 +199,7 @@ function spgbox!(
     nfeval = 1
     fcurrent = fg!(g, x)
     gnorm = pr_gradnorm(g, x, lower, upper)
-    gnorm <= eps && return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0)
+    gnorm <= eps && return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0, false)
 
     # Do a consertive initial step
     small = T(sqrt(Base.eps(T)))
@@ -236,7 +236,7 @@ function spgbox!(
             safequad_ls(xn, gn, x, g, fcurrent, tspg, fref, nfevalmax - nfeval, iprint, func_only, fg!, lower, upper)
 
         if lsfeval < 0
-            return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval - lsfeval, 2)
+            return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval - lsfeval, 2, false)
         else
             nfeval += lsfeval
         end
@@ -268,17 +268,17 @@ function spgbox!(
         gnorm = pr_gradnorm(g, x, lower, upper)
 
         # Call callback function
-        return_from_callback = callback(SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0))
+        return_from_callback = callback(SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0, false))
         if return_from_callback
-            return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0)
+            return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0, true)
         end
 
         # Check convergence
-        gnorm <= eps && return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0)
+        gnorm <= eps && return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 0, false)
     end
 
     # Maximum number of iterations achieved
-    return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 1)
+    return SPGBoxResult(x, fcurrent, gnorm, nit, nfeval, 1, false)
 end
 
 "Perform a safeguarded quadratic line search"