Private API

This page lists non-exported (internal) symbols of CTModels.


From CTModels

__print

CTModels.__printFunction
__print(e::Expr, io::IO, l::Int64)

Print an expression with indentation.

Arguments

  • e::Expr: The expression to print.
  • io::IO: The output stream.
  • l::Int: The indentation level (number of spaces).

__print_abstract_definition

CTModels.__print_abstract_definitionFunction
__print_abstract_definition(
    io::IO,
    ocp::Union{CTModels.PreModel, CTModels.Model}
) -> Bool

Print the abstract definition of an optimal control problem.

Arguments

  • io::IO: The output stream.
  • ocp::Union{Model,PreModel}: The optimal control problem.

Returns

  • Bool: true if something was printed.

__print_mathematical_definition

CTModels.__print_mathematical_definitionFunction
__print_mathematical_definition(
    io::IO,
    some_printing::Bool,
    x_dim::Int64,
    u_dim::Int64,
    v_dim::Int64,
    t_name::String,
    t0_name::String,
    tf_name::String,
    x_name::String,
    u_name::String,
    v_name::String,
    xi_names::Vector{String},
    ui_names::Vector{String},
    vi_names::Vector{String},
    is_variable_dependent::Bool,
    is_time_dependent::Bool,
    has_a_lagrange_cost::Bool,
    has_a_mayer_cost::Bool,
    dim_path_cons_nl::Int64,
    dim_boundary_cons_nl::Int64,
    dim_state_cons_box::Int64,
    dim_control_cons_box::Int64,
    dim_variable_cons_box::Int64
) -> Bool

Print the mathematical definition of an optimal control problem.

Displays the problem in standard mathematical notation with objective, dynamics, and constraints.

Returns

  • Bool: true if something was printed.