Skip to content

Commit

Permalink
build based on ddd9e33
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 23, 2023
1 parent d7e549a commit 84d3402
Show file tree
Hide file tree
Showing 21 changed files with 1,165 additions and 3 deletions.
2 changes: 1 addition & 1 deletion stable
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.3.5
v0.3.6
2 changes: 1 addition & 1 deletion v0.3
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.3.5
v0.3.6
1 change: 1 addition & 0 deletions v0.3.6/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-23T16:25:11","documenter_version":"1.1.2"}}
5 changes: 5 additions & 0 deletions v0.3.6/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · DistributionFits.jl</title><meta name="title" content="API · DistributionFits.jl"/><meta property="og:title" content="API · DistributionFits.jl"/><meta property="twitter:title" content="API · DistributionFits.jl"/><meta name="description" content="Documentation for DistributionFits.jl."/><meta property="og:description" content="Documentation for DistributionFits.jl."/><meta property="twitter:description" content="Documentation for DistributionFits.jl."/><meta property="og:url" content="https://bgctw.github.io/DistributionFits.jl/api/"/><meta property="twitter:url" content="https://bgctw.github.io/DistributionFits.jl/api/"/><link rel="canonical" href="https://bgctw.github.io/DistributionFits.jl/api/"/><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="../">DistributionFits.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><a class="tocitem" href="../partype/">Parameter type</a></li><li><span class="tocitem">Distributions</span><ul><li><a class="tocitem" href="../lognormal/">LogNormal</a></li><li><a class="tocitem" href="../logitnormal/">LogitNormal</a></li><li><a class="tocitem" href="../weibull/">Weibull</a></li><li><a class="tocitem" href="../gamma/">Gamma</a></li></ul></li><li><a class="tocitem" href="../set_optimize/">Dependencies</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#AbstractMoments"><span>AbstractMoments</span></a></li><li><a class="tocitem" href="#QuantilePoint"><span>QuantilePoint</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-navbar-link" href="https://github.com/bgctw/DistributionFits.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/DistributionFits.jl/blob/main/docs/src/api.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="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="AbstractMoments"><a class="docs-heading-anchor" href="#AbstractMoments">AbstractMoments</a><a id="AbstractMoments-1"></a><a class="docs-heading-anchor-permalink" href="#AbstractMoments" title="Permalink"></a></h2><p>The concept of first and higher order moments is captured by its own type. This allows dispatching the fit method.</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="DistributionFits.AbstractMoments" href="#DistributionFits.AbstractMoments"><code>DistributionFits.AbstractMoments</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">AbstractMoments{N}</code></pre><p>A representation of statistical moments of a distribution</p><p>The following functions are supported</p><ul><li><code>n_moments(m)</code>: get the number of recorded moments</li></ul><p>The following getters return a single moment or throw an error if the moment has not been recorded (<code>&gt;N</code>)</p><ul><li><code>mean(m)</code>: get the first momemnt, i.e. the mean</li><li><code>var(m)</code>: get the second moment, i.e. the variance</li><li><code>skewness(m)</code>: get the third moment, i.e. the skewness</li><li><code>kurtosis(m)</code>: get the fourth moment, i.e. the kurtosis</li><li><code>getindex(m,i)</code>: get the ith moment, i.e. indexing m[i]</li></ul><p>The basic implementation <code>Moments</code> is immutable and <code>convert(AbstractArray, m::Moments)</code> returns an <code>SArray{N,T}</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">m = Moments(1,0.2);
n_moments(m) == 2
var(m) == m[2]</code></pre><pre><code class="language-julia hljs">kurtosis(m) # throws error because its above 2nd moment</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bgctw/DistributionFits.jl/blob/ddd9e33db2bf72092dc263cb357a45fd08830bc4/src/fitstats.jl#L1-L31">source</a></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="DistributionFits.moments" href="#DistributionFits.moments"><code>DistributionFits.moments</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">moments(D, ::Val{N} = Val(2))</code></pre><p>Get the first N moments of a distribution.</p><p>Procudes an object of type <a href="#DistributionFits.AbstractMoments"><code>AbstractMoments</code></a>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">moments(LogNormal(), Val(4)) # first four moments
moments(Normal()) # mean and variance</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bgctw/DistributionFits.jl/blob/ddd9e33db2bf72092dc263cb357a45fd08830bc4/src/fitstats.jl#L57-L69">source</a></section></article><h2 id="QuantilePoint"><a class="docs-heading-anchor" href="#QuantilePoint">QuantilePoint</a><a id="QuantilePoint-1"></a><a class="docs-heading-anchor-permalink" href="#QuantilePoint" title="Permalink"></a></h2><p>The concept of a pair (p,q), i.e. a probability in [0,1] and associated quantile is captured by its own type. This allows dispatching the fit method.</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="DistributionFits.QuantilePoint" href="#DistributionFits.QuantilePoint"><code>DistributionFits.QuantilePoint</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">QuantilePoint</code></pre><p>A representation of a pair (p,q), i.e. (percentile,quantile).</p><p><strong>Notes</strong></p><p>Several macros help to construct QuantilePoints</p><ul><li><code>@qp(q,p)</code> quantile at specified p: <code>QuantilePoint(q,p)</code></li></ul><p>For Float64-based percentiles there are shortcuts</p><ul><li><code>@qp_ll(q0_025)</code> quantile at very low p: <code>QuantilePoint(q0_025,0.025)</code> </li><li><code>@qp_l(q0_05)</code> quantile at low p: <code>QuantilePoint(q0_05,0.05)</code> </li><li><code>@qp_m(median)</code> quantile at median: <code>QuantilePoint(median,0.5)</code> </li><li><code>@qp_u(q0_95)</code> quantile at high p: <code>QuantilePoint(q0_95,0.95)</code> </li><li><code>@qp_uu(q0_975)</code> quantile at very high p: <code>QuantilePoint(q0_975,0.975)</code> </li></ul><p>For constructing QuantilePoints with type of percentiles other than <code>Float64</code>, use the corresponding functions, that create a percentiles of the type of given quantile. E.g. for a <code>Float32</code>-based QuantilePoint at very low percentile</p><ul><li><code>qp_ll(0.2f0)</code> constructs a <code>QuantilePoint(0.2f0,0.025f0)</code> </li></ul><p>There are macros/functions for some commonly used sets of QuantilePoints: 90% and 95% confidence intervals:</p><ul><li><code>@qs_cf90(q0_05,q0_95)</code> </li><li><code>@qs_cf95(q0_025,q0_975)</code> -&gt; <code>Set([QuantilePoint(q0_025,0.025),QuantilePoint(q0_975,0.975)]))</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bgctw/DistributionFits.jl/blob/ddd9e33db2bf72092dc263cb357a45fd08830bc4/src/fitstats.jl#L120-L145">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../set_optimize/">« Dependencies</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="Monday 23 October 2023 16:25">Monday 23 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 84d3402

Please sign in to comment.