Merge pull request #82 from JuliaQuantumControl/abstract-optimization…

…-result Make `GrapeResult` an `AbstactOptimizationResult`
JuliaQuantumControl · Sep 16, 2024 · 768f41f · 768f41f
2 parents 5f7fad5 + 9fa893d
commit 768f41f
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 61 deletions.
diff --git a/Project.toml b/Project.toml
@@ -13,20 +13,17 @@ QuantumGradientGenerators = "a563f35e-61db-434d-8c01-8b9e3ccdfd85"
 
 [weakdeps]
 Optim = "429524aa-4258-5aef-a3af-852621145aeb"
-Krotov = "b05dcdc7-62f6-4360-bf2c-0898bba419de"
 
 
 [extensions]
 GRAPEOptimExt = "Optim"
-GRAPEKrotovExt = "Krotov"
 # GRAPELBFGSBExt = "LBFGSB"
 # Cannot load GRAPELBFGSBExt as an extension if LBFGSB is a hard
 # dependency. See `include` in `src/GRAPE.jl`.
 
 [compat]
 Dates = "1"
 LBFGSB = "0.4"
-Krotov = ">=0.7.1"
 LinearAlgebra = "1"
 Optim = "1"
 Printf = "1"

diff --git a/ext/GRAPEKrotovExt.jl b/ext/GRAPEKrotovExt.jl
diff --git a/src/optimize.jl b/src/optimize.jl
@@ -242,7 +242,8 @@ function optimize_grape(problem)
                 local Ψₖ = prop_step!(wrk.fw_propagators[k])
                 if haskey(wrk.fw_prop_kwargs[k], :callback)
                     local cb = wrk.fw_prop_kwargs[k][:callback]
-                    local observables = get(wrk.fw_prop_kwargs[k], :observables, _StoreState())
+                    local observables =
+                        get(wrk.fw_prop_kwargs[k], :observables, _StoreState())
                     cb(wrk.fw_propagators[k], observables)
                 end
                 (Φₖ !== nothing) && write_to_storage!(Φₖ, n + 1, Ψₖ)
@@ -293,7 +294,8 @@ function optimize_grape(problem)
                 χ̃ₖ = prop_step!(wrk.bw_grad_propagators[k])
                 if haskey(wrk.bw_grad_prop_kwargs[k], :callback)
                     local cb = wrk.bw_grad_prop_kwargs[k][:callback]
-                    local observables = get(wrk.fw_prop_kwargs[k], :observables, _StoreState())
+                    local observables =
+                        get(wrk.fw_prop_kwargs[k], :observables, _StoreState())
                     cb(wrk.bw_grad_propagators[k], observables)
                 end
                 if supports_inplace(Ψₖ)
@@ -395,7 +397,8 @@ function optimize_grape(problem)
                 prop_step!(wrk.bw_propagators[k])
                 if haskey(wrk.bw_prop_kwargs[k], :callback)
                     local cb = wrk.bw_prop_kwargs[k][:callback]
-                    local observables = get(wrk.bw_prop_kwargs[k], :observables, _StoreState())
+                    local observables =
+                        get(wrk.bw_prop_kwargs[k], :observables, _StoreState())
                     cb(wrk.bw_propagators[k], observables)
                 end
             end

diff --git a/src/result.jl b/src/result.jl
@@ -1,4 +1,5 @@
 using QuantumControl.QuantumPropagators.Controls: get_controls, discretize
+using QuantumControl: AbstractOptimizationResult
 using Printf
 using Dates
 
@@ -26,7 +27,7 @@ The attributes of a `GrapeResult` object include
 All of the above attributes may be referenced in a `check_convergence` function
 passed to [`optimize(problem; method=GRAPE)`](@ref QuantumControl.optimize(::ControlProblem, ::Val{:GRAPE}))
 """
-mutable struct GrapeResult{STST}
+mutable struct GrapeResult{STST} <: AbstractOptimizationResult
     tlist::Vector{Float64}
     iter_start::Int64  # the starting iteration number
     iter_stop::Int64 # the maximum iteration number
@@ -107,3 +108,9 @@ GRAPE Optimization Result
 - Ended at $(r.end_local_time) ($(Dates.canonicalize(Dates.CompoundPeriod(r.end_local_time - r.start_local_time))))
 """
 )
+
+
+function Base.convert(::Type{GrapeResult}, result::AbstractOptimizationResult)
+    defaults = Dict{Symbol,Any}(:f_calls => 0, :fg_calls => 0,)
+    return convert(GrapeResult, result, defaults)
+end