Constraint revise

[ocots]

Il faut finaliser ça.

[ocots]

There is a problem with the documentation. Maybe because of the basic example in functional form.

[ocots]

I think this does not work in this version (see here):

constraint!(ocp, :initial, [ -1, 0 ])           # initial condition
constraint!(ocp, :final,   [  0, 0 ])           # final condition

since there is no more

constraint!(
    ocp::OptimalControlModel,
    type::Symbol,
    val::Union{Real, AbstractVector{<:Real}}
)
constraint!(
    ocp::OptimalControlModel,
    type::Symbol,
    val::Union{Real, AbstractVector{<:Real}},
    label::Symbol
)

[ocots]

Do we want:

function constraint!(ocp::OptimalControlModel, 
    type::Symbol, 
    val::ctVector, 
    label::Symbol=__constraint_label())

    __constraint!(ocp, type, rg=nothing, f=nothing, lb=val, ub=val, label=label)
    nothing # to force to return nothing

end

or since we have:

function constraint!(ocp::OptimalControlModel, 
    type::Symbol, 
    lb::Union{ctVector,Nothing}, 
    ub::Union{ctVector,Nothing}, 
    label::Symbol=__constraint_label())

    __constraint!(ocp, type, rg=nothing, f=nothing, lb=lb, ub=ub, label=label)
    nothing # to force to return nothing

end

In the first case, we can write

constraint!(ocp, :initial, [ 1, 2, 1 ])

while if we do not have the first method then we should write

constraint!(ocp, :initial, [ 1, 2, 1 ], [ 1, 2, 1 ])

[jbcaillau]

@ocots @BaptisteCbl right, we should check and close it. plus the issue for time!.

[ocots]

I keep only the method constraint! with keywords.

[jbcaillau]

I keep only the method constraint! with keywords.

@ocots OK 👍🏽 Note that there are indeed consistency checks in the general (__)constraint function (check the last case of the pattern matching below):

CTBase.jl/src/model.jl

Line 676 in a7e2023

_ => throw(IncorrectArgument("Provided arguments are inconsistent"))

To me, there should only be some old functional syntax tests to update (some of them are already preventing the doc CI).

Then we must also take care of time! along the same line.

[ocots]

Up to now there is only one constraint! method.

There are indeed consistency checks but I have made more comprehensive the errors in the case of unauthorized calls:

CTBase.jl/src/model.jl

Line 623 in 0d936f4

(::RangeConstraint, ::Function) => throw(UnauthorizedCall("Providing a range (rg keyword) and a function (f keyword) is not authorized."))

Note that for the unitary tests, I have defined __constraint! to keep previous tests. See this file.

[ocots]

I think that constraint are revised (if the CI is ok) and we can make another branch for time! revision.

[jbcaillau]

@ocots is it really the only place where this is used?

[jbcaillau]

@ocots I see some blue style here, well done 👍🏽 SNCF time 🙂

[jbcaillau]

@ocots very nice tests update 👍🏽

[jbcaillau]

@ocots well done 👍🏽👍🏽 rapid test update providing __constraint! that preserves the old functional style and is mapped (and so tests) the new constraint! with named args.