build based on edbed03

Author: Documenter.jl

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-09-06T17:35:06","documenter_version":"1.14.1"}}
+{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-09-06T17:35:49","documenter_version":"1.14.1"}}

dev/api-optimalcontrol-dev.html

@@ -19,9 +19,9 @@
 P --> B
 M --> B
 style O fill:#FBF275</div><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="api-optimalcontrol-dev.html#OptimalControl.__display-Tuple{}"><code>OptimalControl.__display</code></a></li><li><a href="api-optimalcontrol-dev.html#OptimalControl.clean-Tuple{Tuple{Vararg{Symbol}}}"><code>OptimalControl.clean</code></a></li><li><a href="api-optimalcontrol-dev.html#OptimalControl.version-Tuple{}"><code>OptimalControl.version</code></a></li></ul><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><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="ExaModels.constraint!-Tuple{CTModels.PreModel, Symbol}" href="#ExaModels.constraint!-Tuple{CTModels.PreModel, Symbol}"><code>ExaModels.constraint!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">constraint!(ocp::CTModels.PreModel, type::Symbol; kwargs...)
-</code></pre><p>See CTModels.constraint!.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/dfbab956d8a513181de1361b495327af5eb4293a/src/OptimalControl.jl#L227">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="OptimalControl.__display-Tuple{}" href="#OptimalControl.__display-Tuple{}"><code>OptimalControl.__display</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">__display() -&gt; Bool
-</code></pre><p>Used to set the default display toggle. The default value is true.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/dfbab956d8a513181de1361b495327af5eb4293a/src/solve.jl#L1">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="OptimalControl.clean-Tuple{Tuple{Vararg{Symbol}}}" href="#OptimalControl.clean-Tuple{Tuple{Vararg{Symbol}}}"><code>OptimalControl.clean</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clean(d::Tuple{Vararg{Symbol}}) -&gt; Tuple{Vararg{Symbol}}
-</code></pre><p>When calling the function <code>solve</code>, the user can provide a description of the method to use to solve the optimal control problem. The description can be a partial description or a full description. The function <code>solve</code> will find the best match from the available methods, thanks to the function <code>getFullDescription</code>. Then, the description is cleaned by the function <code>clean</code> to remove the Symbols that are specific to  <a href="https://control-toolbox.org/OptimalControl.jl">OptimalControl.jl</a> and so must not be passed to the solver. For instance, the Symbol <code>:direct</code> is specific to <a href="https://control-toolbox.org/OptimalControl.jl">OptimalControl.jl</a> and must be removed. It must not be passed to the CTDirect.jl solver.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/dfbab956d8a513181de1361b495327af5eb4293a/src/solve.jl#L36">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="OptimalControl.version-Tuple{}" href="#OptimalControl.version-Tuple{}"><code>OptimalControl.version</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><p>Return the version of the current module as a string.</p><p>This function returns the version number defined in the <code>Project.toml</code> of the package to which the current module belongs. It uses <code>@__MODULE__</code> to infer the calling context.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; version()   # e.g., &quot;1.2.3&quot;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/dfbab956d8a513181de1361b495327af5eb4293a/src/solve.jl#L9-L19">source</a></section></article><script type="module">import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
+</code></pre><p>See CTModels.constraint!.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/edbed03a04b2b7ef37fb0ed6f5f1a870b81f905c/src/OptimalControl.jl#L227">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="OptimalControl.__display-Tuple{}" href="#OptimalControl.__display-Tuple{}"><code>OptimalControl.__display</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">__display() -&gt; Bool
+</code></pre><p>Used to set the default display toggle. The default value is true.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/edbed03a04b2b7ef37fb0ed6f5f1a870b81f905c/src/solve.jl#L1">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="OptimalControl.clean-Tuple{Tuple{Vararg{Symbol}}}" href="#OptimalControl.clean-Tuple{Tuple{Vararg{Symbol}}}"><code>OptimalControl.clean</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">clean(d::Tuple{Vararg{Symbol}}) -&gt; Tuple{Vararg{Symbol}}
+</code></pre><p>When calling the function <code>solve</code>, the user can provide a description of the method to use to solve the optimal control problem. The description can be a partial description or a full description. The function <code>solve</code> will find the best match from the available methods, thanks to the function <code>getFullDescription</code>. Then, the description is cleaned by the function <code>clean</code> to remove the Symbols that are specific to  <a href="https://control-toolbox.org/OptimalControl.jl">OptimalControl.jl</a> and so must not be passed to the solver. For instance, the Symbol <code>:direct</code> is specific to <a href="https://control-toolbox.org/OptimalControl.jl">OptimalControl.jl</a> and must be removed. It must not be passed to the CTDirect.jl solver.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/edbed03a04b2b7ef37fb0ed6f5f1a870b81f905c/src/solve.jl#L36">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="OptimalControl.version-Tuple{}" href="#OptimalControl.version-Tuple{}"><code>OptimalControl.version</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><p>Return the version of the current module as a string.</p><p>This function returns the version number defined in the <code>Project.toml</code> of the package to which the current module belongs. It uses <code>@__MODULE__</code> to infer the calling context.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; version()   # e.g., &quot;1.2.3&quot;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/OptimalControl.jl/blob/edbed03a04b2b7ef37fb0ed6f5f1a870b81f905c/src/solve.jl#L9-L19">source</a></section></article><script type="module">import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
 mermaid.initialize({
     startOnLoad: true,
     theme: "neutral"