🤖 Format .jl files

Author: ocots

ext/CTModelsJLD.jl

@@ -25,7 +25,9 @@ julia> export_ocp_solution(JLD2Tag(), sol; filename="mysolution")
 # → creates "mysolution.jld2"
 ```
 """
-function CTModels.export_ocp_solution(::CTModels.JLD2Tag, sol::CTModels.Solution; filename::String)
+function CTModels.export_ocp_solution(
+    ::CTModels.JLD2Tag, sol::CTModels.Solution; filename::String
+)
     save_object(filename * ".jld2", sol)
     return nothing
 end
@@ -52,7 +54,9 @@ This function loads a previously saved `CTModels.Solution` from disk.
 julia> sol = import_ocp_solution(JLD2Tag(), model; filename="mysolution")
 ```
 """
-function CTModels.import_ocp_solution(::CTModels.JLD2Tag, ocp::CTModels.Model; filename::String)
+function CTModels.import_ocp_solution(
+    ::CTModels.JLD2Tag, ocp::CTModels.Model; filename::String
+)
     return load_object(filename * ".jld2")
 end
 

ext/CTModelsJSON.jl

@@ -29,7 +29,9 @@ julia> export_ocp_solution(JSON3Tag(), sol; filename="mysolution")
 # → creates "mysolution.json"
 ```
 """
-function CTModels.export_ocp_solution(::CTModels.JSON3Tag, sol::CTModels.Solution; filename::String)
+function CTModels.export_ocp_solution(
+    ::CTModels.JSON3Tag, sol::CTModels.Solution; filename::String
+)
     T = CTModels.time_grid(sol)
 
     blob = Dict(
@@ -92,7 +94,9 @@ Handles both vector and matrix encodings of signals. If dual fields are missing
 julia> sol = import_ocp_solution(JSON3Tag(), model; filename="mysolution")
 ```
 """
-function CTModels.import_ocp_solution(::CTModels.JSON3Tag, ocp::CTModels.Model; filename::String)
+function CTModels.import_ocp_solution(
+    ::CTModels.JSON3Tag, ocp::CTModels.Model; filename::String
+)
     json_string = read(filename * ".json", String)
     blob = JSON3.read(json_string)
 

src/CTModels.jl

@@ -136,28 +136,36 @@ $(TYPEDSIGNATURES)
 
 Export a solution in JLD format.
 """
-export_ocp_solution(::JLD2Tag, ::AbstractSolution; filename::String) = throw(CTBase.ExtensionError(:JLD2))
+function export_ocp_solution(::JLD2Tag, ::AbstractSolution; filename::String)
+    throw(CTBase.ExtensionError(:JLD2))
+end
 
 """
 $(TYPEDSIGNATURES)
 
 Import a solution from a JLD file.
 """
-import_ocp_solution(::JLD2Tag, ::AbstractModel; filename::String) = throw(CTBase.ExtensionError(:JLD2))
+function import_ocp_solution(::JLD2Tag, ::AbstractModel; filename::String)
+    throw(CTBase.ExtensionError(:JLD2))
+end
 
 """
 $(TYPEDSIGNATURES)
 
 Export a solution in JSON format.
 """
-export_ocp_solution(::JSON3Tag, ::AbstractSolution;  filename::String) = throw(CTBase.ExtensionError(:JSON3))
+function export_ocp_solution(::JSON3Tag, ::AbstractSolution; filename::String)
+    throw(CTBase.ExtensionError(:JSON3))
+end
 
 """
 $(TYPEDSIGNATURES)
 
 Import a solution from a JLD file.
 """
-import_ocp_solution(::JSON3Tag, ::AbstractModel; filename::String) = throw(CTBase.ExtensionError(:JSON3))
+function import_ocp_solution(::JSON3Tag, ::AbstractModel; filename::String)
+    throw(CTBase.ExtensionError(:JSON3))
+end
 
 """
 $(TYPEDSIGNATURES)
@@ -171,7 +179,11 @@ julia> CTModels.export_ocp_solution(sol; filename="solution", format=:JSON)
 julia> CTModels.export_ocp_solution(sol; filename="solution", format=:JLD)
 ```
 """
-function export_ocp_solution(sol::AbstractSolution; format::Symbol=__format(), filename::String=__filename_export_import())
+function export_ocp_solution(
+    sol::AbstractSolution;
+    format::Symbol=__format(),
+    filename::String=__filename_export_import(),
+)
     if format == :JLD
         return export_ocp_solution(JLD2Tag(), sol; filename=filename)
     elseif format == :JSON
@@ -197,7 +209,11 @@ julia> sol = CTModels.import_ocp_solution(ocp; filename="solution", format=:JSON
 julia> sol = CTModels.import_ocp_solution(ocp; filename="solution", format=:JLD)
 ```
 """
-function import_ocp_solution(ocp::AbstractModel; format::Symbol=__format(), filename::String=__filename_export_import())
+function import_ocp_solution(
+    ocp::AbstractModel;
+    format::Symbol=__format(),
+    filename::String=__filename_export_import(),
+)
     if format == :JLD
         return import_ocp_solution(JLD2Tag(), ocp; filename=filename)
     elseif format == :JSON

src/constraints.jl

@@ -62,14 +62,16 @@ function __constraint!(
 )
 
     # checkings: the constraint must not be set before
-    @ensure(!(label ∈ keys(ocp_constraints)),
+    @ensure(
+        !(label ∈ keys(ocp_constraints)),
         CTBase.UnauthorizedCall(
             "the constraint named " * String(label) * " already exists."
         ),
     )
 
     # checkings: lb and ub cannot be both nothing
-    @ensure(!(isnothing(lb) && isnothing(ub)),
+    @ensure(
+        !(isnothing(lb) && isnothing(ub)),
         CTBase.UnauthorizedCall(
             "The lower bound `lb` and the upper bound `ub` cannot be both nothing."
         ),
@@ -80,7 +82,8 @@ function __constraint!(
     isnothing(ub) && (ub = Inf * ones(eltype(lb), length(lb)))
 
     # lb and ub must have the same length
-    @ensure(length(lb) == length(ub),
+    @ensure(
+        length(lb) == length(ub),
         CTBase.IncorrectArgument(
             "the lower bound `lb` and the upper bound `ub` must have the same length."
         ),
@@ -116,21 +119,24 @@ function __constraint!(
             @ensure(length(rg) == length(lb), CTBase.IncorrectArgument(txt))
             # check if the range is valid
             if type == :state
-                @ensure(all(1 .≤ rg .≤ n),
+                @ensure(
+                    all(1 .≤ rg .≤ n),
                     CTBase.IncorrectArgument(
-                        "the range of the state constraint must be contained in 1:$n",
+                        "the range of the state constraint must be contained in 1:$n"
                     ),
                 )
             elseif type == :control
-                @ensure(all(1 .≤ rg .≤ m),
+                @ensure(
+                    all(1 .≤ rg .≤ m),
                     CTBase.IncorrectArgument(
-                        "the range of the control constraint must be contained in 1:$m",
+                        "the range of the control constraint must be contained in 1:$m"
                     ),
                 )
             elseif type == :variable
-                @ensure(all(1 .≤ rg .≤ q),
+                @ensure(
+                    all(1 .≤ rg .≤ q),
                     CTBase.IncorrectArgument(
-                        "the range of the variable constraint must be contained in 1:$q",
+                        "the range of the variable constraint must be contained in 1:$q"
                     ),
                 )
             else
@@ -192,21 +198,27 @@ julia> constraint!(ocp, :control, rg=1:2, lb=[0.0], ub=[1.0], label=:control_con
 function constraint!(
     ocp::PreModel,
     type::Symbol;
-    rg::Union{Int, OrdinalRange{Int}, Nothing} = nothing,
-    f::Union{Function, Nothing} = nothing,
-    lb::Union{ctNumber, ctVector, Nothing} = nothing,
-    ub::Union{ctNumber, ctVector, Nothing} = nothing,
-    label::Symbol = __constraint_label(),
+    rg::Union{Int,OrdinalRange{Int},Nothing}=nothing,
+    f::Union{Function,Nothing}=nothing,
+    lb::Union{ctNumber,ctVector,Nothing}=nothing,
+    ub::Union{ctNumber,ctVector,Nothing}=nothing,
+    label::Symbol=__constraint_label(),
 )
 
     # checkings: times, state and control must be set before adding constraints
-    @ensure __is_state_set(ocp) CTBase.UnauthorizedCall("the state must be set before adding constraints.")
-    @ensure __is_control_set(ocp) CTBase.UnauthorizedCall("the control must be set before adding constraints.")
-    @ensure __is_times_set(ocp) CTBase.UnauthorizedCall("the times must be set before adding constraints.")
+    @ensure __is_state_set(ocp) CTBase.UnauthorizedCall(
+        "the state must be set before adding constraints."
+    )
+    @ensure __is_control_set(ocp) CTBase.UnauthorizedCall(
+        "the control must be set before adding constraints."
+    )
+    @ensure __is_times_set(ocp) CTBase.UnauthorizedCall(
+        "the times must be set before adding constraints."
+    )
 
     # checkings: variable must be set if using type=:variable
     @ensure (type != :variable || __is_variable_set(ocp)) CTBase.UnauthorizedCall(
-        "the ocp has no variable, you cannot use constraint! function with type=:variable. If it is a mistake, please set the variable first."
+        "the ocp has no variable, you cannot use constraint! function with type=:variable. If it is a mistake, please set the variable first.",
     )
 
     # dimensions
@@ -221,15 +233,14 @@ function constraint!(
         n,
         m,
         q;
-        rg = as_range(rg),
-        f = f,
-        lb = as_vector(lb),
-        ub = as_vector(ub),
-        label = label,
+        rg=as_range(rg),
+        f=f,
+        lb=as_vector(lb),
+        ub=as_vector(ub),
+        label=label,
     )
 end
 
-
 as_vector(::Nothing) = nothing
 (as_vector(x::T)::Vector{T}) where {T<:ctNumber} = [x]
 as_vector(x::Vector{T}) where {T<:ctNumber} = x

src/control.jl

@@ -42,12 +42,14 @@ julia> control_components(ocp)
 function control!(
     ocp::PreModel,
     m::Dimension,
-    name::T1 = __control_name(),
-    components_names::Vector{T2} = __control_components(m, string(name)),
-)::Nothing where {T1<:Union{String,Symbol}, T2<:Union{String,Symbol}}
+    name::T1=__control_name(),
+    components_names::Vector{T2}=__control_components(m, string(name)),
+)::Nothing where {T1<:Union{String,Symbol},T2<:Union{String,Symbol}}
 
     # checkings using @ensure
-    @ensure !__is_control_set(ocp) CTBase.UnauthorizedCall("the control has already been set.")
+    @ensure !__is_control_set(ocp) CTBase.UnauthorizedCall(
+        "the control has already been set."
+    )
     @ensure m > 0 CTBase.IncorrectArgument("the control dimension must be greater than 0")
     @ensure size(components_names, 1) == m CTBase.IncorrectArgument(
         "the number of control names must be equal to the control dimension"
@@ -59,7 +61,6 @@ function control!(
     return nothing
 end
 
-
 # ------------------------------------------------------------------------------ #
 # GETTERS
 # ------------------------------------------------------------------------------ #

src/default.jl

@@ -107,4 +107,4 @@ __matrix_dimension_storage() = 1
 $(TYPEDSIGNATURES)
 
 """
-__filename_export_import() = "solution"
+__filename_export_import() = "solution"

src/dual_model.jl

@@ -109,7 +109,6 @@ function dual(sol::Solution, model::Model, label::Symbol)
 
     # throw an exception if the label is not found
     throw(CTBase.IncorrectArgument("Label $label not found in the model."))
-    
 end
 
 """

src/dynamics.jl

@@ -20,19 +20,25 @@ dynamics have already been set.
 Throws `CTBase.UnauthorizedCall` if called out of order or in an invalid state.
 """
 function dynamics!(ocp::PreModel, f::Function)::Nothing
-
-    @ensure __is_state_set(ocp) CTBase.UnauthorizedCall("the state must be set before the dynamics.")
-    @ensure __is_control_set(ocp) CTBase.UnauthorizedCall("the control must be set before the dynamics.")
-    @ensure __is_times_set(ocp) CTBase.UnauthorizedCall("the times must be set before the dynamics.")
-    @ensure !__is_dynamics_set(ocp) CTBase.UnauthorizedCall("the dynamics has already been set.")
+    @ensure __is_state_set(ocp) CTBase.UnauthorizedCall(
+        "the state must be set before the dynamics."
+    )
+    @ensure __is_control_set(ocp) CTBase.UnauthorizedCall(
+        "the control must be set before the dynamics."
+    )
+    @ensure __is_times_set(ocp) CTBase.UnauthorizedCall(
+        "the times must be set before the dynamics."
+    )
+    @ensure !__is_dynamics_set(ocp) CTBase.UnauthorizedCall(
+        "the dynamics has already been set."
+    )
 
     # set the dynamics
     ocp.dynamics = f
 
     return nothing
 end
 
-
 """
 $(TYPEDSIGNATURES)
 
@@ -67,31 +73,50 @@ julia> dynamics!(ocp, 3:3, (out, t, x, u, v) -> out .= x[3] * v[1])
 ```
 """
 function dynamics!(ocp::PreModel, rg::AbstractUnitRange{<:Integer}, f::Function)::Nothing
-
-    @ensure __is_state_set(ocp) CTBase.UnauthorizedCall("the state must be set before the dynamics.")
-    @ensure __is_control_set(ocp) CTBase.UnauthorizedCall("the control must be set before the dynamics.")
-    @ensure __is_times_set(ocp) CTBase.UnauthorizedCall("the times must be set before the dynamics.")
-    @ensure !__is_dynamics_complete(ocp) CTBase.UnauthorizedCall("the dynamics has already been set.")
+    @ensure __is_state_set(ocp) CTBase.UnauthorizedCall(
+        "the state must be set before the dynamics."
+    )
+    @ensure __is_control_set(ocp) CTBase.UnauthorizedCall(
+        "the control must be set before the dynamics."
+    )
+    @ensure __is_times_set(ocp) CTBase.UnauthorizedCall(
+        "the times must be set before the dynamics."
+    )
+    @ensure !__is_dynamics_complete(ocp) CTBase.UnauthorizedCall(
+        "the dynamics has already been set."
+    )
 
     # Check indices in rg are within valid state index bounds
     for i in rg
         if i < 1 || i > state_dimension(ocp)
-            throw(CTBase.IncorrectArgument("index $i in the range is out of valid bounds [1, $(state_dimension(ocp))]."))
+            throw(
+                CTBase.IncorrectArgument(
+                    "index $i in the range is out of valid bounds [1, $(state_dimension(ocp))].",
+                ),
+            )
         end
     end
 
     # initialize dynamics container if needed
     if isnothing(ocp.dynamics)
-        ocp.dynamics = Vector{Tuple{UnitRange{Int}, Function}}()
+        ocp.dynamics = Vector{Tuple{UnitRange{Int},Function}}()
     elseif ocp.dynamics isa Function
-        throw(CTBase.UnauthorizedCall("cannot add partial dynamics: dynamics already defined as a single function."))
+        throw(
+            CTBase.UnauthorizedCall(
+                "cannot add partial dynamics: dynamics already defined as a single function.",
+            ),
+        )
     end
 
     # check that indices in rg are not already covered
     for (existing_range, _) in ocp.dynamics
         for i in rg
             if i in existing_range
-                throw(CTBase.UnauthorizedCall("index $i in the range already has assigned dynamics."))
+                throw(
+                    CTBase.UnauthorizedCall(
+                        "index $i in the range already has assigned dynamics."
+                    ),
+                )
             end
         end
     end
@@ -102,7 +127,6 @@ function dynamics!(ocp::PreModel, rg::AbstractUnitRange{<:Integer}, f::Function)
     return nothing
 end
 
-
 """
 $(TYPEDSIGNATURES)
 
@@ -171,7 +195,9 @@ julia> dyn!(val, 0.0, [1.0, 2.0, 3.0], [0.5, 0.5], 2.0)
 julia> println(val)  # prints [1.5, 2.5, 6.0]
 ```
 """
-function __build_dynamics_from_parts(parts::Vector{<:Tuple{<:AbstractUnitRange{<:Integer}, <:Function}})::Function
+function __build_dynamics_from_parts(
+    parts::Vector{<:Tuple{<:AbstractUnitRange{<:Integer},<:Function}}
+)::Function
     function dyn!(val, t, x, u, v)
         for (rg, f!) in parts
             f!(@view(val[rg]), t, x, u, v)
@@ -180,4 +206,3 @@ function __build_dynamics_from_parts(parts::Vector{<:Tuple{<:AbstractUnitRange{<
     end
     return dyn!
 end
-