Skip to content

Commit

Permalink
build based on bee6794
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 26, 2023
1 parent 709cde2 commit b8a5df7
Show file tree
Hide file tree
Showing 16 changed files with 122 additions and 122 deletions.
2 changes: 1 addition & 1 deletion dev/contiguous/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@
16
5
1
1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/chunk-types/bits.jl#L200-L223">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../generated/streams/">« Streams</a><a class="docs-footer-nextpage" href="../generated/balanced-parentheses/">Balanced Parentheses »</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="Monday 21 August 2023 06:04">Monday 21 August 2023</span>. Using Julia version 1.8.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/chunk-types/bits.jl#L200-L223">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../generated/streams/">« Streams</a><a class="docs-footer-nextpage" href="../generated/balanced-parentheses/">Balanced Parentheses »</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="Saturday 26 August 2023 12:21">Saturday 26 August 2023</span>. Using Julia version 1.8.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
12 changes: 6 additions & 6 deletions dev/dicts/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Dictionaries · PureFun.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="../">PureFun.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="../">Purely Functional Data Structures, in Julia</a></li><li><a class="tocitem" href="../lists/">Lists</a></li><li><a class="tocitem" href="../queues/">Queues/Deques</a></li><li><a class="tocitem" href="../heaps/">Heaps</a></li><li class="is-active"><a class="tocitem" href>Dictionaries</a><ul class="internal"><li><a class="tocitem" href="#RedBlack.RBDict-(\\S{3.3})"><span><code>RedBlack.RBDict</code> (<span>$\S{3.3}$</span>)</span></a></li><li><a class="tocitem" href="#Tries-(\\S{10.3.1})"><span><code>Tries</code> (<span>$\S{10.3.1}$</span>)</span></a></li><li><a class="tocitem" href="#HashMap:-\\S{10.3.1}-exercise-10.11"><span><code>HashMap</code>: <span>$\S{10.3.1}$</span> exercise 10.11</span></a></li><li><a class="tocitem" href="#Association.List"><span><code>Association.List</code></span></a></li><li><a class="tocitem" href="#Function-reference"><span>Function reference</span></a></li></ul></li><li><a class="tocitem" href="../sets/">Sets</a></li><li><a class="tocitem" href="../generated/streams/">Streams</a></li><li><a class="tocitem" href="../contiguous/">Small size optimizations</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../generated/balanced-parentheses/">Balanced Parentheses</a></li><li><a class="tocitem" href="../generated/taxicab/">Ramanujan (taxicab) numbers</a></li><li><a class="tocitem" href="../generated/suffixes/">Generating Suffixes</a></li><li><a class="tocitem" href="../generated/hamt/">Hash Array Mapped Tries</a></li><li><a class="tocitem" href="../generated/estimating-pi/">Estimating π</a></li><li><a class="tocitem" href="../generated/data-parallelism/">Data parallelism</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 class="is-active"><a href>Dictionaries</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Dictionaries</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/tarakc02/PureFun.jl/blob/main//docs/src/dicts.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="Dictionaries"><a class="docs-heading-anchor" href="#Dictionaries">Dictionaries</a><a id="Dictionaries-1"></a><a class="docs-heading-anchor-permalink" href="#Dictionaries" title="Permalink"></a></h1><h2 id="RedBlack.RBDict-(\\S{3.3})"><a class="docs-heading-anchor" href="#RedBlack.RBDict-(\\S{3.3})"><code>RedBlack.RBDict</code> (<span>$\S{3.3}$</span>)</a><a id="RedBlack.RBDict-(\\S{3.3})-1"></a><a class="docs-heading-anchor-permalink" href="#RedBlack.RBDict-(\\S{3.3})" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PureFun.RedBlack.RBDict" href="#PureFun.RedBlack.RBDict"><code>PureFun.RedBlack.RBDict</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">RedBlack.RBDict{O,K,V} where O
RedBlack.RBDict{K,V}(ord=Base.Order.Forward)
RedBlack.RBDict(iter, o::Ordering=Base.Order.Forward)</code></pre><p>Immutable dictionary implemented using a red-black tree (balanced binary search tree). All major operations are <span>$\mathcal{O}(\log{}n)$</span>. Note the ordering parameter, the RBDict iterates in sorted order according to the ordering <code>O</code>. In addition to the main <code>PFDict</code> methods, <code>RBDict</code> implements <code>delete</code>, <code>delete_min</code>, and <code>delete_max</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using PureFun, PureFun.RedBlack
RedBlack.RBDict(iter, o::Ordering=Base.Order.Forward)</code></pre><p>Immutable dictionary implemented using a red-black tree (balanced binary search tree). All major operations are <span>$\mathcal{O}(\log{}n)$</span>. Note the ordering parameter, the RBDict iterates in sorted order according to the ordering <code>O</code>. In addition to the main <code>PFDict</code> methods, <code>RBDict</code> implements <code>delete</code>, <code>popmin</code>, and <code>popmax</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using PureFun, PureFun.RedBlack

julia&gt; f = RedBlack.RBDict((&quot;zyz&quot; =&gt; 1, &quot;abc&quot; =&gt; 2, &quot;ghi&quot; =&gt; 3))
PureFun.RedBlack.RBDict{Base.Order.ForwardOrdering, String, Int64} with 3 entries:
Expand All @@ -15,22 +15,22 @@
&quot;ghi&quot; =&gt; 3
&quot;abc&quot; =&gt; 2

julia&gt; delete_min(f)
julia&gt; popmin(f)
PureFun.RedBlack.RBDict{Base.Order.ForwardOrdering, String, Int64} with 2 entries:
&quot;ghi&quot; =&gt; 3
&quot;zyz&quot; =&gt; 1

julia&gt; delete_max(f)
julia&gt; popmax(f)
PureFun.RedBlack.RBDict{Base.Order.ForwardOrdering, String, Int64} with 2 entries:
&quot;abc&quot; =&gt; 2
&quot;ghi&quot; =&gt; 3

julia&gt; delete_min(b)
julia&gt; popmin(b)
PureFun.RedBlack.RBDict{Base.Order.ReverseOrdering{Base.Order.ForwardOrdering}, String, Int64} with 2 entries:
&quot;ghi&quot; =&gt; 3
&quot;abc&quot; =&gt; 2

julia&gt; delete_max(b)
julia&gt; popmax(b)
PureFun.RedBlack.RBDict{Base.Order.ReverseOrdering{Base.Order.ForwardOrdering}, String, Int64} with 2 entries:
&quot;zyz&quot; =&gt; 1
&quot;ghi&quot; =&gt; 3
Expand Down Expand Up @@ -168,4 +168,4 @@
0x6ab9 =&gt; &#39;檹&#39;
0x4eb0 =&gt; &#39;亰&#39;
0xd55c =&gt; &#39;한&#39;
0xd018 =&gt; &#39;퀘&#39;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/dicts/association-list.jl#L28-L50">source</a></section></article><h2 id="Function-reference"><a class="docs-heading-anchor" href="#Function-reference">Function reference</a><a id="Function-reference-1"></a><a class="docs-heading-anchor-permalink" href="#Function-reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="Base.setindex-Tuple{PureFun.PFDict, Any, Any}" href="#Base.setindex-Tuple{PureFun.PFDict, Any, Any}"><code>Base.setindex</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">setindex(d::PFDict, v, i)</code></pre><p>Return a new dictionary with the value at key <code>i</code> set to <code>v</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/pfdict-interface.jl#L19-L23">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.get-Tuple{PureFun.PFDict, Any, Any}" href="#Base.get-Tuple{PureFun.PFDict, Any, Any}"><code>Base.get</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">get(d::PFDict, key, default)</code></pre><p>Get the value associated with <code>key</code>, or return <code>default</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/pfdict-interface.jl#L26-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PureFun.PFDict" href="#PureFun.PFDict"><code>PureFun.PFDict</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Abstract supertype for immutable dictionaries.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/pfdict-interface.jl#L1-L5">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heaps/">« Heaps</a><a class="docs-footer-nextpage" href="../sets/">Sets »</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="Monday 21 August 2023 06:04">Monday 21 August 2023</span>. Using Julia version 1.8.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0xd018 =&gt; &#39;퀘&#39;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/dicts/association-list.jl#L28-L50">source</a></section></article><h2 id="Function-reference"><a class="docs-heading-anchor" href="#Function-reference">Function reference</a><a id="Function-reference-1"></a><a class="docs-heading-anchor-permalink" href="#Function-reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="Base.setindex-Tuple{PureFun.PFDict, Any, Any}" href="#Base.setindex-Tuple{PureFun.PFDict, Any, Any}"><code>Base.setindex</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">setindex(d::PFDict, v, i)</code></pre><p>Return a new dictionary with the value at key <code>i</code> set to <code>v</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/pfdict-interface.jl#L19-L23">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.get-Tuple{PureFun.PFDict, Any, Any}" href="#Base.get-Tuple{PureFun.PFDict, Any, Any}"><code>Base.get</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">get(d::PFDict, key, default)</code></pre><p>Get the value associated with <code>key</code>, or return <code>default</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/pfdict-interface.jl#L26-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PureFun.PFDict" href="#PureFun.PFDict"><code>PureFun.PFDict</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Abstract supertype for immutable dictionaries.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tarakc02/PureFun.jl/blob/main//src/pfdict-interface.jl#L1-L5">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heaps/">« Heaps</a><a class="docs-footer-nextpage" href="../sets/">Sets »</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="Saturday 26 August 2023 12:21">Saturday 26 August 2023</span>. Using Julia version 1.8.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit b8a5df7

Please sign in to comment.