Skip to content

Commit

Permalink
build based on 65a30c7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 24, 2024
1 parent 46bb6be commit a15fdc4
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.5","generation_timestamp":"2024-09-24T10:13:05","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-24T18:18:46","documenter_version":"1.7.0"}}
12 changes: 6 additions & 6 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · AztecDiamonds.jl</title><meta name="title" content="Home · AztecDiamonds.jl"/><meta property="og:title" content="Home · AztecDiamonds.jl"/><meta property="twitter:title" content="Home · AztecDiamonds.jl"/><meta name="description" content="Documentation for AztecDiamonds.jl."/><meta property="og:description" content="Documentation for AztecDiamonds.jl."/><meta property="twitter:description" content="Documentation for AztecDiamonds.jl."/><meta property="og:url" content="https://julia.mit.edu/AztecDiamonds.jl/"/><meta property="twitter:url" content="https://julia.mit.edu/AztecDiamonds.jl/"/><link rel="canonical" href="https://julia.mit.edu/AztecDiamonds.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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>AztecDiamonds.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/JuliaLabs/AztecDiamonds.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/JuliaLabs/AztecDiamonds.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="AztecDiamonds"><a class="docs-heading-anchor" href="#AztecDiamonds">AztecDiamonds</a><a id="AztecDiamonds-1"></a><a class="docs-heading-anchor-permalink" href="#AztecDiamonds" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/JuliaLabs/AztecDiamonds.jl">AztecDiamonds</a>.</p><p>For an example notebook using this package, see <a href="https://julia.mit.edu/AztecDiamonds.jl/examples/stable/notebook.html">here</a>.</p><p>Here&#39;s a random diamond:</p><pre><code class="language-julia hljs">using AztecDiamonds
show(stdout, MIME(&quot;text/plain&quot;), diamond(10))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">10-order Tiling{Matrix{AztecDiamonds.Edge}}
show(stdout, MIME(&quot;text/plain&quot;), diamond(10))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Order-10 Tiling{Matrix{AztecDiamonds.Edge}}
<span class="sgr33">🬇🬋🬋🬃</span>
<span class="sgr33">🬇🬋🬋🬃🬇🬋🬋🬃</span>
<span class="sgr33">🬇🬋🬋🬃🬇🬋🬋🬃🬇🬋🬋🬃</span>
Expand All @@ -21,24 +21,24 @@
<span class="sgr34">🬇🬋🬋🬃🬇🬋🬋🬃🬇🬋🬋🬃</span>
<span class="sgr34">🬇🬋🬋🬃🬇🬋🬋🬃</span>
<span class="sgr34">🬇🬋🬋🬃</span></code></pre><ul><li><a href="#AztecDiamonds.Tiling"><code>AztecDiamonds.Tiling</code></a></li><li><a href="#AztecDiamonds.diamond-Tuple{Int64}"><code>AztecDiamonds.diamond</code></a></li><li><a href="#AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}"><code>AztecDiamonds.ka_diamond</code></a></li></ul><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="AztecDiamonds.Tiling" href="#AztecDiamonds.Tiling"><code>AztecDiamonds.Tiling</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Tiling(N::Int[, x::OffsetMatrix{AztecDiamonds.Edge}]; sizehint::Int = N)</code></pre><p>Represents an order N diamond-shaped tiling. If <code>x</code> is not provided, it is initialized with <code>NONE</code> representing an empty tiling. The <code>sizehint</code> keyword argument may be used to preallocate a larger matrix for <code>x</code> fitting a tiling of order <code>sizehint</code> to avoid reallocations when the tiling grows.</p><p>The indices of <code>x</code> represent the coordinates of the diamond-shaped tiling and run from 1-N to N (though <code>x</code> is allowed to be larger as long as it contains these indices). The edges it contains can either be <code>UP</code>, <code>RIGHT</code>, or <code>NONE</code>, where <code>UP</code> represents a vertical tile covering one more tile to the top, <code>RIGHT</code> represents a horizontal tile covering one more tile to the right. <code>NONE</code> means the edge is either already covered by another tile to the bottom or left or the tiling is not fully filled yet.</p><pre><code class="language-julia-repl hljs">julia&gt; t = Tiling(1)
1-order Tiling{Matrix{AztecDiamonds.Edge}}
Order-1 Tiling{Matrix{AztecDiamonds.Edge}}



julia&gt; t[0, 0] = t[1, 0] = AztecDiamonds.RIGHT;

julia&gt; t
1-order Tiling{Matrix{AztecDiamonds.Edge}}
Order-1 Tiling{Matrix{AztecDiamonds.Edge}}
🬇🬋🬋🬃
🬇🬋🬋🬃</code></pre><p>See <a href="#AztecDiamonds.diamond-Tuple{Int64}"><code>diamond</code></a> and <a href="#AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}"><code>ka_diamond</code></a> for constructing a filled tiling.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLabs/AztecDiamonds.jl/blob/39ca617e900c98671ab8179c91eb776c49d3aac1/src/AztecDiamonds.jl#L12-L41">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="AztecDiamonds.diamond-Tuple{Int64}" href="#AztecDiamonds.diamond-Tuple{Int64}"><code>AztecDiamonds.diamond</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">diamond(N::Int) -&gt; Tiling{Matrix{AztecDiamonds.Edge}}</code></pre><p>Generates a uniformally random order N diamond tiling.</p><pre><code class="language-julia-repl hljs">julia&gt; using Random; Random.seed!(1);
🬇🬋🬋🬃</code></pre><p>See <a href="#AztecDiamonds.diamond-Tuple{Int64}"><code>diamond</code></a> and <a href="#AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}"><code>ka_diamond</code></a> for constructing a filled tiling.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLabs/AztecDiamonds.jl/blob/65a30c7fda80fcd1eb8566de03b8571985607e73/src/AztecDiamonds.jl#L12-L41">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="AztecDiamonds.diamond-Tuple{Int64}" href="#AztecDiamonds.diamond-Tuple{Int64}"><code>AztecDiamonds.diamond</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">diamond(N::Int) -&gt; Tiling{Matrix{AztecDiamonds.Edge}}</code></pre><p>Generates a uniformally random order N diamond tiling.</p><pre><code class="language-julia-repl hljs">julia&gt; using Random; Random.seed!(1);

julia&gt; diamond(4)
4-order Tiling{Matrix{AztecDiamonds.Edge}}
Order-4 Tiling{Matrix{AztecDiamonds.Edge}}
🬇🬋🬋🬃
🬇🬋🬋🬃🬇🬋🬋🬃
🬦🬓🬦🬓🬦🬓🬦🬓🬇🬋🬋🬃
🬦🬓🬉🬄🬉🬄🬉🬄🬉🬄🬇🬋🬋🬃🬦🬓
🬉🬄🬦🬓🬦🬓🬇🬋🬋🬃🬦🬓🬦🬓🬉🬄
🬉🬄🬉🬄🬇🬋🬋🬃🬉🬄🬉🬄
🬇🬋🬋🬃🬇🬋🬋🬃
🬇🬋🬋🬃</code></pre><p>See <a href="#AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}"><code>ka_diamond</code></a> for a version that can take advantage of GPU acceleration. <code>ka_diamond(N, Array)</code> may also be faster for large N.</p><p>Ref <a href="#AztecDiamonds.Tiling"><code>Tiling</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLabs/AztecDiamonds.jl/blob/39ca617e900c98671ab8179c91eb776c49d3aac1/src/AztecDiamonds.jl#L178-L202">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="AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}" href="#AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}"><code>AztecDiamonds.ka_diamond</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ka_diamond(N::Int, ArrayT::Type{&lt;:AbstractArray}) -&gt; Tiling{ArrayT{Edge}}</code></pre><p>Generate a uniformly random diamond tiling just like <a href="#AztecDiamonds.diamond-Tuple{Int64}"><code>diamond</code></a>, but using <code>KernelAbstractions.jl</code> to be able to take advantage of (GPU) parallelism. <code>ArrayT</code> can either be <code>Array</code> or any GPU array type.</p><p>Ref <a href="#AztecDiamonds.Tiling"><code>Tiling</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLabs/AztecDiamonds.jl/blob/39ca617e900c98671ab8179c91eb776c49d3aac1/src/ka.jl#L116-L123">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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 24 September 2024 10:13">Tuesday 24 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
🬇🬋🬋🬃</code></pre><p>See <a href="#AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}"><code>ka_diamond</code></a> for a version that can take advantage of GPU acceleration. <code>ka_diamond(N, Array)</code> may also be faster for large N.</p><p>Ref <a href="#AztecDiamonds.Tiling"><code>Tiling</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLabs/AztecDiamonds.jl/blob/65a30c7fda80fcd1eb8566de03b8571985607e73/src/AztecDiamonds.jl#L178-L202">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="AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}" href="#AztecDiamonds.ka_diamond-Tuple{Int64, Type{&lt;:AbstractArray}}"><code>AztecDiamonds.ka_diamond</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ka_diamond(N::Int, ArrayT::Type{&lt;:AbstractArray}) -&gt; Tiling{ArrayT{Edge}}</code></pre><p>Generate a uniformly random diamond tiling just like <a href="#AztecDiamonds.diamond-Tuple{Int64}"><code>diamond</code></a>, but using <code>KernelAbstractions.jl</code> to be able to take advantage of (GPU) parallelism. <code>ArrayT</code> can either be <code>Array</code> or any GPU array type.</p><p>Ref <a href="#AztecDiamonds.Tiling"><code>Tiling</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLabs/AztecDiamonds.jl/blob/65a30c7fda80fcd1eb8566de03b8571985607e73/src/ka.jl#L116-L123">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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 24 September 2024 18:18">Tuesday 24 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit a15fdc4

Please sign in to comment.