Skip to content

Commit

Permalink
build based on 73c1595
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 24, 2024
1 parent d4079cb commit 4a8969f
Show file tree
Hide file tree
Showing 41 changed files with 2,400 additions and 2,400 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.4","generation_timestamp":"2024-06-21T10:55:45","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-24T11:41:30","documenter_version":"1.4.1"}}
112 changes: 56 additions & 56 deletions dev/api-ctbase.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api-ctdirect.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@
mu_strategy,
kwargs...
) -> OptimalControlSolution
</code></pre><p>Solve an optimal control problem OCP by direct method</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/v0.6.1/src/solve.jl#L99">source</a></section></article></article><nav class="docs-footer"><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="Friday 21 June 2024 10:55">Friday 21 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Solve an optimal control problem OCP by direct method</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/v0.6.1/src/solve.jl#L99">source</a></section></article></article><nav class="docs-footer"><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="Monday 24 June 2024 11:41">Monday 24 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/api-ctflows.html
Original file line number Diff line number Diff line change
Expand Up @@ -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/v0.3.7/src/optimal_control_problem.jl#L107">source</a></section></article></article><nav class="docs-footer"><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="Friday 21 June 2024 10:55">Friday 21 June 2024</span>. Using Julia version 1.10.4.</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/v0.3.7/src/optimal_control_problem.jl#L107">source</a></section></article></article><nav class="docs-footer"><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="Monday 24 June 2024 11:41">Monday 24 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/api-ctproblems.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
</code></pre><p>Return the list of optimal control problems consistent with the description.</p><p>If you give a partial description, then, if several complete descriptions contains the partial one, then, only the problem with the highest priority is returned. The higher in the list, the higher is the priority.</p><p><strong>Example</strong></p><pre><code class="language- hljs">julia&gt; Problems(:integrator, :energy)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTProblems.jl/blob/v0.5.9/src/problem.jl#L149">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="CTProblems.ProblemsDescriptions-Tuple{Vararg{Symbol}}" href="#CTProblems.ProblemsDescriptions-Tuple{Vararg{Symbol}}"><code>CTProblems.ProblemsDescriptions</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ProblemsDescriptions(
description::Symbol...
) -&gt; Tuple{Vararg{Tuple{Vararg{Symbol}}}}
</code></pre><p>Return the list of problems descriptions consistent with the description, as a Tuple of Description. </p><p><strong>Example</strong></p><pre><code class="language- hljs">julia&gt; ProblemsDescriptions(:integrator, :energy)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTProblems.jl/blob/v0.5.9/src/problem.jl#L132">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="CTProblems.@Problems" href="#CTProblems.@Problems"><code>CTProblems.@Problems</code></a><span class="docstring-category">Macro</span></header><section><div><p>Return the list of problems consistent with the description.</p><p><strong>Example</strong></p><pre><code class="language- hljs">julia&gt; @Problems :integrator &amp; :energy</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>You have to define a logical condition with the combination of symbols and the three operators: <code>!</code>, <code>|</code> and <code>&amp;</code>, respectively for the negation, the disjunction and the conjunction.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTProblems.jl/blob/v0.5.9/src/problem.jl#L270">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="CTProblems.@ProblemsDescriptions" href="#CTProblems.@ProblemsDescriptions"><code>CTProblems.@ProblemsDescriptions</code></a><span class="docstring-category">Macro</span></header><section><div><p>Return the list of problems descriptions consistent with the expression.</p><p><strong>Example</strong></p><pre><code class="language- hljs">julia&gt; @ProblemsDescriptions :integrator &amp; :energy</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>You have to define a logical condition with the combination of symbols and the three operators: <code>!</code>, <code>|</code> and <code>&amp;</code>, respectively for the negation, the disjunction and the conjunction.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTProblems.jl/blob/v0.5.9/src/problem.jl#L244">source</a></section></article></article><nav class="docs-footer"><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="Friday 21 June 2024 10:55">Friday 21 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Return the list of problems descriptions consistent with the description, as a Tuple of Description. </p><p><strong>Example</strong></p><pre><code class="language- hljs">julia&gt; ProblemsDescriptions(:integrator, :energy)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTProblems.jl/blob/v0.5.9/src/problem.jl#L132">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="CTProblems.@Problems" href="#CTProblems.@Problems"><code>CTProblems.@Problems</code></a><span class="docstring-category">Macro</span></header><section><div><p>Return the list of problems consistent with the description.</p><p><strong>Example</strong></p><pre><code class="language- hljs">julia&gt; @Problems :integrator &amp; :energy</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>You have to define a logical condition with the combination of symbols and the three operators: <code>!</code>, <code>|</code> and <code>&amp;</code>, respectively for the negation, the disjunction and the conjunction.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTProblems.jl/blob/v0.5.9/src/problem.jl#L270">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="CTProblems.@ProblemsDescriptions" href="#CTProblems.@ProblemsDescriptions"><code>CTProblems.@ProblemsDescriptions</code></a><span class="docstring-category">Macro</span></header><section><div><p>Return the list of problems descriptions consistent with the expression.</p><p><strong>Example</strong></p><pre><code class="language- hljs">julia&gt; @ProblemsDescriptions :integrator &amp; :energy</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>You have to define a logical condition with the combination of symbols and the three operators: <code>!</code>, <code>|</code> and <code>&amp;</code>, respectively for the negation, the disjunction and the conjunction.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTProblems.jl/blob/v0.5.9/src/problem.jl#L244">source</a></section></article></article><nav class="docs-footer"><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="Monday 24 June 2024 11:41">Monday 24 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4a8969f

Please sign in to comment.