build based on 83d6a37

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-19T05:01:11","documenter_version":"1.1.2"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-19T05:05:05","documenter_version":"1.1.2"}}

dev/index.html

@@ -21,4 +21,4 @@
 & \quad z_1 = z_{\text{initial}} \\
 & \quad z_T = z_{\text{final}} \\
 & \quad z_{\min} < z_t < z_{\max} \\
-\end{align*}\]</p><p>The <code>NamedTrajectories</code> package provides a <code>NamedTrajectory</code> type which abstracts away the messy indexing and vectorization details required for interfacing with numerical solvers.  It also provides a variety of helpful methods for common tasks.  For example, you can access the data by name or index.  In the case of an index, a <code>KnotPoint</code> is returned which contains the data for that timestep.</p><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><ul><li>Abstract away messy indexing and vectorization details required for interfacing with numerical solvers.</li><li>Easily handle multiple trajectories with different names, e.g. various states and controls.</li><li>Simple plotting of trajectories.</li><li>Provide a variety of helpful methods for common tasks.</li></ul><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="lib/#NamedTrajectories.MethodsNamedTrajectory.add_component!-Tuple{NamedTrajectory, Symbol, AbstractVecOrMat{Float64}}"><code>NamedTrajectories.MethodsNamedTrajectory.add_component!</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.components-Tuple{NamedTrajectory}"><code>NamedTrajectories.MethodsNamedTrajectory.components</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.remove_component-Tuple{NamedTrajectory, Symbol}"><code>NamedTrajectories.MethodsNamedTrajectory.remove_component</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.remove_components-Tuple{NamedTrajectory, Vector{Symbol}}"><code>NamedTrajectories.MethodsNamedTrajectory.remove_components</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.times-Tuple{NamedTrajectory}"><code>NamedTrajectories.MethodsNamedTrajectory.times</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.timesteps-Tuple{NamedTrajectory}"><code>NamedTrajectories.MethodsNamedTrajectory.timesteps</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.update!-Tuple{NamedTrajectory, Symbol, AbstractMatrix{Float64}}"><code>NamedTrajectories.MethodsNamedTrajectory.update!</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.update_bound!"><code>NamedTrajectories.MethodsNamedTrajectory.update_bound!</code></a></li><li><a href="lib/#Base.:==-Tuple{NamedTrajectory, NamedTrajectory}"><code>Base.:==</code></a></li><li><a href="lib/#Base.copy-Tuple{NamedTrajectory}"><code>Base.copy</code></a></li><li><a href="lib/#Base.getindex-Tuple{NamedTrajectory, AbstractVector{Int64}}"><code>Base.getindex</code></a></li><li><a href="lib/#Base.getindex-Tuple{NamedTrajectory, Symbol}"><code>Base.getindex</code></a></li><li><a href="lib/#Base.getindex-Tuple{NamedTrajectory, Int64}"><code>Base.getindex</code></a></li><li><a href="lib/#Base.getproperty-Tuple{NamedTrajectory, Symbol}"><code>Base.getproperty</code></a></li><li><a href="lib/#Base.isequal-Tuple{NamedTrajectory, NamedTrajectory}"><code>Base.isequal</code></a></li><li><a href="lib/#Base.lastindex-Tuple{NamedTrajectory}"><code>Base.lastindex</code></a></li><li><a href="lib/#Base.setproperty!-Tuple{NamedTrajectory, Symbol, Any}"><code>Base.setproperty!</code></a></li><li><a href="lib/#Base.size-Tuple{NamedTrajectory}"><code>Base.size</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quickstart/">Quickstart Guide »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 19 November 2023 05:01">Sunday 19 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+\end{align*}\]</p><p>The <code>NamedTrajectories</code> package provides a <code>NamedTrajectory</code> type which abstracts away the messy indexing and vectorization details required for interfacing with numerical solvers.  It also provides a variety of helpful methods for common tasks.  For example, you can access the data by name or index.  In the case of an index, a <code>KnotPoint</code> is returned which contains the data for that timestep.</p><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><ul><li>Abstract away messy indexing and vectorization details required for interfacing with numerical solvers.</li><li>Easily handle multiple trajectories with different names, e.g. various states and controls.</li><li>Simple plotting of trajectories.</li><li>Provide a variety of helpful methods for common tasks.</li></ul><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="lib/#NamedTrajectories.MethodsNamedTrajectory.add_component!-Tuple{NamedTrajectory, Symbol, AbstractVecOrMat{Float64}}"><code>NamedTrajectories.MethodsNamedTrajectory.add_component!</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.components-Tuple{NamedTrajectory}"><code>NamedTrajectories.MethodsNamedTrajectory.components</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.remove_component-Tuple{NamedTrajectory, Symbol}"><code>NamedTrajectories.MethodsNamedTrajectory.remove_component</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.remove_components-Tuple{NamedTrajectory, Vector{Symbol}}"><code>NamedTrajectories.MethodsNamedTrajectory.remove_components</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.times-Tuple{NamedTrajectory}"><code>NamedTrajectories.MethodsNamedTrajectory.times</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.timesteps-Tuple{NamedTrajectory}"><code>NamedTrajectories.MethodsNamedTrajectory.timesteps</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.update!-Tuple{NamedTrajectory, Symbol, AbstractMatrix{Float64}}"><code>NamedTrajectories.MethodsNamedTrajectory.update!</code></a></li><li><a href="lib/#NamedTrajectories.MethodsNamedTrajectory.update_bound!"><code>NamedTrajectories.MethodsNamedTrajectory.update_bound!</code></a></li><li><a href="lib/#Base.:==-Tuple{NamedTrajectory, NamedTrajectory}"><code>Base.:==</code></a></li><li><a href="lib/#Base.copy-Tuple{NamedTrajectory}"><code>Base.copy</code></a></li><li><a href="lib/#Base.getindex-Tuple{NamedTrajectory, Int64}"><code>Base.getindex</code></a></li><li><a href="lib/#Base.getindex-Tuple{NamedTrajectory, AbstractVector{Int64}}"><code>Base.getindex</code></a></li><li><a href="lib/#Base.getindex-Tuple{NamedTrajectory, Symbol}"><code>Base.getindex</code></a></li><li><a href="lib/#Base.getproperty-Tuple{NamedTrajectory, Symbol}"><code>Base.getproperty</code></a></li><li><a href="lib/#Base.isequal-Tuple{NamedTrajectory, NamedTrajectory}"><code>Base.isequal</code></a></li><li><a href="lib/#Base.lastindex-Tuple{NamedTrajectory}"><code>Base.lastindex</code></a></li><li><a href="lib/#Base.setproperty!-Tuple{NamedTrajectory, Symbol, Any}"><code>Base.setproperty!</code></a></li><li><a href="lib/#Base.size-Tuple{NamedTrajectory}"><code>Base.size</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quickstart/">Quickstart Guide »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 19 November 2023 05:05">Sunday 19 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/man/quickstart/index.html

@@ -16,7 +16,7 @@
 traj = NamedTrajectory(data; timestep=timestep, controls=control)
 
 # we can return the names of the stored variables
-traj.names</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">(:x, :u)</code></pre><p>Let&#39;s plot this trajectory</p><pre><code class="language-julia hljs">plot(traj)</code></pre><img src="cdb3a25c.png" alt="Example block output"/><h2 id="Creating-a-variable-timestep-NamedTrajectory"><a class="docs-heading-anchor" href="#Creating-a-variable-timestep-NamedTrajectory">Creating a variable-timestep <code>NamedTrajectory</code></a><a id="Creating-a-variable-timestep-NamedTrajectory-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-a-variable-timestep-NamedTrajectory" title="Permalink"></a></h2><p>Here we will create a <code>NamedTrajectory</code> with a variable timestep. This is done by passing a <code>Symbol</code>, corresponding to component of the data, as the <code>timestep</code> kwarg.</p><pre><code class="language-julia hljs"># define the number of timesteps
+traj.names</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">(:x, :u)</code></pre><p>Let&#39;s plot this trajectory</p><pre><code class="language-julia hljs">plot(traj)</code></pre><img src="64f079a0.png" alt="Example block output"/><h2 id="Creating-a-variable-timestep-NamedTrajectory"><a class="docs-heading-anchor" href="#Creating-a-variable-timestep-NamedTrajectory">Creating a variable-timestep <code>NamedTrajectory</code></a><a id="Creating-a-variable-timestep-NamedTrajectory-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-a-variable-timestep-NamedTrajectory" title="Permalink"></a></h2><p>Here we will create a <code>NamedTrajectory</code> with a variable timestep. This is done by passing a <code>Symbol</code>, corresponding to component of the data, as the <code>timestep</code> kwarg.</p><pre><code class="language-julia hljs"># define the number of timesteps
 T = 10
 
 # define the knot point data as a NamedTuple of matrices
@@ -82,4 +82,4 @@
 )
 
 # we can then show the bounds
-traj.goal</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">(x = [0.0, 0.0, 1.0],)</code></pre><h2 id="Retrieving-data"><a class="docs-heading-anchor" href="#Retrieving-data">Retrieving data</a><a id="Retrieving-data-1"></a><a class="docs-heading-anchor-permalink" href="#Retrieving-data" title="Permalink"></a></h2><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../manual/">Manual »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 19 November 2023 05:01">Sunday 19 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+traj.goal</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">(x = [0.0, 0.0, 1.0],)</code></pre><h2 id="Retrieving-data"><a class="docs-heading-anchor" href="#Retrieving-data">Retrieving data</a><a id="Retrieving-data-1"></a><a class="docs-heading-anchor-permalink" href="#Retrieving-data" title="Permalink"></a></h2><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../manual/">Manual »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 19 November 2023 05:05">Sunday 19 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>