build based on a43ad14

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.0-beta3","generation_timestamp":"2023-10-23T18:11:31","documenter_version":"1.1.2"}}
+{"documenter":{"julia_version":"1.10.0-beta3","generation_timestamp":"2023-10-23T22:18:33","documenter_version":"1.1.2"}}

dev/api/index.html

@@ -6,4 +6,4 @@
 foo (generic function with 1 method)
 
 julia> allocs = check_allocs(foo, (Int, Int))
-AllocCheck.AllocInstance[]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaComputing/AllocCheck.jl/blob/d2560c6b51ce0991cf0b6d3ab84e713385e03a65/src/AllocCheck.jl#L238-L256">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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 18:11">Monday 23 October 2023</span>. Using Julia version 1.10.0-beta3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+AllocCheck.AllocInstance[]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaComputing/AllocCheck.jl/blob/a43ad14da1a672a7c50d782b7b455347b2b45c09/src/AllocCheck.jl#L238-L256">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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 22:18">Monday 23 October 2023</span>. Using Julia version 1.10.0-beta3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -21,4 +21,4 @@
 <span class="sgr90">   @</span> <span class="sgr35">LinearAlgebra</span> <span class="sgr90">/opt/hostedtoolcache/julia/1.10.0-beta3/x64/share/julia/stdlib/v1.10/LinearAlgebra/src/<span class="sgr4">generic.jl:1118</span></span>
  [6] <span class="sgr1">linsolve(</span><span class="sgr90">a</span>::Matrix<span class="sgr90">{Float64}</span>, <span class="sgr90">b</span>::Vector<span class="sgr90">{Float64}</span><span class="sgr1">)</span>
 <span class="sgr90">   @</span> <span class="sgr36">Main</span> <span class="sgr90">./<span class="sgr4">index.md:21</span></span>
-</code></pre><p>we see what type of object was allocated, and where in the code the allocation appeared.</p><h3 id="Functions-that-throw-exceptions"><a class="docs-heading-anchor" href="#Functions-that-throw-exceptions">Functions that throw exceptions</a><a id="Functions-that-throw-exceptions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions-that-throw-exceptions" title="Permalink"></a></h3><p>Some functions that we do not expect may allocate memory, like <code>sin</code>, actually may:</p><pre><code class="language-julia hljs">length(check_allocs(sin, (Float64,)))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">3</code></pre><p>The reason for this is that <code>sin</code> may <strong>throw an error</strong>, and the exception object requires some allocations. We can ignore allocations that only happen when throwing errors by passing <code>ignore_throw=true</code>:</p><pre><code class="language-julia hljs">length(check_allocs(sin, (Float64,); ignore_throw=true)) # ignore allocations that only happen when throwing errors</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">0</code></pre><h2 id="Limitations"><a class="docs-heading-anchor" href="#Limitations">Limitations</a><a id="Limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Limitations" title="Permalink"></a></h2><ol><li>Runtime dispatch</li></ol><p>Any runtime dispatch is conservatively assumed to allocate.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" 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><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 18:11">Monday 23 October 2023</span>. Using Julia version 1.10.0-beta3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p>we see what type of object was allocated, and where in the code the allocation appeared.</p><h3 id="Functions-that-throw-exceptions"><a class="docs-heading-anchor" href="#Functions-that-throw-exceptions">Functions that throw exceptions</a><a id="Functions-that-throw-exceptions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions-that-throw-exceptions" title="Permalink"></a></h3><p>Some functions that we do not expect may allocate memory, like <code>sin</code>, actually may:</p><pre><code class="language-julia hljs">length(check_allocs(sin, (Float64,)))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">3</code></pre><p>The reason for this is that <code>sin</code> may <strong>throw an error</strong>, and the exception object requires some allocations. We can ignore allocations that only happen when throwing errors by passing <code>ignore_throw=true</code>:</p><pre><code class="language-julia hljs">length(check_allocs(sin, (Float64,); ignore_throw=true)) # ignore allocations that only happen when throwing errors</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">0</code></pre><h2 id="Limitations"><a class="docs-heading-anchor" href="#Limitations">Limitations</a><a id="Limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Limitations" title="Permalink"></a></h2><ol><li>Runtime dispatch</li></ol><p>Any runtime dispatch is conservatively assumed to allocate.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" 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><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 22:18">Monday 23 October 2023</span>. Using Julia version 1.10.0-beta3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>