introduce a stopped_at function for solver states.

Author: kellertuer

Changelog.md

@@ -6,6 +6,16 @@ The file was started with Version `0.4`.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.36] April 24, 2026
+
+### Added
+
+* a function `stopped_at(state)` to access the number of iterations it took a solver to stop.
+
+### Fixed
+
+* a small bug where `get_count(sc::StopWhenAny, Val(:Iteration))` wrongly reported it stopped before the first iteration when it actually did not yet stop.
+
 ## [0.5.35] April 16, 2026
 
 ### Changed

Project.toml

@@ -1,6 +1,6 @@
 name = "Manopt"
 uuid = "0fc0a36d-df90-57f3-8f93-d78a9fc72bb5"
-version = "0.5.35"
+version = "0.5.36"
 authors = [{family-names = "Bergmann", given-names = "Ronny", alias = "kellertuer", city = "Trondheim", affiliation = "Norwegian University of Science and Technology", country = "NO", email = "manopt@ronnybergmann.net", orcid = "https://orcid.org/0000-0001-8342-7218", website = "https://ronnybergmann.net"}]
 
 [workspace]

src/Manopt.jl

@@ -587,7 +587,7 @@ export StopAfter,
     StopWhenSwarmVelocityLess,
     StopWhenTrustRegionIsExceeded
 export get_active_stopping_criteria,
-    get_stopping_criteria, get_reason, get_stopping_criterion
+    get_stopping_criteria, get_reason, get_stopping_criterion, stopped_at
 #
 # Exports
 export asymptote_export_S2_signals, asymptote_export_S2_data, asymptote_export_SPD

src/plans/solver_state.jl

@@ -329,6 +329,18 @@ Make a copy of tangent vector `X` from manifold `M` for storage in [`StoreStateA
 _storage_copy_vector(M::AbstractManifold, X) = copy(M, X)
 _storage_copy_vector(::AbstractManifold, X::Number) = StorageRef(X)
 
+@doc """
+    stopped_at(state::AbstractManoptSolverState)
+
+Return the number of iterations the solver represented by the `state` took to stop.
+If the solver has not yet stopped, this function returns `-1`.
+
+By default, this function calls `get_count` function on the state's stopping criterion to access its `:Iteration` count.
+"""
+function stopped_at(state::AbstractManoptSolverState)
+    return get_count(get_stopping_criterion(state), Val(:Iterations))
+end
+
 @doc """
     StoreStateAction <: AbstractStateAction
 

src/plans/stopping_criterion.jl

@@ -1181,7 +1181,7 @@ function has_converged(c::StopWhenAny)
 end
 function get_count(c::StopWhenAny, v::Val{:Iterations})
     iters = filter(x -> x > 0, [get_count(ci, v) for ci in c.criteria])
-    (length(iters) == 0) && (return 0)
+    (length(iters) == 0) && (return -1) # None indicated to stop yet, so we also do not
     return minimum(iters)
 end
 function show(io::IO, c::StopWhenAny)

test/plans/test_gradient_plan.jl

@@ -16,6 +16,7 @@ using ManifoldsBase, Manopt, Test
         stopping_criterion = StopAfterIteration(20),
         stepsize = Manopt.ConstantStepsize(M),
     )
+    @test stopped_at(gst) == -1
     set_iterate!(gst, M, q)
     @test get_iterate(gst) == q
     set_gradient!(gst, M, p, [1.0, 0.0])

test/plans/test_state.jl

@@ -72,7 +72,7 @@ struct NoIterateState <: AbstractManoptSolverState end
         @test_throws ErrorException get_iterate(s2)
     end
 
-    @testset "Iteration and Gradient setters" begin
+    @testset "Iterate and Gradient setters" begin
         M = Euclidean(3)
         s1 = NelderMeadState(M)
         s2 = GradientDescentState(M)