Finish RecordAction refactor and aløready add a bit of testing,

Author: kellertuer

_typos.toml

@@ -3,7 +3,7 @@ methodes = "methodes" # french
 Serie = "Serie" # french
 sur = "sur" # french
 cmo = "cmo" # often used abbreviation for constrained manifold objective
-
+nd = "nd" # like in 2nd
 [files]
 extend-exclude = [
 "tutorials/*.html",

src/plans/first_order_plan.jl

@@ -1228,7 +1228,7 @@ record the norm of the current gradient
 """
 mutable struct RecordGradientNorm{R <: Real} <: RecordAction
     recorded_values::Array{R, 1}
-    RecordGradientNorm(r::Type{<:Real}) = new{r}(Array{r, 1}())
+    RecordGradientNorm(r::Type{<:Real} = Float64) = new{r}(Array{r, 1}())
 end
 function (r::RecordGradientNorm)(
         mp::AbstractManoptProblem, ast::AbstractManoptSolverState, k::Int

src/plans/proximal_plan.jl

@@ -343,7 +343,7 @@ record the current iterates proximal point algorithm parameter given by in
 """
 mutable struct RecordProximalParameter{R <: Real} <: RecordAction
     recorded_values::Array{R, 1}
-    RecordProximalParameter(r::Type{<:Real}) = new{r}(Array{r, 1}())
+    RecordProximalParameter(r::Type{<:Real} = Float64) = new{r}(Array{r, 1}())
 end
 function (r::RecordProximalParameter)(
         ::AbstractManoptProblem, cpps::CyclicProximalPointState, k::Int

src/plans/record.jl

@@ -267,9 +267,9 @@ function status_summary(re::RecordEvery; context::Symbol = :default)
     if context === :short
         s = ""
         if re.record isa RecordGroup
-            s = status_summary(re.record)[3:(end - 2)]
+            s = status_summary(re.record; context = context)[2:(end - 1)]
         else
-            s = "$(re.record)"
+            s = "$(status_summary(re.record; context = context))"
         end
         return "[$s, $(re.every)]"
     end
@@ -280,8 +280,8 @@ function status_summary(re::RecordEvery; context::Symbol = :default)
     (re.every == 1) && (s = "every")
     (context === :inline) && return "A RecordAction that records its inner action $s iteration"
     return """
-    A RecordAction that records $s iteration with\n
-    $(_in_str(status_summary(re.record; context = context); indent = 1))
+    A RecordAction that records $s iteration with
+    $(_MANOPT_INDENT)$(_in_str(status_summary(re.record; context = context); indent = 1))
     """
 end
 get_record(r::RecordEvery) = get_record(r.record)
@@ -361,7 +361,7 @@ function (d::RecordGroup)(p::AbstractManoptProblem, s::AbstractManoptSolverState
     return
 end
 function status_summary(rg::RecordGroup; context::Symbol = :default)
-    (context === :short) && (return "[ $(join(["$(status_summary(ri))" for ri in rg.group], ", ")) ]")
+    (context === :short) && (return "[$(join(["$(status_summary(ri; context = context))" for ri in rg.group], ", "))]")
     (context === :inline) && (return "A group of $(length(rg.group)) RecordActions")
     return "A group of $(length(rg.group)) RecordActions:\n $(join(["* $(status_summary(ri; context = context))" for ri in rg.group], "\n"))\n"
 end
@@ -444,24 +444,25 @@ end
 function show(io::IO, rsr::RecordSubsolver{R}) where {R}
     return print(io, "RecordSubsolver(; record=$(rsr.record), record_type=$R)")
 end
-function status_summary(::RecordSubsolver{R}; context::Symbol = :default) where {R}
+function status_summary(rsr::RecordSubsolver{R}; context::Symbol = :default) where {R}
     (context === :short) && return ":Subsolver"
-    (context === :inline) && return "A RecordAction to specify something to record from each subolver run"
-    return
-    """
-    A RecordAction to record elements of type $R in from each subsolver run
+    (context === :inline) && return "A RecordAction to specify something to record from each subsolver run"
+    return """
+    A RecordAction to record elements in from each subsolver run of type $R.
 
+    ## Recorded values
+    The following recorded symbols from the sub state are recorded in every iteration of the (outer) solver
+    $(join([ "  * :$(s)" for s in rsr.record], "\n"))
     """
 end
 
 @doc """
     RecordWhenActive <: RecordAction
 
 record action that only records if the `active` boolean is set to true.
-This can be set from outside and is for example triggered by |`RecordEvery`](@ref)
-on recordings of the subsolver.
-While this is for sub solvers maybe not completely necessary, recording values that
-are never accessible, is not that useful.
+This can be set from outside and is for example triggered by [`RecordEvery`](@ref)
+on recordings of a subsolver. While this is for sub solvers maybe not completely necessary,
+recording values that are never accessible, is not that useful.
 
 # Fields
 
@@ -482,7 +483,6 @@ mutable struct RecordWhenActive{R <: RecordAction} <: RecordAction
         return new{R}(r, active, always_update)
     end
 end
-
 function (rwa::RecordWhenActive)(
         amp::AbstractManoptProblem, ams::AbstractManoptSolverState, k::Int
     )
@@ -495,8 +495,13 @@ end
 function show(io::IO, rwa::RecordWhenActive)
     return print(io, "RecordWhenActive($(rwa.record), $(rwa.active), $(rwa.always_update))")
 end
-function status_summary(rwa::RecordWhenActive)
-    return repr(rwa)
+function status_summary(rwa::RecordWhenActive; context::Symbol = :default)
+    (context === :short) && (return repr(rwa))
+    (context === :inline) && (return "A RecordAction that only records its inner action when active (currently: $(rwa.active ? "" : "in")active)")
+    return """
+    Record the following only, when active (currently: $(rwa.active ? "" : "in")active)
+    $(_in_str(status_summary(rwa.record; context = context), indent = 1, headers = 0))
+    """
 end
 function set_parameter!(rwa::RecordWhenActive, v::Val, args...)
     set_parameter!(rwa.record, v, args...)
@@ -615,7 +620,7 @@ end
 show(io::IO, ::RecordCost) = print(io, "RecordCost()")
 function status_summary(::RecordCost; context::Symbol = :default)
     (context === :short) && return ":Cost"
-    return "A RecordAction to record the cost value."
+    return "A RecordAction to record the cost value"
 end
 
 @doc """

test/plans/test_record.jl

@@ -24,7 +24,8 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
     dmp = DefaultManoptProblem(M, ManifoldGradientObjective(f, grad_f))
     a = RecordIteration()
     @test repr(a) == "RecordIteration()"
-    @test Manopt.status_summary(a) == ":Iteration"
+    @test Manopt.status_summary(a; context = :short) == ":Iteration"
+    @test Manopt.status_summary(a) == "A RecordAction to record the current iteration number"
     # constructors
     rs = RecordSolverState(gds, a)
     Manopt.set_parameter!(rs, :Record, RecordCost())
@@ -85,7 +86,8 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
     @test_throws ErrorException RecordGroup(RecordAction[], Dict(:a => 1))
     @test_throws ErrorException RecordGroup(RecordAction[], Dict(:a => 0))
     b = RecordGroup([RecordIteration(), RecordIteration()], Dict(:It1 => 1, :It2 => 2))
-    @test Manopt.status_summary(b) == "[ :Iteration, :Iteration ]"
+    @test Manopt.status_summary(b; context = :short) == "[:Iteration, :Iteration]"
+    @test startswith(Manopt.status_summary(b), "A group of 2 RecordActions:\n")
     @test repr(b) == "RecordGroup([RecordIteration(), RecordIteration()])"
     b(dmp, gds, 1)
     b(dmp, gds, 2)
@@ -102,7 +104,8 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
     @testset "RecordEvery" begin
         c = RecordEvery(a, 10, true)
         @test repr(c) == "RecordEvery(RecordIteration(), 10, true)"
-        @test Manopt.status_summary(c) == "[RecordIteration(), 10]"
+        @test Manopt.status_summary(c; context = :short) == "[:Iteration, 10]"
+        @test startswith(Manopt.status_summary(c), "A RecordAction that records every 10th iteration with\n")
         c(dmp, gds, 0)
         @test length(get_record(c)) === 0
         c(dmp, gds, 1)
@@ -118,7 +121,7 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
             10,
         )
         @test repr(c2) == "RecordEvery($(repr(c2.record)), 10, true)"
-        @test Manopt.status_summary(c2) == "[:Iteration, :Iteration, 10]"
+        @test Manopt.status_summary(c2; context = :short) == "[:Iteration, :Iteration, 10]"
         c2(dmp, gds, 5)
         c2(dmp, gds, 10)
         c2(dmp, gds, 20)
@@ -129,7 +132,8 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
         d = RecordChange()
         sd = "RecordChange(; inverse_retraction_method=LogarithmicInverseRetraction())"
         @test repr(d) == sd
-        @test Manopt.status_summary(d) == ":Change"
+        @test Manopt.status_summary(d; context = :short) == ":Change"
+        @test startswith(Manopt.status_summary(d), "A RecordAction to record the change of the iterate")
         d(dmp, gds, 1)
         @test d.recorded_values == [0.0] # no p0 -> assume p is the first iterate
         set_iterate!(gds, M, p + [1.0, 0.0])
@@ -169,7 +173,8 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
     @testset "RecordIterate" begin
         set_iterate!(gds, M, p)
         f = RecordIterate(p)
-        @test Manopt.status_summary(f) == ":Iterate"
+        @test Manopt.status_summary(f; context = :short) == ":Iterate"
+        @test Manopt.status_summary(f) == "A RecordAction to record the current iterate"
         @test repr(f) == "RecordIterate(Vector{Float64})"
         @test_throws ErrorException RecordIterate()
         f(dmp, gds, 1)
@@ -178,7 +183,8 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
     @testset "RecordCost" begin
         g = RecordCost()
         @test repr(g) == "RecordCost()"
-        @test Manopt.status_summary(g) == ":Cost"
+        @test Manopt.status_summary(g; context = :short) == ":Cost"
+        @test Manopt.status_summary(g) == "A RecordAction to record the cost value"
         g(dmp, gds, 1)
         @test g.recorded_values == [0.0]
         gds.p = [3.0, 2.0]
@@ -198,15 +204,17 @@ Manopt.get_parameter(d::TestRecordParameterState, ::Val{:value}) = d.value
     @testset "RecordSubsolver" begin
         rss = RecordSubsolver()
         @test repr(rss) == "RecordSubsolver(; record=[:Iteration], record_type=Any)"
-        @test Manopt.status_summary(rss) == ":Subsolver"
+        @test Manopt.status_summary(rss; context = :short) == ":Subsolver"
+        @test startswith(Manopt.status_summary(rss), "A RecordAction to record elements in from each subsolver")
         epms = ExactPenaltyMethodState(M, dmp, rs)
         rss(dmp, epms, 1)
     end
     @testset "RecordWhenActive" begin
         i = RecordIteration()
         rwa = RecordWhenActive(i)
         @test repr(rwa) == "RecordWhenActive(RecordIteration(), true, true)"
-        @test Manopt.status_summary(rwa) == repr(rwa)
+        @test Manopt.status_summary(rwa; context = :short) == repr(rwa)
+        @test startswith(Manopt.status_summary(rwa), "Record the following only, when active")
         rwa(dmp, gds, 1)
         @test length(get_record(rwa)) == 1
         rwa(dmp, gds, -1) # Reset