Skip to content

Commit 6b42b92

Browse files
committed
doc: return args of init_predmat and init_defectmat
1 parent 049bbc7 commit 6b42b92

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

src/controller/transcription.jl

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ end
256256
@doc raw"""
257257
init_predmat(
258258
model::LinModel, estim, transcription::SingleShooting, Hp, Hc, nb
259-
) -> E, G, J, K, V, ex̂, gx̂, jx̂, kx̂, vx̂
259+
) -> E, G, J, K, V, B, ex̂, gx̂, jx̂, kx̂, vx̂, bx̂
260260
261261
Construct the prediction matrices for [`LinModel`](@ref) and [`SingleShooting`](@ref).
262262
@@ -484,7 +484,9 @@ function init_predmat(
484484
end
485485

486486
"""
487-
init_predmat(model::NonLinModel, estim, transcription::SingleShooting, Hp, Hc, nb)
487+
init_predmat(
488+
model::NonLinModel, estim, transcription::SingleShooting, Hp, Hc, nb
489+
) -> E, G, J, K, V, B, ex̂, gx̂, jx̂, kx̂, vx̂, bx̂
488490
489491
Return empty matrices for [`SingleShooting`](@ref) of [`NonLinModel`](@ref)
490492
"""
@@ -504,7 +506,9 @@ function init_predmat(
504506
end
505507

506508
@doc raw"""
507-
init_predmat(model::NonLinModel, estim, transcription::TranscriptionMethod, Hp, Hc, nb)
509+
init_predmat(
510+
model::NonLinModel, estim, transcription::TranscriptionMethod, Hp, Hc, nb
511+
) -> E, G, J, K, V, B, ex̂, gx̂, jx̂, kx̂, vx̂, bx̂
508512
509513
Return the terminal state matrices for [`NonLinModel`](@ref) and other [`TranscriptionMethod`](@ref).
510514
@@ -537,7 +541,9 @@ function init_predmat(
537541
end
538542

539543
@doc raw"""
540-
init_defectmat(model::LinModel, estim, transcription::MultipleShooting, Hp, Hc, nb)
544+
init_defectmat(
545+
model::LinModel, estim, transcription::MultipleShooting, Hp, Hc, nb
546+
) -> Eŝ, Gŝ, Jŝ, Kŝ, Vŝ, Bŝ
541547
542548
Init the matrices for computing the defects over the predicted states.
543549
@@ -645,7 +651,9 @@ function init_defectmat(
645651
end
646652

647653
"""
648-
init_defectmat(model::SimModel, estim, transcription::TranscriptionMethod, Hp, Hc, nb)
654+
init_defectmat(
655+
model::SimModel, estim, transcription::TranscriptionMethod, Hp, Hc, nb
656+
) -> Eŝ, Gŝ, Jŝ, Kŝ, Vŝ, Bŝ
649657
650658
Return empty matrices for all other cases (N/A).
651659
"""

0 commit comments

Comments
 (0)