Skip to content

Commit

Permalink
build based on 8999240
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 5, 2024
1 parent 1ff37ff commit 3abad0c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-05T20:06:05","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-05T20:06:45","documenter_version":"1.4.1"}}
4 changes: 2 additions & 2 deletions dev/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
kwargs_Flow...
) -> CTFlows.OptimalControlFlow
</code></pre><p>Flow from an optimal control problem, a control function in feedback form, a state constraint and its associated multiplier in feedback form.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; ocp = Model(autonomous=false)
julia&gt; f = Flow(ocp, (t, x, p) -&gt; p[1], (t, x, u) -&gt; x[1] - 1, (t, x, p) -&gt; x[1]+p[1])</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The time dependence of the control function must be consistent with the time dependence of the optimal control problem. The dimension of the output of the control function must be consistent with the dimension usage of the control of the optimal control problem.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTFlows.jl/blob/70be28e4c593006d5421905a16c1facc63fdfdf2/src/optimal_control_problem.jl#L142">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CTFlows.Flow-Union{Tuple{V}, Tuple{T}, Tuple{CTBase.OptimalControlModel{T, V}, Union{CTBase.ControlLaw{T, V}, Function}}} where {T, V}" href="#CTFlows.Flow-Union{Tuple{V}, Tuple{T}, Tuple{CTBase.OptimalControlModel{T, V}, Union{CTBase.ControlLaw{T, V}, Function}}} where {T, V}"><code>CTFlows.Flow</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Flow(
julia&gt; f = Flow(ocp, (t, x, p) -&gt; p[1], (t, x, u) -&gt; x[1] - 1, (t, x, p) -&gt; x[1]+p[1])</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The time dependence of the control function must be consistent with the time dependence of the optimal control problem. The dimension of the output of the control function must be consistent with the dimension usage of the control of the optimal control problem.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTFlows.jl/blob/8999240c9e813a82e6381a71720c5760a3d68c55/src/optimal_control_problem.jl#L142">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CTFlows.Flow-Union{Tuple{V}, Tuple{T}, Tuple{CTBase.OptimalControlModel{T, V}, Union{CTBase.ControlLaw{T, V}, Function}}} where {T, V}" href="#CTFlows.Flow-Union{Tuple{V}, Tuple{T}, Tuple{CTBase.OptimalControlModel{T, V}, Union{CTBase.ControlLaw{T, V}, Function}}} where {T, V}"><code>CTFlows.Flow</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Flow(
ocp::CTBase.OptimalControlModel{T, V},
u_::Union{CTBase.ControlLaw{T, V}, Function};
alg,
Expand All @@ -20,4 +20,4 @@
saveat,
kwargs_Flow...
) -&gt; CTFlows.OptimalControlFlow
</code></pre><p>Flow from an optimal control problem and a control function in feedback form.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; f = Flow(ocp, (x, p) -&gt; p)</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The time dependence of the control function must be consistent with the time dependence of the optimal control problem. The dimension of the output of the control function must be consistent with the dimension usage of the control of the optimal control problem.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTFlows.jl/blob/70be28e4c593006d5421905a16c1facc63fdfdf2/src/optimal_control_problem.jl#L107">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index.html">« Introduction</a><a class="docs-footer-nextpage" href="dev-api.html">Developers »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 5 May 2024 20:06">Sunday 5 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Flow from an optimal control problem and a control function in feedback form.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; f = Flow(ocp, (x, p) -&gt; p)</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The time dependence of the control function must be consistent with the time dependence of the optimal control problem. The dimension of the output of the control function must be consistent with the dimension usage of the control of the optimal control problem.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTFlows.jl/blob/8999240c9e813a82e6381a71720c5760a3d68c55/src/optimal_control_problem.jl#L107">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index.html">« Introduction</a><a class="docs-footer-nextpage" href="dev-api.html">Developers »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 5 May 2024 20:06">Sunday 5 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 3abad0c

Please sign in to comment.