build based on 2d8784c

dev/examples/index.html

@@ -74,4 +74,4 @@
 output = [std(window_value(update_state!(state, _wrap(v)))) for v in values]
 
 plot(values; alpha=0.4, label="Input")
-plot!(output; label=&quot;std (window=100)&quot;)</code></pre><p><img src="../std-plot.svg" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/base/">General window »</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="Tuesday 1 August 2023 02:37">Tuesday 1 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+plot!(output; label=&quot;std (window=100)&quot;)</code></pre><p><img src="../std-plot.svg" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/base/">General window »</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="Wednesday 2 August 2023 02:28">Wednesday 2 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -7,4 +7,4 @@
     a + b + c,
     a + b + c - a + d,
     a + b + c - a + d - b + e
-]</code></pre><p>This can be problematic due to overflow / underflow for most numerical types, and accumulated rounding errors in floating point types (for an extreme example, suppose <code>a</code> is <code>Inf</code>). The simple approach also does not generalise to operators like the set <code>union</code>, since there is no inverse.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/">Examples »</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="Tuesday 1 August 2023 02:37">Tuesday 1 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+]</code></pre><p>This can be problematic due to overflow / underflow for most numerical types, and accumulated rounding errors in floating point types (for an extreme example, suppose <code>a</code> is <code>Inf</code>). The simple approach also does not generalise to operators like the set <code>union</code>, since there is no inverse.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/">Examples »</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="Wednesday 2 August 2023 02:28">Wednesday 2 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/reference/fixed/index.html

@@ -1,3 +1,3 @@
 <!DOCTYPE html>
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Fixed window · AssociativeWindowAggregation.jl</title><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.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="../../">AssociativeWindowAggregation.jl</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="../../examples/">Examples</a></li><li><span class="tocitem">Reference</span><ul><li><a class="tocitem" href="../base/">General window</a></li><li class="is-active"><a class="tocitem" href>Fixed window</a></li><li><a class="tocitem" href="../time/">Time window</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Reference</a></li><li class="is-active"><a href>Fixed window</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Fixed window</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/tpgillam/AssociativeWindowAggregation.jl/blob/main/docs/src/reference/fixed.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="Fixed-window"><a class="docs-heading-anchor" href="#Fixed-window">Fixed window</a><a id="Fixed-window-1"></a><a class="docs-heading-anchor-permalink" href="#Fixed-window" title="Permalink"></a></h1><p>A state to represent a window with a fixed capacity. It will start off empty, can have values pushed into it, and can be tested to see if it is &quot;full&quot;.</p><article class="docstring"><header><a class="docstring-binding" id="AssociativeWindowAggregation.FixedWindowAssociativeOp" href="#AssociativeWindowAggregation.FixedWindowAssociativeOp"><code>AssociativeWindowAggregation.FixedWindowAssociativeOp</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">FixedWindowAssociativeOp{T,Op,Op!}(window)
-FixedWindowAssociativeOp{T,Op}(window)</code></pre><p>State necessary for accumulation over a rolling window of fixed size.</p><p><strong>Fields</strong></p><ul><li><code>window_state::WindowedAssociativeOp{T,Op}</code>: The underlying general-window state.</li><li><code>remaining_window::Int</code>: How much of the window remains to be filled. Initially this will   be set to the window size, and will then reduce for every value added until it reaches   zero.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tpgillam/AssociativeWindowAggregation.jl/blob/2d8784cbd2bad1bc21df7c088941fe9ee0a4ba5c/src/fixed.jl#L3-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AssociativeWindowAggregation.update_state!-Tuple{FixedWindowAssociativeOp, Any}" href="#AssociativeWindowAggregation.update_state!-Tuple{FixedWindowAssociativeOp, Any}"><code>AssociativeWindowAggregation.update_state!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">update_state!(state::FixedWindowAssociativeOp, value) -&gt; state</code></pre><p>Add the specified <code>value</code> to the <code>state</code>. Drop a value from the window iff the window is full.</p><p><strong>Returns</strong></p><ul><li><code>::FixedWindowAssociativeOp</code>: The instance <code>state</code> that was passed in.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tpgillam/AssociativeWindowAggregation.jl/blob/2d8784cbd2bad1bc21df7c088941fe9ee0a4ba5c/src/fixed.jl#L32-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AssociativeWindowAggregation.window_full-Tuple{FixedWindowAssociativeOp}" href="#AssociativeWindowAggregation.window_full-Tuple{FixedWindowAssociativeOp}"><code>AssociativeWindowAggregation.window_full</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">window_full(state::FixedWindowAssociativeOp)::Bool</code></pre><p>Returns true iff the given <code>state</code> has a full window.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tpgillam/AssociativeWindowAggregation.jl/blob/2d8784cbd2bad1bc21df7c088941fe9ee0a4ba5c/src/fixed.jl#L59-L63">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../base/">« General window</a><a class="docs-footer-nextpage" href="../time/">Time window »</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="Tuesday 1 August 2023 02:37">Tuesday 1 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+FixedWindowAssociativeOp{T,Op}(window)</code></pre><p>State necessary for accumulation over a rolling window of fixed size.</p><p><strong>Fields</strong></p><ul><li><code>window_state::WindowedAssociativeOp{T,Op}</code>: The underlying general-window state.</li><li><code>remaining_window::Int</code>: How much of the window remains to be filled. Initially this will   be set to the window size, and will then reduce for every value added until it reaches   zero.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tpgillam/AssociativeWindowAggregation.jl/blob/2d8784cbd2bad1bc21df7c088941fe9ee0a4ba5c/src/fixed.jl#L3-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AssociativeWindowAggregation.update_state!-Tuple{FixedWindowAssociativeOp, Any}" href="#AssociativeWindowAggregation.update_state!-Tuple{FixedWindowAssociativeOp, Any}"><code>AssociativeWindowAggregation.update_state!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">update_state!(state::FixedWindowAssociativeOp, value) -&gt; state</code></pre><p>Add the specified <code>value</code> to the <code>state</code>. Drop a value from the window iff the window is full.</p><p><strong>Returns</strong></p><ul><li><code>::FixedWindowAssociativeOp</code>: The instance <code>state</code> that was passed in.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tpgillam/AssociativeWindowAggregation.jl/blob/2d8784cbd2bad1bc21df7c088941fe9ee0a4ba5c/src/fixed.jl#L32-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AssociativeWindowAggregation.window_full-Tuple{FixedWindowAssociativeOp}" href="#AssociativeWindowAggregation.window_full-Tuple{FixedWindowAssociativeOp}"><code>AssociativeWindowAggregation.window_full</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">window_full(state::FixedWindowAssociativeOp)::Bool</code></pre><p>Returns true iff the given <code>state</code> has a full window.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tpgillam/AssociativeWindowAggregation.jl/blob/2d8784cbd2bad1bc21df7c088941fe9ee0a4ba5c/src/fixed.jl#L59-L63">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../base/">« General window</a><a class="docs-footer-nextpage" href="../time/">Time window »</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="Wednesday 2 August 2023 02:28">Wednesday 2 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>