Skip to content

Commit

Permalink
build based on f0690da
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 1, 2024
1 parent 8fc35b2 commit ee4322b
Show file tree
Hide file tree
Showing 18 changed files with 206 additions and 206 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.4","generation_timestamp":"2024-07-06T04:52:13","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-01T09:40:03","documenter_version":"1.5.0"}}
2 changes: 1 addition & 1 deletion dev/cairomakie/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/concrete_parupdater/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Type inference · MTKHelpers.jl</title><meta name="title" content="Type inference · MTKHelpers.jl"/><meta property="og:title" content="Type inference · MTKHelpers.jl"/><meta property="twitter:title" content="Type inference · MTKHelpers.jl"/><meta name="description" content="Documentation for MTKHelpers.jl."/><meta property="og:description" content="Documentation for MTKHelpers.jl."/><meta property="twitter:description" content="Documentation for MTKHelpers.jl."/><meta property="og:url" content="https://bgctw.github.io/MTKHelpers.jl/concrete_parupdater/"/><meta property="twitter:url" content="https://bgctw.github.io/MTKHelpers.jl/concrete_parupdater/"/><link rel="canonical" href="https://bgctw.github.io/MTKHelpers.jl/concrete_parupdater/"/><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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">MTKHelpers.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">Update parameters</span><ul><li><a class="tocitem" href="../updating_problems/">Updating problems</a></li><li><a class="tocitem" href="../problemupdater/">ProblemUpdater</a></li><li><a class="tocitem" href="../odeproblemparsetter/">ODEProblem</a></li><li class="is-active"><a class="tocitem" href>Type inference</a><ul class="internal"><li><a class="tocitem" href="#Example"><span>Example</span></a></li></ul></li><li><a class="tocitem" href="../pde/">PDE support</a></li></ul></li><li><a class="tocitem" href="../system_num_dict/">Translating symbols and Nums</a></li><li><a class="tocitem" href="../embed_system/">Embedding a system</a></li><li><a class="tocitem" href="../solution/">Solution handling</a></li><li><a class="tocitem" href="../smoothstep/">Smooth steps</a></li><li><a class="tocitem" href="../cairomakie/">CairoMakie Helpers</a></li><li><span class="tocitem">Developer notes</span><ul><li><a class="tocitem" href="../pde_dev/">PDE support</a></li></ul></li><li><a class="tocitem" href="../zindex/">index</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><a class="is-disabled">Update parameters</a></li><li class="is-active"><a href>Type inference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Type inference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/bgctw/MTKHelpers.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/bgctw/MTKHelpers.jl/blob/main/docs/src/concrete_parupdater.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="Concrete-ProblemUpdater"><a class="docs-heading-anchor" href="#Concrete-ProblemUpdater">Concrete ProblemUpdater</a><a id="Concrete-ProblemUpdater-1"></a><a class="docs-heading-anchor-permalink" href="#Concrete-ProblemUpdater" title="Permalink"></a></h1><p>The default-implementations of <code>ODEParSetter</code> and <code>ParUpdater</code> do not store much information in type parameters to avoid long compilation times.</p><p>The disadvantage is, that the result of some operations is not fully type- inferred, especially when dealing with ComponentArrays that store information in their type signature. The results of the folloginw calls are not inferred (<code>x</code> is stands in for either <code>state</code>, <code>par</code>, or <code>paropt</code>):</p><ul><li><code>axis_x(pset)</code></li><li><code>label_x(pset, ...)</code> </li><li><code>get_paropt(pset, ...)</code>, and <code>get_paropt_labeled(pset, ...)</code></li><li><code>update_statepar</code> and <code>remake</code></li><li><code>count_x(pset)</code> is inferred but no known at compile time and can not be used to create StaticArrays</li></ul><p>Therefore, this package provides function <code>get_concrete</code>, that provides a concrete-typed version of a type.</p><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="MTKHelpers.get_concrete" href="#MTKHelpers.get_concrete"><code>MTKHelpers.get_concrete</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_concrete(pset::AbstractProblemParSetter)
get_concrete(pu::AbstractParameterUpdater)</code></pre><p>Return a concrete-type-version of an ProblemParSetter or ProblemUpdater.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bgctw/MTKHelpers.jl/blob/29943833cdf11200ede242982db0dbb9f216e252/src/abstractproblemparsetter.jl#L174-L179">source</a></section></article><h2 id="Example"><a class="docs-heading-anchor" href="#Example">Example</a><a id="Example-1"></a><a class="docs-heading-anchor-permalink" href="#Example" title="Permalink"></a></h2><p>The following example demonstrates, how to construct a cost function that is based on a closure in which the types are inferred.</p><p>First, lets setup a small example problem</p><pre><code class="language-julia hljs">using OrdinaryDiffEq, ComponentArrays, MTKHelpers, Test, ModelingToolkit
get_concrete(pu::AbstractParameterUpdater)</code></pre><p>Return a concrete-type-version of an ProblemParSetter or ProblemUpdater.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bgctw/MTKHelpers.jl/blob/f0690da0702a5ff97769468a851c8f88fef4eecc/src/abstractproblemparsetter.jl#L174-L179">source</a></section></article><h2 id="Example"><a class="docs-heading-anchor" href="#Example">Example</a><a id="Example-1"></a><a class="docs-heading-anchor-permalink" href="#Example" title="Permalink"></a></h2><p>The following example demonstrates, how to construct a cost function that is based on a closure in which the types are inferred.</p><p>First, lets setup a small example problem</p><pre><code class="language-julia hljs">using OrdinaryDiffEq, ComponentArrays, MTKHelpers, Test, ModelingToolkit
using ModelingToolkit: t_nounits as t, D_nounits as D

function get_sys1()
Expand Down Expand Up @@ -29,4 +29,4 @@
end # let, get_fopt
fopt = get_fopt()
#prob4 = @inferred fopt(prob) # TODO inferred
prob4 = fopt(prob)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../odeproblemparsetter/">« ODEProblem</a><a class="docs-footer-nextpage" href="../pde/">PDE support »</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 6 July 2024 04:52">Saturday 6 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
prob4 = fopt(prob)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../odeproblemparsetter/">« ODEProblem</a><a class="docs-footer-nextpage" href="../pde/">PDE support »</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="Thursday 1 August 2024 09:40">Thursday 1 August 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 ee4322b

Please sign in to comment.