added: validate economic function JE argument signature

Author: franckgaga

src/controller/nonlinmpc.jl

@@ -54,6 +54,7 @@ struct NonLinMPC{
         model = estim.model
         nu, ny, nd, nx̂ = model.nu, model.ny, model.nd, estim.nx̂
         ŷ = copy(model.yop) # dummy vals (updated just before optimization)
+        validate_JE(NT, JE)
         validate_weights(model, Hp, Hc, M_Hp, N_Hc, L_Hp, Cwt, Ewt)
         # convert `Diagonal` to normal `Matrix` if required:
         M_Hp = Hermitian(convert(Matrix{NT}, M_Hp), :L) 
@@ -284,6 +285,21 @@ function NonLinMPC(
     )
 end
 
+"""
+    validate_JE(NT, JE) -> nothing
+
+Validate `JE` function argument signature 
+"""
+function validate_JE(NT, JE)
+    if !hasmethod(JE, Tuple{Vector{NT}, Vector{NT}, Vector{NT}, Any})
+        error(
+            "the economic function has no method with type signature "*
+            "JE(UE::Vector{$(NT)}, ŶE::Vector{$(NT)}, D̂E::Vector{$(NT)}, p::Any)"
+        )
+    end
+    return nothing
+end
+
 """
     addinfo!(info, mpc::NonLinMPC) -> info
 

test/test_predictive_control.jl

@@ -521,6 +521,7 @@ end
 
     @test_throws ArgumentError NonLinMPC(nonlinmodel, Hp=15, Ewt=[1, 1])
     @test_throws ArgumentError NonLinMPC(nonlinmodel)
+    @test_throws ErrorException NonLinMPC(nonlinmodel, Hp=15, JE=(_,_,_)->0.0)
 end
 
 @testset "NonLinMPC moves and getinfo" begin