-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
zeptodoctor
committed
Dec 20, 2024
1 parent
466a96c
commit 12d3ab8
Showing
35 changed files
with
86,901 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v1.3.0 | ||
| v1.3.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v1.3.0 | ||
| v1.3.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v1.3.0 | ||
| v1.3.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Advanced usage · MonteCarloMeasurements Documentation</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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="../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"/><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"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="MonteCarloMeasurements Documentation logo"/></a><div class="docs-package-name"><span class="docs-autofit">MonteCarloMeasurements Documentation</span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../overloading/">Supporting new functions</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../comparison/">Linear vs. Monte-Carlo uncertainty propagation</a></li><li><a class="tocitem" href="../performance/">Performance tips</a></li><li class="is-active"><a class="tocitem" href>Advanced usage</a></li><li><a class="tocitem" href="../api/">API</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Advanced usage</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Advanced usage</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/baggepinnen/MonteCarloMeasurements.jl/blob/master/docs/src/advanced_usage.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Advanced-usage-1"><a class="docs-heading-anchor" href="#Advanced-usage-1">Advanced usage</a><a class="docs-heading-anchor-permalink" href="#Advanced-usage-1" title="Permalink"></a></h1><p>Several non-exported functions that may facilitate working with structures that contain uncertain parameters (struct-of-arrays, SoA) exist. These are not to be considered part of the API and are subject to breakage at any time, but may nevertheless be of use in special situations.</p><article class="docstring"><header><a class="docstring-binding" id="MonteCarloMeasurements.mean_object" href="#MonteCarloMeasurements.mean_object"><code>MonteCarloMeasurements.mean_object</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">mean_object(x)</code></pre><p>Returns an object similar to <code>x</code>, but where all internal instances of <code>Particles</code> are replaced with their mean. The generalization of this function is <code>replace_particles</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/baggepinnen/MonteCarloMeasurements.jl/blob/44abdc4f2000ef36f33d48321f449594f82c01c4/src/deconstruct.jl#L89-L92">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MonteCarloMeasurements.replace_particles" href="#MonteCarloMeasurements.replace_particles"><code>MonteCarloMeasurements.replace_particles</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">replace_particles(x; condition=P->P isa AbstractParticles,replacer = P->vecindex(P, 1))</code></pre><p>This function recursively scans through the structure <code>x</code>, every time a field that matches <code>condition</code> is found, <code>replacer</code> is called on that field and the result is used instead of <code>P</code>. See function <code>mean_object</code>, which uses this function to replace all instances of <code>Particles</code> with their mean.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/baggepinnen/MonteCarloMeasurements.jl/blob/44abdc4f2000ef36f33d48321f449594f82c01c4/src/deconstruct.jl#L97-L101">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MonteCarloMeasurements.has_particles" href="#MonteCarloMeasurements.has_particles"><code>MonteCarloMeasurements.has_particles</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">has_particles(P)</code></pre><p>Determine whether or no the object <code>P</code> has some kind of particles inside it. This function examins fields of <code>P</code> recursively and looks inside arrays etc.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/baggepinnen/MonteCarloMeasurements.jl/blob/44abdc4f2000ef36f33d48321f449594f82c01c4/src/deconstruct.jl#L1-L4">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MonteCarloMeasurements.build_mutable_container" href="#MonteCarloMeasurements.build_mutable_container"><code>MonteCarloMeasurements.build_mutable_container</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">build_mutable_container(P)</code></pre><p>Recursively visits all fields of <code>P</code> and replaces all instances of <code>StaticParticles</code> with <code>Particles</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/baggepinnen/MonteCarloMeasurements.jl/blob/44abdc4f2000ef36f33d48321f449594f82c01c4/src/deconstruct.jl#L47-L50">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MonteCarloMeasurements.build_container" href="#MonteCarloMeasurements.build_container"><code>MonteCarloMeasurements.build_container</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">build_container(P)</code></pre><p>Recursively visits all fields of <code>P</code> and replaces all instances of <code>AbstractParticles{T,N}</code> with <code>::T</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/baggepinnen/MonteCarloMeasurements.jl/blob/44abdc4f2000ef36f33d48321f449594f82c01c4/src/deconstruct.jl#L83-L86">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MonteCarloMeasurements.array_of_structs" href="#MonteCarloMeasurements.array_of_structs"><code>MonteCarloMeasurements.array_of_structs</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">array_of_structs(f, arg)</code></pre><p>Exectues <code>f</code> on each instance of <code>arg</code> represented by internal particles of <code>arg</code>. This is useful as a last resort if all other methods to propagate particles through <code>f</code> fails. The function returns an array (length = num. particles) of structs rather than particles, each struct is the result of <code>f(replace_particles(arg, p->p[i]))</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/baggepinnen/MonteCarloMeasurements.jl/blob/44abdc4f2000ef36f33d48321f449594f82c01c4/src/deconstruct.jl#L374-L378">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../performance/">« Performance tips</a><a class="docs-footer-nextpage" href="../api/">API »</a></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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Friday 20 December 2024 07:14">Friday 20 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.