API

CTProblems module.

Lists all the imported modules and packages:

• Base
• CTBase
• CTFlows
• Core
• DocStringExtensions
• LinearAlgebra

List of all the exported names:

• Problem
• @Problems
• Problems
• @ProblemsDescriptions
• ProblemsDescriptions

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)

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)

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)

Return the list of problems consistent with the description.

Example

julia> @Problems :integrator & :energy

Return the list of problems descriptions consistent with the expression.

Example

julia> @ProblemsDescriptions :integrator & :energy