build based on 63560b0

adrhill · Apr 1, 2024 · b58d391 · b58d391
1 parent e6f7257
commit b58d391
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 3 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-28T19:45:43","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-01T18:07:22","documenter_version":"1.3.0"}}
diff --git a/dev/index.html b/dev/index.html
@@ -1,2 +1,44 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · SparseConnectivityTracer.jl</title><meta name="title" content="Home · SparseConnectivityTracer.jl"/><meta property="og:title" content="Home · SparseConnectivityTracer.jl"/><meta property="twitter:title" content="Home · SparseConnectivityTracer.jl"/><meta name="description" content="Documentation for SparseConnectivityTracer.jl."/><meta property="og:description" content="Documentation for SparseConnectivityTracer.jl."/><meta property="twitter:description" content="Documentation for SparseConnectivityTracer.jl."/><meta property="og:url" content="https://adrhill.github.io/SparseConnectivityTracer.jl/"/><meta property="twitter:url" content="https://adrhill.github.io/SparseConnectivityTracer.jl/"/><link rel="canonical" href="https://adrhill.github.io/SparseConnectivityTracer.jl/"/><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>SparseConnectivityTracer.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 class="is-active"><a class="tocitem" href>Home</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"><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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/adrhill/SparseConnectivityTracer.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/adrhill/SparseConnectivityTracer.jl/blob/main/docs/src/index.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="SparseConnectivityTracer"><a class="docs-heading-anchor" href="#SparseConnectivityTracer">SparseConnectivityTracer</a><a id="SparseConnectivityTracer-1"></a><a class="docs-heading-anchor-permalink" href="#SparseConnectivityTracer" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/adrhill/SparseConnectivityTracer.jl">SparseConnectivityTracer</a>.</p><ul></ul></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="Thursday 28 March 2024 19:45">Thursday 28 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · SparseConnectivityTracer.jl</title><meta name="title" content="Home · SparseConnectivityTracer.jl"/><meta property="og:title" content="Home · SparseConnectivityTracer.jl"/><meta property="twitter:title" content="Home · SparseConnectivityTracer.jl"/><meta name="description" content="Documentation for SparseConnectivityTracer.jl."/><meta property="og:description" content="Documentation for SparseConnectivityTracer.jl."/><meta property="twitter:description" content="Documentation for SparseConnectivityTracer.jl."/><meta property="og:url" content="https://adrhill.github.io/SparseConnectivityTracer.jl/"/><meta property="twitter:url" content="https://adrhill.github.io/SparseConnectivityTracer.jl/"/><link rel="canonical" href="https://adrhill.github.io/SparseConnectivityTracer.jl/"/><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>SparseConnectivityTracer.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 class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#API-reference"><span>API reference</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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/adrhill/SparseConnectivityTracer.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/adrhill/SparseConnectivityTracer.jl/blob/main/docs/src/index.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="SparseConnectivityTracer"><a class="docs-heading-anchor" href="#SparseConnectivityTracer">SparseConnectivityTracer</a><a id="SparseConnectivityTracer-1"></a><a class="docs-heading-anchor-permalink" href="#SparseConnectivityTracer" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/adrhill/SparseConnectivityTracer.jl">SparseConnectivityTracer</a>.</p><ul><li><a href="#SparseConnectivityTracer.Tracer"><code>SparseConnectivityTracer.Tracer</code></a></li><li><a href="#SparseConnectivityTracer.connectivity"><code>SparseConnectivityTracer.connectivity</code></a></li><li><a href="#SparseConnectivityTracer.inputs"><code>SparseConnectivityTracer.inputs</code></a></li><li><a href="#SparseConnectivityTracer.sortedinputs"><code>SparseConnectivityTracer.sortedinputs</code></a></li><li><a href="#SparseConnectivityTracer.tracer"><code>SparseConnectivityTracer.tracer</code></a></li></ul><h2 id="API-reference"><a class="docs-heading-anchor" href="#API-reference">API reference</a><a id="API-reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-reference" title="Permalink"></a></h2><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>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; x = tracer(1, 2, 3)
+Tracer(1, 2, 3)
+
+julia&gt; sin(x)
+Tracer(1, 2, 3)
+
+julia&gt; 2 * x^3
+Tracer(1, 2, 3)
+
+julia&gt; 0 * x   # Note: Tracer is strictly operator overloading...
+Tracer(1, 2, 3)
+
+julia&gt; zero(x) # ...this can be overloaded
+Tracer()
+
+julia&gt; y = tracer(3, 5)
+Tracer(3, 5)
+
+julia&gt; x + y
+Tracer(1, 2, 3, 5)
+
+julia&gt; x ^ y
+Tracer(1, 2, 3, 5)
+
+julia&gt; M = rand(Tracer, 3, 2)
+3×2 Matrix{Tracer}:
+ Tracer()  Tracer()
+ Tracer()  Tracer()
+ Tracer()  Tracer()
+
+julia&gt; similar(M)
+3×2 Matrix{Tracer}:
+ Tracer()  Tracer()
+ Tracer()  Tracer()
+ Tracer()  Tracer()
+
+julia&gt; M * [x, y]
+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/63560b013dc2cf26a8f05011bb52051692a41b56/src/tracer.jl#L1-L52">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/63560b013dc2cf26a8f05011bb52051692a41b56/src/tracer.jl#L65-L70">source</a></section></article><p>The resulting connectivity matrix can be extracted using <a href="#SparseConnectivityTracer.connectivity"><code>connectivity</code></a>: </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.connectivity" href="#SparseConnectivityTracer.connectivity"><code>SparseConnectivityTracer.connectivity</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">connectivity(f, x)</code></pre><p>Enumerates inputs <code>x</code> and primal outputs <code>y=f(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/63560b013dc2cf26a8f05011bb52051692a41b56/src/connectivity.jl#L10-L15">source</a></section></article><p>or manually from individual <a href="#SparseConnectivityTracer.Tracer"><code>Tracer</code></a> outputs:</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>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/63560b013dc2cf26a8f05011bb52051692a41b56/src/tracer.jl#L79-L83">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>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/adrhill/SparseConnectivityTracer.jl/blob/63560b013dc2cf26a8f05011bb52051692a41b56/src/tracer.jl#L86-L91">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 18:07">Monday 1 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/objects.inv b/dev/objects.inv