plan / state / codecov++

Author: kellertuer

src/plans/solver_state.jl

@@ -17,11 +17,7 @@ abstract type AbstractManoptSolverState end
 
 function Base.show(io::IO, ::MIME"text/plain", ams::AbstractManoptSolverState)
     multiline = get(io, :multiline, true)
-    if multiline
-        return status_summary(io, ams)
-    else
-        show(io, ams)
-    end
+    return multiline ? status_summary(io, ams) : show(io, ams)
 end
 
 """
@@ -128,8 +124,8 @@ should be returned at the end of a solver instead of the usual minimizer.
 struct ReturnSolverState{S <: AbstractManoptSolverState} <: AbstractManoptSolverState
     state::S
 end
-status_summary(rst::ReturnSolverState) = status_summary(rst.state)
-show(io::IO, rst::ReturnSolverState) = print(io, "ReturnSolverState($(rst.state))")
+status_summary(rst::ReturnSolverState; context::Symbol = :default) = status_summary(rst.state; context = context)
+show(io::IO, rst::ReturnSolverState) = print(io, "ReturnSolverState(", rst.state, ")")
 dispatch_state_decorator(::ReturnSolverState) = Val(true)
 
 """
@@ -317,9 +313,11 @@ for example within the [`DebugSolverState`](@ref) or within the [`RecordSolverSt
 abstract type AbstractStateAction end
 
 status_summary(asa::AbstractStateAction; context::Symbol = :default) = repr(asa)
-status_summary(io::IO, asa::AbstractStateAction; context::Symbol = :default) = print(io, status_summary(asa; context = context))
 
-Base.show(io::IO, ::MIME"text/plain", asa::AbstractStateAction) = status_summary(io::IO, asa; context = :default)
+function Base.show(io::IO, ::MIME"text/plain", asa::AbstractStateAction)
+    multiline = get(io, :multiline, true)
+    return multiline ? status_summary(io, asa) : show(io, asa)
+end
 
 mutable struct StorageRef{T}
     x::T

test/plans/test_state.jl

@@ -9,8 +9,12 @@ struct NoIterateState <: AbstractManoptSolverState end
         pr = Manopt.Test.DummyProblem{typeof(M)}()
         s = Manopt.Test.DummyState()
         @test repr(Manopt.ReturnSolverState(s)) == "ReturnSolverState($s)"
-        @test Manopt.status_summary(Manopt.ReturnSolverState(s)) ==
-            "A Manopt Test state with storage Float64[]"
+        srst = "A Manopt Test state with storage Float64[]"
+        @test Manopt.status_summary(Manopt.ReturnSolverState(s)) == srst
+        io = IOBuffer()
+        show(io, MIME"text/plain"(), Manopt.ReturnSolverState(s))
+        @test startswith(String(take!(io)), srst)
+
         a = ArmijoLinesearch(; initial_stepsize = 1.0)(M)
         @test get_last_stepsize(a) == 1.0
         @test get_initial_stepsize(a) == 1.0

test/plans/test_storage.jl

@@ -10,17 +10,20 @@ using Test, Manopt, ManifoldsBase, Manifolds
         X_zero = zero_vector(M, p)
 
         st = GradientDescentState(
-            M;
-            p = p,
-            stopping_criterion = StopAfterIteration(20),
-            stepsize = Manopt.ConstantStepsize(M),
+            M; p = p,
+            stopping_criterion = StopAfterIteration(20), stepsize = Manopt.ConstantStepsize(M),
         )
         f(M, q) = distance(M, q, p) .^ 2
         grad_f(M, q) = -2 * log(M, q, p)
         mp = DefaultManoptProblem(M, ManifoldGradientObjective(f, grad_f))
 
         a = StoreStateAction(M; store_fields = [:p, :X])
 
+        @test Manopt.status_summary(a) == repr(a)
+        io = IOBuffer()
+        show(io, MIME"text/plain"(), a)
+        @test String(take!(io)) == repr(a)
+
         @test !has_storage(a, Manopt.PointStorageKey(:p))
         @test !has_storage(a, Manopt.VectorStorageKey(:X))
         update_storage!(a, mp, st)