Skip to content

Commit a62ea8c

Browse files
author
Documenter.jl
committed
build based on da3cf39
0 parents  commit a62ea8c

40 files changed

+17658
-0
lines changed

dev/LICENSE/index.html

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>LICENSE · BATTestCases</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://bat.github.io/BATTestCases.jl/stable/LICENSE/"/><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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" 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="../">BATTestCases</a></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="../api/">API</a></li><li class="is-active"><a class="tocitem" href>LICENSE</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>LICENSE</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>LICENSE</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/bat/BATTestCases.jl/blob/main/docs/src/LICENSE.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="LICENSE"><a class="docs-heading-anchor" href="#LICENSE">LICENSE</a><a id="LICENSE-1"></a><a class="docs-heading-anchor-permalink" href="#LICENSE" title="Permalink"></a></h1><p>The BATTestCases.jl package is licensed under the MIT &quot;Expat&quot; License:</p><blockquote><p>Copyright (c) 2020:</p><p>Oliver Schulz &lt;[email protected]&gt; and contributors</p><p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p><p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p><p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p></blockquote></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 5 February 2024 19:28">Monday 5 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/api/index.html

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · BATTestCases</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://bat.github.io/BATTestCases.jl/stable/api/"/><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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" 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="../">BATTestCases</a></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 class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Modules"><span>Modules</span></a></li><li><a class="tocitem" href="#Types-and-constants"><span>Types and constants</span></a></li><li><a class="tocitem" href="#Functions-and-macros"><span>Functions and macros</span></a></li><li class="toplevel"><a class="tocitem" href="#Documentation"><span>Documentation</span></a></li></ul></li><li><a class="tocitem" href="../LICENSE/">LICENSE</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>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-edit-link" href="https://github.com/bat/BATTestCases.jl/blob/main/docs/src/api.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="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="Modules"><a class="docs-heading-anchor" href="#Modules">Modules</a><a id="Modules-1"></a><a class="docs-heading-anchor-permalink" href="#Modules" title="Permalink"></a></h2><ul><li><a href="#BATTestCases.BATTestCases"><code>BATTestCases.BATTestCases</code></a></li></ul><h2 id="Types-and-constants"><a class="docs-heading-anchor" href="#Types-and-constants">Types and constants</a><a id="Types-and-constants-1"></a><a class="docs-heading-anchor-permalink" href="#Types-and-constants" title="Permalink"></a></h2><ul><li><a href="#BATTestCases.FunnelDistribution"><code>BATTestCases.FunnelDistribution</code></a></li><li><a href="#BATTestCases.GaussianShell"><code>BATTestCases.GaussianShell</code></a></li><li><a href="#BATTestCases.MultimodalStudentT"><code>BATTestCases.MultimodalStudentT</code></a></li></ul><h2 id="Functions-and-macros"><a class="docs-heading-anchor" href="#Functions-and-macros">Functions and macros</a><a id="Functions-and-macros-1"></a><a class="docs-heading-anchor-permalink" href="#Functions-and-macros" title="Permalink"></a></h2><ul></ul><h1 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></h1><article class="docstring"><header><a class="docstring-binding" id="BATTestCases.BATTestCases" href="#BATTestCases.BATTestCases"><code>BATTestCases.BATTestCases</code></a> — <span class="docstring-category">Module</span></header><section><div><pre><code class="language-julia hljs">BATTestCases</code></pre><p>A collection of test cases for BAT.jl.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bat/BATTestCases.jl/blob/da3cf3929bf0c86bfd5006e60c7bfa69e181b971/src/BATTestCases.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="BATTestCases.FunnelDistribution" href="#BATTestCases.FunnelDistribution"><code>BATTestCases.FunnelDistribution</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct FunnelDistribution &lt;: Distribution{Multivariate,Continuous}</code></pre><p><em>Experimental feature, not part of stable public API.</em></p><p>A funnel distribution (see <a href="https://arxiv.org/abs/1808.08051">Caldwell et al.</a> for definition).</p><p>Constructors:</p><ul><li><code>FunnelDistribution(; a::Real = 1.0, b::Real = 0.5, n::Integer = 3)</code></li></ul><p>Fields:</p><ul><li><p><code>a::Real</code>: Variance of the dominant normal distribution.</p></li><li><p><code>b::Real</code>: Variance of the supporting normal distributions.</p></li><li><p><code>n::Integer</code>: Number of dimensions.</p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bat/BATTestCases.jl/blob/da3cf3929bf0c86bfd5006e60c7bfa69e181b971/src/funnel.jl#L4-L19">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="BATTestCases.GaussianShell" href="#BATTestCases.GaussianShell"><code>BATTestCases.GaussianShell</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct GaussianShell &lt;: Distribution{Multivariate,Continuous}</code></pre><p><em>Experimental feature, not part of stable public API.</em></p><p>Gaussian Shell (see <a href="https://arxiv.org/abs/1808.08051">Caldwell et al.</a> for definition).</p><p>Constructors:</p><ul><li><code>GaussianShell(; r::Real=5, w::Real=2, n::Integer=2)</code></li></ul><p>Fields:</p><ul><li><p><code>r::Real</code>: The radius of the Gaussian shell distribution.</p></li><li><p><code>w::Real</code>: Variance of the Gaussian shell distribution</p></li><li><p><code>n::Int64</code>: Number of dimensions</p></li><li><p><code>c::AbstractVector{&lt;:Real}</code></p></li><li><p><code>lognorm::AbstractFloat</code></p></li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Fields <code>c</code> and <code>lognorm</code> are considered internal and subject to change without deprecation.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bat/BATTestCases.jl/blob/da3cf3929bf0c86bfd5006e60c7bfa69e181b971/src/gaussian_shell.jl#L4-L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="BATTestCases.MultimodalStudentT" href="#BATTestCases.MultimodalStudentT"><code>BATTestCases.MultimodalStudentT</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">MultimodalStudentT &lt;: Distribution{Multivariate,Continuous}</code></pre><p>The Multimodal Student-t Distribution (It&#39;s defined similarly to multimodal Cauchy defined in <a href="https://arxiv.org/abs/1808.08051">Caldwell et al.</a>).</p><p>Assumes two bimodal peaks, each in its own dimension.</p><p>Constructors:</p><ul><li><code>MultimodalStudentT(; μ::Real=1, σ::Float64=0.2, ν::Integer=1, n::Integer=4)</code></li></ul><p>Arguments:</p><ul><li><code>μ::Real</code>: The location parameter used for the two bimodal peaks.</li><li><code>σ::Float64</code>: The scale parameter shared among all components.</li><li><code>ν::Int</code>: The degrees of freedom.</li><li><code>n::Int</code>: The number of dimensions.</li></ul><p>Fields:</p><ul><li><p><code>bimodals::Distributions.MixtureModel</code></p></li><li><p><code>σ::Float64</code></p></li><li><p><code>n::Int64</code></p></li><li><p><code>dist::Distributions.Product</code></p></li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>All fields of <code>MultimodalStudentT</code> are considered internal and subject to change without deprecation.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bat/BATTestCases.jl/blob/da3cf3929bf0c86bfd5006e60c7bfa69e181b971/src/multimodal_student_t.jl#L3-L30">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../LICENSE/">LICENSE »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 5 February 2024 19:28">Monday 5 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)