Skip to content

Commit

Permalink
build based on 4afac10
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 29, 2024
1 parent 73934b2 commit c458939
Show file tree
Hide file tree
Showing 16 changed files with 159 additions and 159 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-29T11:59:28","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-29T16:58:42","documenter_version":"1.5.0"}}
6 changes: 3 additions & 3 deletions dev/api-callbacks.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api-ctbase.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/api-description.html

Large diffs are not rendered by default.

108 changes: 54 additions & 54 deletions dev/api-developers.html

Large diffs are not rendered by default.

46 changes: 23 additions & 23 deletions dev/api-diffgeom.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api-exceptions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api-init.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
julia> init = OptimalControlInit(x_init=[0.1, 0.2], u_init=0.3)
julia> init = OptimalControlInit(x_init=[0.1, 0.2], u_init=0.3, v_init=0.5)
julia> init = OptimalControlInit(x_init=[0.1, 0.2], u_init=t->sin(t), v_init=0.5)
julia&gt; init = OptimalControlInit(sol)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/e5c77baf9d6b00f6b6a13fc1615d6b2f1f3e7f12/src/init.jl#L1">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-exceptions.html">« Exceptions</a><a class="docs-footer-nextpage" href="api-model.html">Model »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Saturday 29 June 2024 11:59">Saturday 29 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; init = OptimalControlInit(sol)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/4afac1099f10e3468c4c5217a2933422b00571f2/src/init.jl#L1">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-exceptions.html">« Exceptions</a><a class="docs-footer-nextpage" href="api-model.html">Model »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Saturday 29 June 2024 16:58">Saturday 29 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
70 changes: 35 additions & 35 deletions dev/api-model.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/api-parser.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
julia&gt; constraint_type(:( v^2 + 1 ), t, t0, tf, x, u, v)
:variable_fun
julia&gt; constraint_type(:( v[2]^2 + 1 ), t, t0, tf, x, u, v)
:variable_fun</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/e5c77baf9d6b00f6b6a13fc1615d6b2f1f3e7f12/src/ctparser_utils.jl#L219">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="CTBase.replace_call-Tuple{Any, Symbol, Any, Any}" href="#CTBase.replace_call-Tuple{Any, Symbol, Any, Any}"><code>CTBase.replace_call</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">replace_call(e, x::Symbol, t, y) -&gt; Any
:variable_fun</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/4afac1099f10e3468c4c5217a2933422b00571f2/src/ctparser_utils.jl#L219">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="CTBase.replace_call-Tuple{Any, Symbol, Any, Any}" href="#CTBase.replace_call-Tuple{Any, Symbol, Any, Any}"><code>CTBase.replace_call</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">replace_call(e, x::Symbol, t, y) -&gt; Any
</code></pre><p>Replace calls in e of the form <code>(...x...)(t)</code> by <code>(...y...)</code>.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">
julia&gt; t = :t; t0 = 0; tf = :tf; x = :x; u = :u;

Expand All @@ -132,7 +132,7 @@
:(F0(x) + u * F1(x))

julia&gt; e = :( 0.5u(t)^2 ); replace_call(e, u, t, u)
:(0.5 * u ^ 2)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/e5c77baf9d6b00f6b6a13fc1615d6b2f1f3e7f12/src/ctparser_utils.jl#L63">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="CTBase.replace_call-Tuple{Any, Vector{Symbol}, Any, Any}" href="#CTBase.replace_call-Tuple{Any, Vector{Symbol}, Any, Any}"><code>CTBase.replace_call</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">replace_call(e, x::Vector{Symbol}, t, y) -&gt; Any
:(0.5 * u ^ 2)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/4afac1099f10e3468c4c5217a2933422b00571f2/src/ctparser_utils.jl#L63">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="CTBase.replace_call-Tuple{Any, Vector{Symbol}, Any, Any}" href="#CTBase.replace_call-Tuple{Any, Vector{Symbol}, Any, Any}"><code>CTBase.replace_call</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">replace_call(e, x::Vector{Symbol}, t, y) -&gt; Any
</code></pre><p>Replace calls in e of the form <code>(...x1...x2...)(t)</code> by <code>(...y1...y2...)</code> for all symbols <code>x1</code>, <code>x2</code>... in the vector <code>x</code>.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">
julia&gt; t = :t; t0 = 0; tf = :tf; x = :x; u = :u;

Expand All @@ -143,7 +143,7 @@
:(xx ^ 2 + uu[1])

julia&gt; e = :( ((x^2)(t0) + u[1])(t) ); replace_call(e, [ x, u ], t , [ :xx, :uu ])
:((xx ^ 2)(t0) + uu[1])</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/e5c77baf9d6b00f6b6a13fc1615d6b2f1f3e7f12/src/ctparser_utils.jl#L94">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="CTBase.@def" href="#CTBase.@def"><code>CTBase.@def</code></a><span class="docstring-category">Macro</span></header><section><div><p>Define an optimal control problem. One pass parsing of the definition.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">@def ocp begin
:((xx ^ 2)(t0) + uu[1])</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/4afac1099f10e3468c4c5217a2933422b00571f2/src/ctparser_utils.jl#L94">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="CTBase.@def" href="#CTBase.@def"><code>CTBase.@def</code></a><span class="docstring-category">Macro</span></header><section><div><p>Define an optimal control problem. One pass parsing of the definition.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">@def ocp begin
tf ∈ R, variable
t ∈ [ 0, tf ], time
x ∈ R², state
Expand All @@ -160,5 +160,5 @@
-2 ≤ v(t) ≤ 3, (2)
ẋ(t) == [ v(t), u(t) ]
tf → min
end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/e5c77baf9d6b00f6b6a13fc1615d6b2f1f3e7f12/src/onepass.jl#L444">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="CTBase.__OCPModel-Tuple" href="#CTBase.__OCPModel-Tuple"><code>CTBase.__OCPModel</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">__OCPModel(args...; kwargs...) -&gt; OptimalControlModel
</code></pre><p>Redirection to <a href="api-model.html#Model"><code>Model</code></a> to avoid confusion with other functions Model from other packages if imported. This function is used by <a href="api-parser.html#CTBase.@def"><code>@def</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/e5c77baf9d6b00f6b6a13fc1615d6b2f1f3e7f12/src/onepass.jl#L433">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-model.html">« Model</a><a class="docs-footer-nextpage" href="api-plot.html">Plot »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Saturday 29 June 2024 11:59">Saturday 29 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/4afac1099f10e3468c4c5217a2933422b00571f2/src/onepass.jl#L444">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="CTBase.__OCPModel-Tuple" href="#CTBase.__OCPModel-Tuple"><code>CTBase.__OCPModel</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">__OCPModel(args...; kwargs...) -&gt; OptimalControlModel
</code></pre><p>Redirection to <a href="api-model.html#Model"><code>Model</code></a> to avoid confusion with other functions Model from other packages if imported. This function is used by <a href="api-parser.html#CTBase.@def"><code>@def</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/4afac1099f10e3468c4c5217a2933422b00571f2/src/onepass.jl#L433">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-model.html">« Model</a><a class="docs-footer-nextpage" href="api-plot.html">Plot »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Saturday 29 June 2024 16:58">Saturday 29 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 c458939

Please sign in to comment.