build based on 8e91000

mathopt · Nov 30, 2023 · 42aa4c7 · 42aa4c7
1 parent 8455baf
commit 42aa4c7
Show file tree

Hide file tree

Showing 16 changed files with 1,355 additions and 0 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -0,0 +1 @@
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-30T13:43:36","documenter_version":"1.2.0"}}
diff --git a/dev/api/index.html b/dev/api/index.html
@@ -0,0 +1,4 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · DynamicOED.jl</title><meta name="title" content="API · DynamicOED.jl"/><meta property="og:title" content="API · DynamicOED.jl"/><meta property="twitter:title" content="API · DynamicOED.jl"/><meta name="description" content="Documentation for DynamicOED.jl."/><meta property="og:description" content="Documentation for DynamicOED.jl."/><meta property="twitter:description" content="Documentation for DynamicOED.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/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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">DynamicOED.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="../">Home</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../examples/1D/">Linear System</a></li><li><a class="tocitem" href="../examples/lotka/">Lotka-Volterra</a></li></ul></li><li><a class="tocitem" href="../theory/">Theory</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Criteria"><span>Criteria</span></a></li><li><a class="tocitem" href="#Problem"><span>Problem</span></a></li><li><a class="tocitem" href="#Symbolic-Differentiation-Backends"><span>Symbolic Differentiation Backends</span></a></li><li><a class="tocitem" href="#ModelingToolkit-Extensions"><span>ModelingToolkit Extensions</span></a></li></ul></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</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><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="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h2 id="Criteria"><a class="docs-heading-anchor" href="#Criteria">Criteria</a><a id="Criteria-1"></a><a class="docs-heading-anchor-permalink" href="#Criteria" 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="DynamicOED.ACriterion" href="#DynamicOED.ACriterion"><code>DynamicOED.ACriterion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct ACriterion &lt;: DynamicOED.AbstractInformationCriterion</code></pre><p>The A-Criterion for experimental design.</p><pre><code class="language-julia hljs">tr(inv(F))</code></pre></div></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="DynamicOED.DCriterion" href="#DynamicOED.DCriterion"><code>DynamicOED.DCriterion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct DCriterion &lt;: DynamicOED.AbstractInformationCriterion</code></pre><p>The D-Criterion for experimental design.</p><pre><code class="language-julia hljs">det(inv(F))</code></pre></div></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="DynamicOED.ECriterion" href="#DynamicOED.ECriterion"><code>DynamicOED.ECriterion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct ECriterion &lt;: DynamicOED.AbstractInformationCriterion</code></pre><p>The E-Criterion for experimental design.</p><pre><code class="language-julia hljs">max(eigvals(F))</code></pre></div></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="DynamicOED.FisherACriterion" href="#DynamicOED.FisherACriterion"><code>DynamicOED.FisherACriterion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct FisherACriterion &lt;: DynamicOED.AbstractInformationCriterion</code></pre><p>The Fisher A-Criterion for experimental design.</p><pre><code class="language-julia hljs">-tr(F)</code></pre></div></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="DynamicOED.FisherDCriterion" href="#DynamicOED.FisherDCriterion"><code>DynamicOED.FisherDCriterion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct FisherDCriterion &lt;: DynamicOED.AbstractInformationCriterion</code></pre><p>The Fisher D-Criterion for experimental design.</p><pre><code class="language-julia hljs">-det(F)</code></pre></div></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="DynamicOED.FisherECriterion" href="#DynamicOED.FisherECriterion"><code>DynamicOED.FisherECriterion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct FisherECriterion &lt;: DynamicOED.AbstractInformationCriterion</code></pre><p>The Fisher E-Criterion for experimental design.</p><pre><code class="language-julia hljs">-min(eigvals(F))</code></pre></div></section></article><h2 id="Problem"><a class="docs-heading-anchor" href="#Problem">Problem</a><a id="Problem-1"></a><a class="docs-heading-anchor-permalink" href="#Problem" 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="DynamicOED.OEDProblem" href="#DynamicOED.OEDProblem"><code>DynamicOED.OEDProblem</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct OEDProblem{S, O, T, A, DO}</code></pre><p>The basic definition of an optimal experimental design problem.</p><p><strong>Fields</strong></p><ul><li><p><code>system</code>: The optimal experimental design system in form of an ODESystem</p></li><li><p><code>objective</code>: The objective criterion</p></li><li><p><code>timegrid</code>: The time grid</p></li><li><p><code>alg</code>: Solver for the differential equations</p></li><li><p><code>diffeq_options</code>: Differential equations options</p></li></ul></div></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="DynamicOED.Timegrid" href="#DynamicOED.Timegrid"><code>DynamicOED.Timegrid</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Timegrid{V, I, G, T}</code></pre><p>A structure for holding a multi-variable time grid. </p><p><strong>Fields</strong></p><ul><li><p><code>variables</code>: The variables</p></li><li><p><code>indicators</code>: The indicator for switching variables</p></li><li><p><code>timegrids</code>: The individual time grids</p></li><li><p><code>timespans</code>: The overall time grid</p></li></ul></div></section></article><h2 id="Symbolic-Differentiation-Backends"><a class="docs-heading-anchor" href="#Symbolic-Differentiation-Backends">Symbolic Differentiation Backends</a><a id="Symbolic-Differentiation-Backends-1"></a><a class="docs-heading-anchor-permalink" href="#Symbolic-Differentiation-Backends" 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="DynamicOED.MTKBackend" href="#DynamicOED.MTKBackend"><code>DynamicOED.MTKBackend</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct MTKBackend &lt;: DynamicOED.AbstractAugmentationBackened</code></pre><p>Uses <code>ModelingToolkit</code> as a backened to augment the system.</p></div></section></article><h2 id="ModelingToolkit-Extensions"><a class="docs-heading-anchor" href="#ModelingToolkit-Extensions">ModelingToolkit Extensions</a><a id="ModelingToolkit-Extensions-1"></a><a class="docs-heading-anchor-permalink" href="#ModelingToolkit-Extensions" 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="DynamicOED.VariableRate" href="#DynamicOED.VariableRate"><code>DynamicOED.VariableRate</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct VariableRate</code></pre><p>Indicator that a given state is subject to a fixed rate. Is used for modeling the rate of observation of observed variables and the rate of control for control variables. If the provided rate is a <code>Real</code>, it is assumed that the resulting time grid is given in fractions of the time unit.  If the provided rate is a <code>Int</code>, it is assumed that the resulting time grid is divided in <code>rate</code> equidistant intervals. </p><pre><code class="nohighlight hljs">@variables y(t) [measurement_rate=0.1] # Create a variable measured every 0.1 t
+@variables y(t) [measurement_rate=0.1] # Create a variable measured every 0.1 t
+@parameters c [input=true, measurement_rate=2] # Create a control variable which acts 2 times over the course of the simulation</code></pre></div></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="DynamicOED.FisherState" href="#DynamicOED.FisherState"><code>DynamicOED.FisherState</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct FisherState</code></pre><p>Indicator that a given variable is a state of the fisher information matrix. </p><pre><code class="nohighlight hljs">@variables F[1:3, 1:3] [fisher_state=true]</code></pre></div></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="DynamicOED.MeasurementFunction" href="#DynamicOED.MeasurementFunction"><code>DynamicOED.MeasurementFunction</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct MeasurementFunction</code></pre><p>Indicator that a given variable is a measurement function. </p><pre><code class="nohighlight hljs">@variables w=1.0 [measurement_function=true]</code></pre></div></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="DynamicOED.VariableIC" href="#DynamicOED.VariableIC"><code>DynamicOED.VariableIC</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct VariableIC</code></pre><p>Indicator that a given state variable&#39;s initial condition is unknown.</p><pre><code class="nohighlight hljs">@variables x(t)=1.0 [variable_ic=true]</code></pre></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../theory/">« Theory</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.2.0 on <span class="colophon-date" title="Thursday 30 November 2023 13:43">Thursday 30 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-30T13:43:36","documenter_version":"1.2.0"}}