Public API

This page lists exported symbols of CTModels.Display, CTModelsPlots.


From CTModels.Display

CTModels.Display [Module]

CTModels.DisplayModule
Display

Display and formatting module for CTModels.

This module provides functions for displaying and formatting optimal control problems and solutions in human-readable formats.

Organisation

Public API

The following functions are exported and accessible via Base.show:

  • Base.show(io::IO, ::MIME"text/plain", ocp::CTModels.Models.Model): Display an optimal control problem
  • Base.show(io::IO, ::MIME"text/plain", sol::CTModels.Solutions.Solution): Display a solution

Private API

The following are internal utilities (accessible via Display.function_name):

  • __print: Internal printing helper
  • __print_abstract_definition: Print abstract OCP definition
  • __print_mathematical_definition: Print mathematical OCP formulation

Dependencies

External: MLStyle, RecipesBase, MacroTools.

See also: CTModels.Components, CTModels.Models, CTModels.Building, CTModels.Solutions.


From CTModelsPlots

CTModelsPlots [Module]

CTModelsPlotsModule

Weak-dependency extension of CTModels providing Plots.jl recipes.

Loaded automatically when both CTModels and Plots are available in the session. Extends Plots.plot and Plots.plot! to accept a CTModels.Solution, rendering state, control, costate, and dual trajectories in a configurable layout.