CTModels

Index

Warning

In the examples in the documentation below, the methods are not prefixed by the module name even if they are private.

julia> using CTModels
julia> x = 1
julia> private_fun(x) # throw an error

must be replaced by

julia> using CTModels
julia> x = 1
julia> CTModels.private_fun(x)

However, if the method is reexported by another package, then, there is no need of prefixing.

julia> module OptimalControl
           import CTModels: private_fun
           export private_fun
       end
julia> using OptimalControl
julia> x = 1
julia> private_fun(x)

Documentation

CTModels.CTModels — Module

CTModels module.

Lists all the imported modules and packages:

Base
DocStringExtensions
Interpolations
MLStyle
Parameters

List of all the exported names:

CTModels.TimesDisc — Type

Type alias for a grid of times. This is used to define a discretization of time interval given to solvers.

julia> const TimesDisc = Union{Times, StepRangeLen}

See also: Time, Times.

CTModels.AbstractTag — Type

abstract type AbstractTag

Abstract type for export/import functions, used to choose between JSON or JLD extensions.

CTModels.ConstraintsDictType — Type

Type alias for a dictionary of constraints. This is used to store constraints before building the model.

julia> const TimesDisc = Union{Times, StepRangeLen}

See also: ConstraintsModel, PreModel and Model.

CTModels.Dimension — Type

Type alias for a dimension. This is used to define the dimension of the state space, the costate space, the control space, etc.

julia> const Dimension = Integer

CTModels.JLD2Tag — Type

struct JLD2Tag <: CTModels.AbstractTag

JLD tag for export/import functions.

CTModels.JSON3Tag — Type

struct JSON3Tag <: CTModels.AbstractTag

JSON tag for export/import functions.

CTModels.Time — Type

Type alias for a time.

julia> const Time = ctNumber

See also: ctNumber, Times, TimesDisc.

CTModels.Times — Type

Type alias for a vector of times.

julia> const Times = AbstractVector{<:Time}

See also: ctNumber.

CTModels.export_ocp_solution — Method

export_ocp_solution(
    sol::CTModels.AbstractSolution;
    format,
    filename
)

Export a solution in JLD or JSON formats. Redirect to one of the methods:

Examples

julia> using JSON3
julia> export_ocp_solution(sol; filename="solution", format=:JSON)
julia> using JLD2
julia> export_ocp_solution(sol; filename="solution", format=:JLD)  # JLD is the default

CTModels.import_ocp_solution — Method

import_ocp_solution(
    ocp::CTModels.AbstractModel;
    format,
    filename
) -> Any

Import a solution from a JLD or JSON file. Redirect to one of the methods:

Examples

julia> using JSON3
julia> sol = import_ocp_solution(ocp; filename="solution", format=:JSON)
julia> using JLD2
julia> sol = import_ocp_solution(ocp; filename="solution", format=:JLD)  # JLD is the default