Skip to content

Commit 8bc2a90

Browse files
committed
doc: seperate section for transcription methods
1 parent 2452a17 commit 8bc2a90

4 files changed

Lines changed: 40 additions & 33 deletions

File tree

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ makedocs(
4848
"Plant Models" => "public/sim_model.md",
4949
"State Estimators" => "public/state_estim.md",
5050
"Predictive Controllers" => "public/predictive_control.md",
51+
"Transcription Methods" => "public/transcription.md",
5152
"Generic Functions" => "public/generic_func.md",
5253
"Simulations and Plots" => "public/plot_sim.md",
5354
],

docs/src/public/predictive_control.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -103,35 +103,3 @@ NonLinMPC
103103
```@docs
104104
moveinput!
105105
```
106-
107-
## Direct Transcription Methods
108-
109-
### TranscriptionMethod
110-
111-
```@docs
112-
ModelPredictiveControl.TranscriptionMethod
113-
```
114-
115-
### SingleShooting
116-
117-
```@docs
118-
SingleShooting
119-
```
120-
121-
### MultipleShooting
122-
123-
```@docs
124-
MultipleShooting
125-
```
126-
127-
### TrapezoidalCollocation
128-
129-
```@docs
130-
TrapezoidalCollocation
131-
```
132-
133-
### OrthogonalCollocation
134-
135-
```@docs
136-
OrthogonalCollocation
137-
```

docs/src/public/transcription.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Functions: Direct Transcription Methods
2+
3+
```@contents
4+
Pages = ["transcription.md"]
5+
```
6+
7+
This page contains the documentation of the direct transcription methods used to
8+
construct [`MovingHorizonEstimator`](@ref), [`LinMPC`](@ref) and [`NonLinMPC`](@ref) types.
9+
10+
## TranscriptionMethod
11+
12+
```@docs
13+
ModelPredictiveControl.TranscriptionMethod
14+
```
15+
16+
## SingleShooting
17+
18+
```@docs
19+
SingleShooting
20+
```
21+
22+
## MultipleShooting
23+
24+
```@docs
25+
MultipleShooting
26+
```
27+
28+
## TrapezoidalCollocation
29+
30+
```@docs
31+
TrapezoidalCollocation
32+
```
33+
34+
## OrthogonalCollocation
35+
36+
```@docs
37+
OrthogonalCollocation
38+
```

src/transcription.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
const COLLOCATION_NODE_TYPE = Float64
22

33
"""
4-
Abstract supertype of all transcription methods of [`PredictiveController`](@ref).
4+
Abstract supertype of all transcription methods for the optimal control/estimation problems.
55
66
The module currently supports [`SingleShooting`](@ref), [`MultipleShooting`](@ref),
77
[`TrapezoidalCollocation`](@ref) and [`OrthogonalCollocation`](@ref) transcription methods.

0 commit comments

Comments
 (0)