Skip to content

Commit

Permalink
build based on 045274a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 1, 2024
1 parent 05d3dd1 commit 5b2036c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-01T19:44:12","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-01T21:23:55","documenter_version":"1.3.0"}}
12 changes: 6 additions & 6 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
3×3 SparseArrays.SparseMatrixCSC{Bool, UInt64} with 4 stored entries:
1 ⋅ ⋅
1 1 ⋅
⋅ ⋅ 1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/35810e3d7df7af36ca0bdf78a35bc620de121121/src/connectivity.jl#L35-L53">source</a></section></article><h3 id="Internals"><a class="docs-heading-anchor" href="#Internals">Internals</a><a id="Internals-1"></a><a class="docs-heading-anchor-permalink" href="#Internals" title="Permalink"></a></h3><p>SparseConnectivityTracer works by pushing a <code>Number</code> type called <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a> through generic functions:</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="SparseConnectivityTracer.Tracer" href="#SparseConnectivityTracer.Tracer"><code>SparseConnectivityTracer.Tracer</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Tracer(indexset) &lt;: Number</code></pre><p>Number type keeping track of input indices of previous computations.</p><p>See also the convenience constructor <a href="#SparseConnectivityTracer.tracer"><code>tracer</code></a>. For a higher-level interface, refer to <a href="#SparseConnectivityTracer.connectivity"><code>connectivity</code></a>.</p><p><strong>Examples</strong></p><p>By enumerating inputs with tracers, we can keep track of input connectivities:</p><pre><code class="language-julia-repl hljs">julia&gt; xt = [tracer(1), tracer(2), tracer(3)]
⋅ ⋅ 1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/045274ab1665e32f97078c0c3498c1a248d71b68/src/connectivity.jl#L35-L53">source</a></section><section><div><pre><code class="language-julia hljs">connectivity(f!, y, x)</code></pre><p>Enumerates inputs <code>x</code> and primal outputs <code>y</code> after <code>f!(y, x)</code> and returns sparse connectivity matrix <code>C</code> of size <code>(m, n)</code> where <code>C[i, j]</code> is true if the compute graph connects the <code>i</code>-th entry in <code>y</code> to the <code>j</code>-th entry in <code>x</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/045274ab1665e32f97078c0c3498c1a248d71b68/src/connectivity.jl#L60-L65">source</a></section></article><h3 id="Internals"><a class="docs-heading-anchor" href="#Internals">Internals</a><a id="Internals-1"></a><a class="docs-heading-anchor-permalink" href="#Internals" title="Permalink"></a></h3><p>SparseConnectivityTracer works by pushing a <code>Number</code> type called <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a> through generic functions:</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="SparseConnectivityTracer.Tracer" href="#SparseConnectivityTracer.Tracer"><code>SparseConnectivityTracer.Tracer</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Tracer(indexset) &lt;: Number</code></pre><p>Number type keeping track of input indices of previous computations.</p><p>See also the convenience constructor <a href="#SparseConnectivityTracer.tracer"><code>tracer</code></a>. For a higher-level interface, refer to <a href="#SparseConnectivityTracer.connectivity"><code>connectivity</code></a>.</p><p><strong>Examples</strong></p><p>By enumerating inputs with tracers, we can keep track of input connectivities:</p><pre><code class="language-julia-repl hljs">julia&gt; xt = [tracer(1), tracer(2), tracer(3)]
3-element Vector{Tracer}:
Tracer(1,)
Tracer(2,)
Expand Down Expand Up @@ -57,8 +57,8 @@
3-element Vector{Tracer}:
Tracer(1, 2, 3, 5)
Tracer(1, 2, 3, 5)
Tracer(1, 2, 3, 5)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/35810e3d7df7af36ca0bdf78a35bc620de121121/src/tracer.jl#L1-L75">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="SparseConnectivityTracer.tracer" href="#SparseConnectivityTracer.tracer"><code>SparseConnectivityTracer.tracer</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tracer(index)
tracer(indices)</code></pre><p>Convenience constructor for <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a> from input indices.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/35810e3d7df7af36ca0bdf78a35bc620de121121/src/tracer.jl#L88-L93">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="SparseConnectivityTracer.trace_input" href="#SparseConnectivityTracer.trace_input"><code>SparseConnectivityTracer.trace_input</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">trace_input(x)</code></pre><p>Enumerates input indices and constructs <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a>s.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; x = rand(3);
Tracer(1, 2, 3, 5)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/045274ab1665e32f97078c0c3498c1a248d71b68/src/tracer.jl#L1-L75">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="SparseConnectivityTracer.tracer" href="#SparseConnectivityTracer.tracer"><code>SparseConnectivityTracer.tracer</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tracer(index)
tracer(indices)</code></pre><p>Convenience constructor for <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a> from input indices.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/045274ab1665e32f97078c0c3498c1a248d71b68/src/tracer.jl#L88-L93">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="SparseConnectivityTracer.trace_input" href="#SparseConnectivityTracer.trace_input"><code>SparseConnectivityTracer.trace_input</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">trace_input(x)</code></pre><p>Enumerates input indices and constructs <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a>s.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; x = rand(3);

julia&gt; f(x) = [x[1]^2, 2 * x[1] * x[2]^2, sin(x[3])];

Expand All @@ -72,14 +72,14 @@
3-element Vector{Tracer}:
Tracer(1,)
Tracer(1, 2)
Tracer(3,)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/35810e3d7df7af36ca0bdf78a35bc620de121121/src/connectivity.jl#L3-L26">source</a></section></article><p>The following utilities can be used to extract input indices from <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a>s:</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="SparseConnectivityTracer.inputs" href="#SparseConnectivityTracer.inputs"><code>SparseConnectivityTracer.inputs</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">inputs(tracer)</code></pre><p>Return raw <code>UInt64</code> input indices of a <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a>. See also <a href="#SparseConnectivityTracer.sortedinputs"><code>sortedinputs</code></a>.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; t = tracer(1, 2, 4)
Tracer(3,)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/045274ab1665e32f97078c0c3498c1a248d71b68/src/connectivity.jl#L3-L26">source</a></section></article><p>The following utilities can be used to extract input indices from <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a>s:</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="SparseConnectivityTracer.inputs" href="#SparseConnectivityTracer.inputs"><code>SparseConnectivityTracer.inputs</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">inputs(tracer)</code></pre><p>Return raw <code>UInt64</code> input indices of a <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a>. See also <a href="#SparseConnectivityTracer.sortedinputs"><code>sortedinputs</code></a>.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; t = tracer(1, 2, 4)
Tracer(1, 2, 4)

julia&gt; inputs(t)
3-element Vector{UInt64}:
0x0000000000000004
0x0000000000000002
0x0000000000000001</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/35810e3d7df7af36ca0bdf78a35bc620de121121/src/tracer.jl#L102-L119">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="SparseConnectivityTracer.sortedinputs" href="#SparseConnectivityTracer.sortedinputs"><code>SparseConnectivityTracer.sortedinputs</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">sortedinputs(tracer)
0x0000000000000001</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/045274ab1665e32f97078c0c3498c1a248d71b68/src/tracer.jl#L102-L119">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="SparseConnectivityTracer.sortedinputs" href="#SparseConnectivityTracer.sortedinputs"><code>SparseConnectivityTracer.sortedinputs</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">sortedinputs(tracer)
sortedinputs([T=Int], tracer)</code></pre><p>Return sorted input indices of a <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a>. See also <a href="#SparseConnectivityTracer.inputs"><code>inputs</code></a>.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; t = tracer(1, 2, 4)
Tracer(1, 2, 4)

Expand All @@ -93,4 +93,4 @@
3-element Vector{UInt8}:
0x01
0x02
0x04</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/35810e3d7df7af36ca0bdf78a35bc620de121121/src/tracer.jl#L122-L146">source</a></section></article></article><nav class="docs-footer"><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="auto">Automatic (OS)</option><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 1.3.0 on <span class="colophon-date" title="Monday 1 April 2024 19:44">Monday 1 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0x04</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/045274ab1665e32f97078c0c3498c1a248d71b68/src/tracer.jl#L122-L146">source</a></section></article></article><nav class="docs-footer"><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="auto">Automatic (OS)</option><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 1.3.0 on <span class="colophon-date" title="Monday 1 April 2024 21:23">Monday 1 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 5b2036c

Please sign in to comment.