CTProblems API

This is just a dump of CTProblems API documentation. For more details about CTProblems.jl package, see the documentation.

Index

Documentation

CTProblems.ProblemMethod
Problem(
    description::Symbol...
) -> CTProblems.OptimalControlProblem

Return the optimal control problem described by description.

If you give a partial description, then, if several complete descriptions contains the partial one, then, only the problem with the highest priority is returned. The higher in the list, the higher is the priority.

Example

julia> Problem(:integrator, :energy)
source
CTProblems.ProblemsMethod
Problems(
    description::Symbol...
) -> Tuple{Vararg{CTProblems.OptimalControlProblem}}

Return the list of optimal control problems consistent with the description.

If you give a partial description, then, if several complete descriptions contains the partial one, then, only the problem with the highest priority is returned. The higher in the list, the higher is the priority.

Example

julia> Problems(:integrator, :energy)
source
CTProblems.ProblemsDescriptionsMethod
ProblemsDescriptions(
    description::Symbol...
) -> Tuple{Vararg{Tuple{Vararg{Symbol}}}}

Return the list of problems descriptions consistent with the description, as a Tuple of Description.

Example

julia> ProblemsDescriptions(:integrator, :energy)
source
CTProblems.@ProblemsMacro

Return the list of problems consistent with the description.

Example

julia> @Problems :integrator & :energy
Note

You have to define a logical condition with the combination of symbols and the three operators: !, | and &, respectively for the negation, the disjunction and the conjunction.

source
CTProblems.@ProblemsDescriptionsMacro

Return the list of problems descriptions consistent with the expression.

Example

julia> @ProblemsDescriptions :integrator & :energy
Note

You have to define a logical condition with the combination of symbols and the three operators: !, | and &, respectively for the negation, the disjunction and the conjunction.

source