Skip to content

Commit

Permalink
build based on fb16947
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 1, 2024
1 parent 1fe3f21 commit 85b7008
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 42 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-01T17:04:18","documenter_version":"1.6.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-01T17:04:44","documenter_version":"1.6.0"}}
2 changes: 1 addition & 1 deletion dev/api-ctbase.html
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions dev/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · CTDirect.jl</title><meta name="title" content="API · CTDirect.jl"/><meta property="og:title" content="API · CTDirect.jl"/><meta property="twitter:title" content="API · CTDirect.jl"/><meta name="description" content="Documentation for CTDirect.jl."/><meta property="og:description" content="Documentation for CTDirect.jl."/><meta property="twitter:description" content="Documentation for CTDirect.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script><link href="https://control-toolbox.org/assets/css/documentation.css" rel="stylesheet" type="text/css"/><script src="https://control-toolbox.org/assets/js/documentation.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">CTDirect.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="index.html">Introduction</a></li><li class="is-active"><a class="tocitem" href="api.html">API</a><ul class="internal"><li><a class="tocitem" href="#Index"><span>Index</span></a></li><li><a class="tocitem" href="#Documentation"><span>Documentation</span></a></li></ul></li><li><a class="tocitem" href="dev-api.html">Developers</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="api.html">API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="api.html">API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/control-toolbox/CTDirect.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/control-toolbox/CTDirect.jl/blob/main/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="CTDirect-API"><a class="docs-heading-anchor" href="#CTDirect-API">CTDirect API</a><a id="CTDirect-API-1"></a><a class="docs-heading-anchor-permalink" href="#CTDirect-API" title="Permalink"></a></h1><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.html#CTDirect.available_methods-Tuple{}"><code>CTDirect.available_methods</code></a></li><li><a href="api.html#CTDirect.direct_solve-Tuple{OptimalControlModel, Vararg{Symbol}}"><code>CTDirect.direct_solve</code></a></li><li><a href="api.html#CTDirect.direct_transcription-Tuple{OptimalControlModel, Vararg{Any}}"><code>CTDirect.direct_transcription</code></a></li><li><a href="api.html#CTDirect.export_ocp_solution"><code>CTDirect.export_ocp_solution</code></a></li><li><a href="api.html#CTDirect.import_ocp_solution"><code>CTDirect.import_ocp_solution</code></a></li><li><a href="api.html#CTDirect.is_solvable-Tuple{Any}"><code>CTDirect.is_solvable</code></a></li><li><a href="api.html#CTDirect.set_initial_guess-Tuple{CTDirect.DOCP, Any, Any}"><code>CTDirect.set_initial_guess</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="CTDirect.available_methods-Tuple{}" href="#CTDirect.available_methods-Tuple{}"><code>CTDirect.available_methods</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">available_methods(

) -&gt; Tuple{Tuple{Symbol, Symbol}, Tuple{Symbol, Symbol}}
</code></pre><p>Return the list of available methods to solve the optimal control problem.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/ba5ff3ab9872608aef8b34f2408ee8c18606ebbe/src/solve.jl#L3">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="CTDirect.direct_solve-Tuple{OptimalControlModel, Vararg{Symbol}}" href="#CTDirect.direct_solve-Tuple{OptimalControlModel, Vararg{Symbol}}"><code>CTDirect.direct_solve</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">direct_solve(
</code></pre><p>Return the list of available methods to solve the optimal control problem.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/fb169475494be3da679a19acef89b544a8872839/src/solve.jl#L3">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="CTDirect.direct_solve-Tuple{OptimalControlModel, Vararg{Symbol}}" href="#CTDirect.direct_solve-Tuple{OptimalControlModel, Vararg{Symbol}}"><code>CTDirect.direct_solve</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">direct_solve(
ocp::OptimalControlModel,
description::Symbol...;
init,
grid_size,
time_grid,
kwargs...
) -&gt; OptimalControlSolution
</code></pre><p>Solve an OCP with a direct method</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/ba5ff3ab9872608aef8b34f2408ee8c18606ebbe/src/solve.jl#L80">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="CTDirect.direct_transcription-Tuple{OptimalControlModel, Vararg{Any}}" href="#CTDirect.direct_transcription-Tuple{OptimalControlModel, Vararg{Any}}"><code>CTDirect.direct_transcription</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">direct_transcription(
</code></pre><p>Solve an OCP with a direct method</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/fb169475494be3da679a19acef89b544a8872839/src/solve.jl#L80">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="CTDirect.direct_transcription-Tuple{OptimalControlModel, Vararg{Any}}" href="#CTDirect.direct_transcription-Tuple{OptimalControlModel, Vararg{Any}}"><code>CTDirect.direct_transcription</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">direct_transcription(
ocp::OptimalControlModel,
description...;
init,
grid_size,
time_grid
) -&gt; Tuple{CTDirect.DOCP, ADNLPModels.ADNLPModel{Float64, Vector{Float64}, Vector{Int64}}}
</code></pre><p>Discretize an optimal control problem into a nonlinear optimization problem (ie direct transcription)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/ba5ff3ab9872608aef8b34f2408ee8c18606ebbe/src/solve.jl#L16">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="CTDirect.is_solvable-Tuple{Any}" href="#CTDirect.is_solvable-Tuple{Any}"><code>CTDirect.is_solvable</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">is_solvable(ocp) -&gt; Bool
</code></pre><p>Check if an OCP is solvable by the method <a href="@ref"><code>solve</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/ba5ff3ab9872608aef8b34f2408ee8c18606ebbe/src/problem.jl#L184">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="CTDirect.set_initial_guess-Tuple{CTDirect.DOCP, Any, Any}" href="#CTDirect.set_initial_guess-Tuple{CTDirect.DOCP, Any, Any}"><code>CTDirect.set_initial_guess</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">set_initial_guess(docp::CTDirect.DOCP, nlp, init) -&gt; Any
</code></pre><p>Set initial guess in the DOCP</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/ba5ff3ab9872608aef8b34f2408ee8c18606ebbe/src/solve.jl#L62">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="CTDirect.export_ocp_solution" href="#CTDirect.export_ocp_solution"><code>CTDirect.export_ocp_solution</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">export_ocp_solution(
</code></pre><p>Discretize an optimal control problem into a nonlinear optimization problem (ie direct transcription)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/fb169475494be3da679a19acef89b544a8872839/src/solve.jl#L16">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="CTDirect.is_solvable-Tuple{Any}" href="#CTDirect.is_solvable-Tuple{Any}"><code>CTDirect.is_solvable</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">is_solvable(ocp) -&gt; Bool
</code></pre><p>Check if an OCP is solvable by the method <a href="@ref"><code>solve</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/fb169475494be3da679a19acef89b544a8872839/src/problem.jl#L184">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="CTDirect.set_initial_guess-Tuple{CTDirect.DOCP, Any, Any}" href="#CTDirect.set_initial_guess-Tuple{CTDirect.DOCP, Any, Any}"><code>CTDirect.set_initial_guess</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">set_initial_guess(docp::CTDirect.DOCP, nlp, init) -&gt; Any
</code></pre><p>Set initial guess in the DOCP</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/fb169475494be3da679a19acef89b544a8872839/src/solve.jl#L62">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="CTDirect.export_ocp_solution" href="#CTDirect.export_ocp_solution"><code>CTDirect.export_ocp_solution</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">export_ocp_solution(
sol::OptimalControlSolution;
filename_prefix
)
</code></pre><p>Export OCP solution in JSON format</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/ba5ff3ab9872608aef8b34f2408ee8c18606ebbe/ext/CTDirectExt.jl#L29">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="CTDirect.import_ocp_solution" href="#CTDirect.import_ocp_solution"><code>CTDirect.import_ocp_solution</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">import_ocp_solution(
</code></pre><p>Export OCP solution in JSON format</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/fb169475494be3da679a19acef89b544a8872839/ext/CTDirectExt.jl#L29">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="CTDirect.import_ocp_solution" href="#CTDirect.import_ocp_solution"><code>CTDirect.import_ocp_solution</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">import_ocp_solution(
ocp::OptimalControlModel;
filename_prefix
) -&gt; OptimalControlSolution
</code></pre><p>Read OCP solution in JSON format</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/ba5ff3ab9872608aef8b34f2408ee8c18606ebbe/ext/CTDirectExt.jl#L50">source</a></section></article><script type="module">import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
</code></pre><p>Read OCP solution in JSON format</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTDirect.jl/blob/fb169475494be3da679a19acef89b544a8872839/ext/CTDirectExt.jl#L50">source</a></section></article><script type="module">import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
mermaid.initialize({
startOnLoad: true,
theme: "neutral"
Expand Down
Loading

0 comments on commit 85b7008

Please sign in to comment.