refactor to use solve_loop!

Author: lkdvos

src/AlgorithmsInterface.jl

@@ -25,7 +25,7 @@ export Algorithm, Problem, State
 export initialize_state, initialize_state!
 export finalize_state!
 
-export step!, solve, solve!
+export step!, solve, solve!, solve_loop!
 
 # stopping criteria
 export StoppingCriterion, StoppingCriterionState

src/interface/interface.jl

@@ -43,13 +43,19 @@ function solve(problem::Problem, algorithm::Algorithm; kwargs...)
     # obtain logger once to minimize overhead from accessing ScopedValue
     # additionally handle logging initialization to enable stateful LoggingAction
     logger = algorithm_logger()
-    # initialize_logger(logger, problem, algorithm, state)
 
     # initialize the state and emit message
     state = initialize_state(problem, algorithm; kwargs...)
     emit_message(logger, problem, algorithm, state, :Start)
 
-    return _solve_body!(problem, algorithm, state, logger)
+    # main loop
+    state = solve_loop!(problem, algorithm, state)
+
+    # emit message about finished state
+    output = finalize_state!(problem, algorithm, state)
+    emit_message(logger, problem, algorithm, state, :Stop)
+
+    return output
 end
 
 @doc """
@@ -64,34 +70,41 @@ function solve!(problem::Problem, algorithm::Algorithm, state::State; kwargs...)
     # obtain logger once to minimize overhead from accessing ScopedValue
     # additionally handle logging initialization to enable stateful LoggingAction
     logger = algorithm_logger()
-    # initialize_logger(logger, problem, algorithm, state)
 
     # initialize the state and emit message
     initialize_state!(problem, algorithm, state; kwargs...)
     emit_message(logger, problem, algorithm, state, :Start)
 
-    return _solve_body!(problem, algorithm, state, logger)
+    # main loop
+    state = solve_loop!(problem, algorithm, state)
+
+    # emit message about finished state
+    output = finalize_state!(problem, algorithm, state)
+    emit_message(logger, problem, algorithm, state, :Stop)
+
+    return output
 end
 
-function _solve_body!(problem::Problem, algorithm::Algorithm, state::State, logger)
-    # main body of the algorithm
+"""
+    solve_loop!(problem::Problem, algorithm::Algorithm, state::State)
+
+Provide the main loop of the iterative `algorithm` for a given `problem` and starting `state`.
+
+This loop consists of:
+1. Checking for convergence with [`is_finished!`](@ref)
+2. Incrementing the state [`increment!`](@ref)
+3. Performing a step [`step!`](@ref)
+4. Repeat
+"""
+function solve_loop!(problem::Problem, algorithm::Algorithm, state::State)
+    logger = algorithm_logger()
     while !is_finished!(problem, algorithm, state)
-        # logging event between convergence check and algorithm step
         emit_message(logger, problem, algorithm, state, :PreStep)
-
-        # algorithm step
         increment!(state)
         step!(problem, algorithm, state)
-
-        # logging event between algorithm step and convergence check
         emit_message(logger, problem, algorithm, state, :PostStep)
     end
-
-    # emit message about finished state
-    output = finalize_state!(problem, algorithm, state)
-    emit_message(logger, problem, algorithm, state, :Stop)
-
-    return output
+    return state
 end
 
 function step! end