replace stopping by status and success by successful

Author: ocots

Project.toml

@@ -1,7 +1,7 @@
 name = "CTModels"
 uuid = "34c4fa32-2049-4079-8329-de33c2a22e2d"
 authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]
-version = "0.5.4"
+version = "0.6.0"
 
 [deps]
 CTBase = "54762871-cc72-4466-b8e8-f6c8b58076cd"

ext/CTModelsJSON.jl

@@ -45,8 +45,8 @@ function CTModels.export_ocp_solution(
         "iterations" => CTModels.iterations(sol),
         "constraints_violation" => CTModels.constraints_violation(sol),
         "message" => CTModels.message(sol),
-        "stopping" => CTModels.stopping(sol),
-        "success" => CTModels.success(sol),
+        "status" => CTModels.status(sol),
+        "successful" => CTModels.successful(sol),
         "path_constraints_dual" =>
             CTModels.discretize(CTModels.path_constraints_dual(sol), T),
         "state_constraints_lb_dual" =>
@@ -218,8 +218,8 @@ function CTModels.import_ocp_solution(
         iterations=blob.iterations,
         constraints_violation=Float64(blob.constraints_violation),
         message=blob.message,
-        stopping=Symbol(blob.stopping),
-        success=blob.success,
+        status=Symbol(blob.status),
+        successful=blob.successful,
         path_constraints_dual=path_constraints_dual,
         state_constraints_lb_dual=state_constraints_lb_dual,
         state_constraints_ub_dual=state_constraints_ub_dual,

src/solution.jl

@@ -14,9 +14,9 @@ Build a solution from the optimal control problem, the time grid, the state, con
 - `objective::Float64`: the objective value.
 - `iterations::Int`: the number of iterations.
 - `constraints_violation::Float64`: the constraints violation.
-- `message::String`: the message associated to the stopping criterion.
-- `stopping::Symbol`: the stopping criterion.
-- `success::Bool`: the success status.
+- `message::String`: the message associated to the status criterion.
+- `status::Symbol`: the status criterion.
+- `successful::Bool`: the successful status.
 - `path_constraints_dual::Matrix{Float64}`: the dual of the path constraints.
 - `boundary_constraints_dual::Vector{Float64}`: the dual of the boundary constraints.
 - `state_constraints_lb_dual::Matrix{Float64}`: the lower bound dual of the state constraints.
@@ -42,8 +42,8 @@ function build_solution(
     iterations::Int,
     constraints_violation::Float64,
     message::String,
-    stopping::Symbol,
-    success::Bool,
+    status::Symbol,
+    successful::Bool,
     path_constraints_dual::TPCD=__constraints(),
     boundary_constraints_dual::Union{Vector{Float64},Nothing}=__constraints(),
     state_constraints_lb_dual::Union{Matrix{Float64},Nothing}=__constraints(),
@@ -214,7 +214,7 @@ function build_solution(
         variable_constraints_ub_dual,
     )
     solver_infos = SolverInfos(
-        iterations, stopping, message, success, constraints_violation, infos
+        iterations, status, message, successful, constraints_violation, infos
     )
 
     return Solution(
@@ -523,17 +523,17 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Return the stopping criterion (a Symbol).
+Return the status criterion (a Symbol).
 
 """
-function stopping(sol::Solution)::Symbol
-    return sol.solver_infos.stopping
+function status(sol::Solution)::Symbol
+    return sol.solver_infos.status
 end
 
 """
 $(TYPEDSIGNATURES)
 
-Return the message associated to the stopping criterion.
+Return the message associated to the status criterion.
 
 """
 function message(sol::Solution)::String
@@ -543,11 +543,11 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Return the success status.
+Return the successful status.
 
 """
-function success(sol::Solution)::Bool
-    return sol.solver_infos.success
+function successful(sol::Solution)::Bool
+    return sol.solver_infos.successful
 end
 
 """
@@ -704,50 +704,50 @@ function Base.show(io::IO, ::MIME"text/plain", sol::Solution)
     println(io, "────────────────────────")
 
     # Status
-    println(io, "• Success       : ", success(sol))
-    println(io, "• Stopping      : ", stopping(sol))
-    println(io, "• Message       : ", message(sol))
-    println(io, "• Iterations    : ", iterations(sol))
-    println(io, "• Objective     : ", objective(sol))
+    println(io, "• Successful : ", successful(sol))
+    println(io, "• Status     : ", status(sol))
+    println(io, "• Message    : ", message(sol))
+    println(io, "• Iterations : ", iterations(sol))
+    println(io, "• Objective  : ", objective(sol))
     println(io, "• Constraint violation: ", constraints_violation(sol))
 
     println(io)
     println(io, "Time")
     println(io, "────")
-    println(io, "• Name          : ", time_name(sol))
-    println(io, "• Grid          : ", time_grid(sol))
-    println(io, "• Grid length   : ", length(time_grid(sol)))
+    println(io, "• Name        : ", time_name(sol))
+    println(io, "• Grid        : ", time_grid(sol))
+    println(io, "• Grid length : ", length(time_grid(sol)))
 
     println(io)
     println(io, "State")
     println(io, "─────")
-    println(io, "• Name          : ", state_name(sol))
-    println(io, "• Dimension     : ", state_dimension(sol))
-    println(io, "• Components    : ", join(state_components(sol), ", "))
+    println(io, "• Name        : ", state_name(sol))
+    println(io, "• Dimension   : ", state_dimension(sol))
+    println(io, "• Components  : ", join(state_components(sol), ", "))
 
     println(io)
     println(io, "Control")
     println(io, "───────")
-    println(io, "• Name          : ", control_name(sol))
-    println(io, "• Dimension     : ", control_dimension(sol))
-    println(io, "• Components    : ", join(control_components(sol), ", "))
+    println(io, "• Name        : ", control_name(sol))
+    println(io, "• Dimension   : ", control_dimension(sol))
+    println(io, "• Components  : ", join(control_components(sol), ", "))
 
     # Variable block (optional)
     v_dim = variable_dimension(sol)
     if v_dim > 0
         println(io)
         println(io, "Variable")
         println(io, "────────")
-        println(io, "• Name          : ", variable_name(sol))
-        println(io, "• Dimension     : ", v_dim)
-        println(io, "• Components    : ", join(variable_components(sol), ", "))
-        println(io, "• Value         : ", variable(sol))
+        println(io, "• Name       : ", variable_name(sol))
+        println(io, "• Dimension  : ", v_dim)
+        println(io, "• Components : ", join(variable_components(sol), ", "))
+        println(io, "• Value      : ", variable(sol))
     end
 
     println(io)
     println(io, "Duals")
     println(io, "─────")
-    println(io, "• Boundary constraints dual     : ", boundary_constraints_dual(sol))
+    println(io, "• Boundary constraints dual: ", boundary_constraints_dual(sol))
     if v_dim > 0
         println(io, "• Variable constraints dual (lb): ", variable_constraints_lb_dual(sol))
         println(io, "• Variable constraints dual (ub): ", variable_constraints_ub_dual(sol))

src/types.jl

@@ -554,9 +554,9 @@ $(TYPEDFIELDS)
 """
 struct SolverInfos{TI<:Dict{Symbol,Any}} <: AbstractSolverInfos
     iterations::Int # number of iterations
-    stopping::Symbol # the stopping criterion
-    message::String # the message corresponding to the stopping criterion
-    success::Bool # whether or not the method has finished successfully: CN1, stagnation vs iterations max
+    status::Symbol # the status criterion
+    message::String # the message corresponding to the status criterion
+    successful::Bool # whether or not the method has finished successfully: CN1, stagnation vs iterations max
     constraints_violation::Float64 # the constraints violation
     infos::TI # additional informations
 end

test/extras/plot_duals.jl

@@ -51,8 +51,8 @@ function SOL(ocp, t0, tf)
         iterations=-1,
         constraints_violation=0.0,
         message="",
-        stopping=:optimal,
-        success=true,
+        status=:optimal,
+        successful=true,
         path_constraints_dual=path_constraints_dual,
     )
 

test/extras/plot_manual.jl

@@ -106,10 +106,10 @@ function get_solution()
     message = "Solve_Succeeded"
 
     # Stopping: Symbol
-    stopping = :Solve_Succeeded
+    status = :Solve_Succeeded
 
     # Success: Bool
-    success = true
+    successful = true
 
     # solution
     sol = CTModels.build_solution(
@@ -123,8 +123,8 @@ function get_solution()
         iterations=iterations,
         constraints_violation=constraints_violation,
         message=message,
-        stopping=stopping,
-        success=success,
+        status=status,
+        successful=successful,
     )
 
     return sol

test/solution_example.jl

@@ -118,10 +118,10 @@ function solution_example(; fun=false)
     message = "Solve_Succeeded"
 
     # Stopping: Symbol
-    stopping = :Solve_Succeeded
+    status = :Solve_Succeeded
 
     # Success: Bool
-    success = true
+    successful = true
 
     # Path constraints: Matrix{Float64}
     path_constraints = nothing
@@ -165,8 +165,8 @@ function solution_example(; fun=false)
         iterations=iterations,
         constraints_violation=constraints_violation,
         message=message,
-        stopping=stopping,
-        success=success,
+        status=status,
+        successful=successful,
         path_constraints_dual=path_constraints_dual,
         boundary_constraints_dual=boundary_constraints_dual,
         state_constraints_lb_dual=state_constraints_lb_dual,

test/solution_example_path_constraints.jl

@@ -44,8 +44,8 @@ function solution_example_path_constraints()
             iterations=-1,
             constraints_violation=0.0,
             message="",
-            stopping=:optimal,
-            success=true,
+            status=:optimal,
+            successful=true,
             path_constraints_dual=path_constraints_dual,
         )
 

test/test_solution.jl

@@ -38,8 +38,8 @@ function test_solution()
     iterations = 10
     constraints_violation = 12.0
     message = "message"
-    stopping = :stopping
-    success = true
+    status = :status
+    successful = true
     path_constraints_dual = nothing
     boundary_constraints_dual = nothing
     state_constraints_lb_dual = nothing
@@ -53,8 +53,8 @@ function test_solution()
         :iterations => iterations,
         :constraints_violation => constraints_violation,
         :message => message,
-        :stopping => stopping,
-        :success => success,
+        :status => status,
+        :successful => successful,
         :path_constraints_dual => path_constraints_dual,
         :boundary_constraints_dual => boundary_constraints_dual,
         :state_constraints_lb_dual => state_constraints_lb_dual,
@@ -113,8 +113,8 @@ function test_solution()
         @test CTModels.iterations(sol) == 10
         @test CTModels.constraints_violation(sol) == 12.0
         @test CTModels.message(sol) == "message"
-        @test CTModels.stopping(sol) == :stopping
-        @test CTModels.success(sol) == true
+        @test CTModels.status(sol) == :status
+        @test CTModels.successful(sol) == true
         @test CTModels.infos(sol) == Dict()
     end
     @testset "dual to constraints" begin