Add some tests for stopping criteria

Author: lkdvos

src/stopping_criterion.jl

@@ -203,7 +203,7 @@ function indicates_convergence(stop_when_any::StopWhenAny)
 end
 
 function Base.show(io::IO, ::MIME"text/plain", stop_when_any::StopWhenAny)
-    print(io, "StopWhenAny with the Stopping Criteria")
+    print(io, "StopWhenAny with the Stopping Criteria:")
     for stopping_criterion in stop_when_any.criteria
         print(io, "\n     ")
         replace(io, string(stopping_criterion), "\n" => "\n    ") #increase indent

test/runtests.jl

@@ -4,6 +4,10 @@ using SafeTestsets
     include("newton.jl")
 end
 
+@safetestset "Stopping Criteria" begin
+    include("stopping_criterion.jl")
+end
+
 @safetestset "Aqua" begin
     using AlgorithmsInterface, Aqua
     Aqua.test_all(AlgorithmsInterface)

test/stopping_criterion.jl

@@ -0,0 +1,72 @@
+using Test
+using AlgorithmsInterface
+using Dates
+
+struct DummyAlgorithm <: Algorithm
+    stopping_criterion::StoppingCriterion
+end
+struct DummyProblem <: Problem end
+mutable struct DummyState{S<:StoppingCriterionState} <: State
+    stopping_criterion_state::S
+    iteration::Int
+end
+
+problem = DummyProblem()
+
+@testset "StopAfterIteration" begin
+    s1 = StopAfterIteration(2)
+    @test s1 isa StoppingCriterion
+    @test string(s1) == "StopAfterIteration(2)"
+
+    algorithm = DummyAlgorithm(s1)
+    s1_state = initialize_state(problem, algorithm, s1)
+    state_finished = DummyState(s1_state, 2)
+    state_not_finished = DummyState(s1_state, 1)
+    @test is_finished(problem, algorithm, state_finished)
+    @test !is_finished(problem, algorithm, state_not_finished)
+end
+
+@testset "StopAfter" begin
+    s1 = StopAfter(Second(1))
+    @test s1 isa StoppingCriterion
+    @test string(s1) == "StopAfter(Second(1))"
+
+    algorithm = DummyAlgorithm(s1)
+    s1_state = initialize_state(problem, algorithm, s1)
+    state_not_finished = DummyState(s1_state, 1)
+    @test !is_finished(problem, algorithm, state_not_finished)
+    s1_state.time = Second(2)
+    @test is_finished(problem, algorithm, state_not_finished)
+end
+
+@testset "StopWhenAll" begin
+    s1 = StopAfterIteration(2) & StopAfter(Second(1))
+    @test s1 isa StoppingCriterion
+    @test sprint((io, x) -> show(io, MIME"text/plain"(), x), s1) ==
+        "StopWhenAll with the Stopping Criteria:\n     StopAfterIteration(2)\n     StopAfter(Second(1))"
+
+    algorithm = DummyAlgorithm(s1)
+    s1_state = initialize_state(problem, algorithm, s1)
+    state_not_finished = DummyState(s1_state, 1)
+    @test !is_finished(problem, algorithm, state_not_finished)
+    s1_state.criteria_states[2].time = Second(2)
+    @test !is_finished(problem, algorithm, state_not_finished)
+    state_not_finished.iteration = 2
+    @test is_finished(problem, algorithm, state_not_finished)
+end
+
+@testset "StopWhenAny" begin
+    s1 = StopAfterIteration(2) | StopAfter(Second(1))
+    @test s1 isa StoppingCriterion
+    @test sprint((io, x) -> show(io, MIME"text/plain"(), x), s1) ==
+        "StopWhenAny with the Stopping Criteria:\n     StopAfterIteration(2)\n     StopAfter(Second(1))"
+
+    algorithm = DummyAlgorithm(s1)
+    s1_state = initialize_state(problem, algorithm, s1)
+    state_not_finished = DummyState(s1_state, 1)
+    @test !is_finished(problem, algorithm, state_not_finished)
+    s1_state.criteria_states[2].time = Second(2)
+    @test is_finished(problem, algorithm, state_not_finished)
+    state_not_finished.iteration = 2
+    @test is_finished(problem, algorithm, state_not_finished)
+end