OptimalControl.jl (Private)
OptimalControl.jl is the root package of the control-toolbox ecosystem.
Index
Documentation
ExaModels.constraint!
— Methodconstraint!(ocp::CTModels.PreModel, type::Symbol; kwargs...)
See CTModels.constraint!.
OptimalControl.__display
— Method__display() -> Bool
Used to set the default display toggle. The default value is true.
OptimalControl.clean
— Methodclean(d::Tuple{Vararg{Symbol}}) -> Tuple{Vararg{Symbol}}
When calling the function solve
, the user can provide a description of the method to use to solve the optimal control problem. The description can be a partial description or a full description. The function solve
will find the best match from the available methods, thanks to the function getFullDescription
. Then, the description is cleaned by the function clean
to remove the Symbols that are specific to OptimalControl.jl and so must not be passed to the solver. For instance, the Symbol :direct
is specific to OptimalControl.jl and must be removed. It must not be passed to the CTDirect.jl solver.
OptimalControl.version
— MethodReturn the version of the current module as a string.
This function returns the version number defined in the Project.toml
of the package to which the current module belongs. It uses @__MODULE__
to infer the calling context.
Example
julia> version() # e.g., "1.2.3"