CTBase.jl
The CTBase.jl package is part of the control-toolbox ecosystem.
flowchart TD
O(<a href='https://control-toolbox.org/OptimalControl.jl/stable/'>OptimalControl</a>) --> B(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctbase.html'>CTBase</a>)
O --> D(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctdirect.html'>CTDirect</a>)
O --> F(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctflows.html'>CTFlows</a>)
F --> B
D --> B
style B fill:#FBF275
You may find in this package:
- Description: tools to manipulate tuples.
- Differential geometry: tools to compute Lie brackets, Poisson brackets...
- Exceptions.
- Initial guess: tools to define an initial guess.
- Model: tools to model an optimal control problem in a functional manner.
- Parser: tools to model an optimal control problem in an abstract manner.
- Print: check how an optimal control problem is displayed.
- Repl: control-toolbox repl.
- Solution: optimal control solution.
- Types: the common types and associated methods if any.
- Utils: auxiliary methods.
Here is the list of imported packages and exported functions.
CTBase.CTBase — ModuleCTBase module.
Lists all the imported modules and packages:
BaseCoreDataStructuresDocStringExtensionsLinearAlgebraMLStyleParametersPrettyTablesPrintfReplMakerUnicode
List of all the exported names:
AbstractHamiltonianAmbiguousDescriptionAutonomousBoundaryConstraintCTExceptionControlControlConstraintControlLawControlsCostateCostatesDCostateDStateDescriptionDimensionDynamicsExtensionErrorFeedbackControlFixedHamiltonianHamiltonianLiftHamiltonianVectorFieldIncorrectArgumentIncorrectMethodIncorrectOutputIndexLagrange@LieLieLiftMayerMixedConstraintModelMultiplierNonAutonomousNonFixedNotImplementedOptimalControlInitOptimalControlModelOptimalControlSolutionParsingErrorPoissonStateStateConstraintStatesTimeTimeDependenceTimesTimesDiscUnauthorizedCallVariableVariableConstraintVariableDependenceVectorField__OCPModeladdboundary_constraintsboundary_constraints!constraintconstraint!constraint_typeconstraints_labelscontrolcontrol!control_components_namescontrol_constraintscontrol_constraints!control_dimensioncontrol_discretizedcontrol_namecostatecostate!costate_discretizedcriterionctNumberctVectorct_replct_repl_update_modelctgradientctindicesctinterpolatectjacobianctupperscripts@defdim_boundary_constraintsdim_control_constraintsdim_control_rangedim_mixed_constraintsdim_path_constraintsdim_state_constraintsdim_state_rangedim_variable_constraintsdim_variable_rangedynamicsdynamics!final_timefinal_time_namegetFullDescriptionhas_free_final_timehas_free_initial_timehas_lagrange_costhas_mayer_costinfosinfos!initial_timeinitial_time_nameis_autonomousis_fixedis_maxis_minis_time_dependentis_time_independentis_variable_dependentis_variable_independentiterationsiterations!lagrangemayermessagemessage!mixed_constraintsmixed_constraints!model_expressionmult_boundary_constraintsmult_boundary_constraints!mult_control_box_lowermult_control_box_lower!mult_control_box_uppermult_control_box_upper!mult_control_constraintsmult_control_constraints!mult_mixed_constraintsmult_mixed_constraints!mult_state_box_lowermult_state_box_lower!mult_state_box_uppermult_state_box_upper!mult_state_constraintsmult_state_constraints!mult_variable_box_lowermult_variable_box_lower!mult_variable_box_uppermult_variable_box_upper!mult_variable_constraintsmult_variable_constraints!nlp_constraints!objectiveobjective!removeremove_constraint!replace_callset_AD_backendstatestate!state_components_namesstate_constraintsstate_constraints!state_dimensionstate_discretizedstate_namestoppingstopping!successsuccess!time!time_gridtime_grid!time_namevariablevariable!variable_components_namesvariable_constraintsvariable_constraints!variable_dimensionvariable_name∂ₜ⋅
For the developers, here are the private methods.