New output

Project.toml

@@ -20,6 +20,7 @@ ProgressLogging = "33c8b6b6-d38a-422a-b730-caa89a2f386c"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
+SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 TerminalLoggers = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"
 Tracker = "9f7883ad-71c0-57eb-9f7f-b5c9e6d3789c"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
@@ -39,6 +40,7 @@ ProgressLogging = "0.1"
 Reexport = "0.2, 1.0"
 Requires = "1.0"
 ReverseDiff = "1.4"
+SciMLBase = "1.7.3"
 TerminalLoggers = "0.1"
 Tracker = "0.2"
 Zygote = "0.5, 0.6"

src/GalacticOptim.jl

@@ -2,6 +2,7 @@ module GalacticOptim
 
 using Reexport
 @reexport using DiffEqBase
+@reexport using SciMLBase
 using Requires
 using DiffResults, ForwardDiff, Zygote, ReverseDiff, Tracker, FiniteDiff
 @reexport using Optim, Flux
@@ -10,6 +11,7 @@ using ArrayInterface, Base.Iterators
 
 using ForwardDiff: DEFAULT_CHUNK_THRESHOLD
 import DiffEqBase: OptimizationProblem, OptimizationFunction, AbstractADType
+import SciMLBase: AbstractNoTimeSolution, build_solution, AbstractNonlinearProblem
 
 import ModelingToolkit
 import ModelingToolkit: AutoModelingToolkit

src/solve.jl

@@ -1,31 +1,39 @@
-abstract type AbstractOptimizationSolution end #experimental; comments welcome
-mutable struct OptimizationSolution{O, Tx, Tf, Tls, Tsb} <: AbstractOptimizationSolution
-    method::O
-    initial_x::Tx
-    minimizer::Tx
+abstract type AbstractOptimizationSolution{T, N} <: AbstractNoTimeSolution{T, N} end
+
+struct OptimizationSolution{T, N, uType, P, A, Tf} <: AbstractOptimizationSolution{T, N}
+    u::uType # minimizer
+    prob::P # optimization problem
+    alg::A # algorithm
     minimum::Tf
-    iterations::Int
-    iteration_converged::Bool
-    ls_success::Tls
-    time_run::Float64
-    stopped_by::Tsb
+    initial_x::Array{Float64,1}
+    retcode::Symbol
+    original::String # original output of the optimizer
 end
 
-function Base.show(io::IO, r::AbstractOptimizationSolution)
-    take = Iterators.take
-    failure_string = "failure"
-    if isa(r.ls_success, Bool) && !r.ls_success
-        failure_string *= " (line search failed)"
-    end
+function build_solution(prob::AbstractNonlinearProblem,
+                        alg, u, minimum;
+                        initial_x = prob.u0,
+                        retcode = :Default,
+                        original = nothing,
+                        kwargs...)
+
+    T = eltype(eltype(u))
+    N = ndims(u)
+
+    OptimizationSolution{T, N, typeof(u), typeof(prob), typeof(alg),
+                         typeof(minimum)}
+                         (u, prob, alg, minimum, initial_x,
+                          retcode, original)
+end
+
+function Base.show(io::IO, A::AbstractNoTimeSolution)
 
-    @printf io " * Status: %s\n\n" r.iteration_converged ? "success" : failure_string
+    @printf io "\n * Status: %s\n\n" A.retcode === :Success ? "success" : "failure"
     @printf io " * Candidate solution\n"
-    fmt = "    Final objective value:     %e "*repeat(", %e ",length(r.minimum)-1)*"\n"
-    @eval @printf($io, $fmt, $r.minimum...)
-    #@printf io "    Final objective value:     %e\n" r.minimum
+    @printf io "    Final objective value:     %e\n" A.minimum
     @printf io "\n"
     @printf io " * Found with\n"
-    @printf io "    Algorithm:     %s\n" r.method
+    @printf io "    Algorithm:     %s\n" A.alg
     return
 end
 
@@ -159,15 +167,7 @@ function __solve(prob::OptimizationProblem, opt, data = DEFAULT_DATA;
 
     _time = time()
 
-    OptimizationSolution(opt,
-                        prob.u0,# initial_x,
-                        θ, #pick_best_x(f_incr_pick, state),
-                        save_best ? first(min_err) : first(x), # pick_best_f(f_incr_pick, state, d),
-                        maxiters, #iteration,
-                        maxiters >= maxiters, #iteration == options.iterations,
-                        true,
-                        _time-t0,
-                        NamedTuple())
+    # here should be build_solution to create the output message
 end
 
 
@@ -447,7 +447,7 @@ function __init__()
             end
 
             _loss = function(θ)
-                x = ntuple(i->first(prob.prob[i].f(θ, prob.prob[i].p, cur...)),length(prob.prob))   
+                x = ntuple(i->first(prob.prob[i].f(θ, prob.prob[i].p, cur...)),length(prob.prob))
                 return x
             end