Merge pull request #21 from JuliaLabs/sds/runic

format using Runic

Author: simeonschaub

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# formatting using Runic
+b590cd059b303487b2d97b2f702dd5e349fdec91

.github/workflows/CI.yml

@@ -59,3 +59,18 @@ jobs:
             using AztecDiamonds
             DocMeta.setdocmeta!(AztecDiamonds, :DocTestSetup, :(using AztecDiamonds); recursive=true)
             doctest(AztecDiamonds)'
+  runic:
+    name: Runic
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: "nightly" # Only nightly have the -m flag currently
+      - uses: julia-actions/cache@v2
+      - name: Install Runic
+        run: |
+          julia --color=yes --project=@runic -e 'using Pkg; Pkg.add(url = "https://github.com/fredrikekre/Runic.jl")'
+      - name: Run Runic
+        run: |
+          git ls-files -z -- '*.jl' | xargs -0 julia --project=@runic -m Runic --check --diff

docs/make.jl

@@ -1,20 +1,20 @@
 using AztecDiamonds
 using Documenter
 
-DocMeta.setdocmeta!(AztecDiamonds, :DocTestSetup, :(using AztecDiamonds); recursive=true)
+DocMeta.setdocmeta!(AztecDiamonds, :DocTestSetup, :(using AztecDiamonds); recursive = true)
 
 makedocs(;
-    modules=[AztecDiamonds],
-    authors="Simeon David Schaub <schaub@mit.edu> and contributors",
-    repo="https://github.com/JuliaLabs/AztecDiamonds.jl/blob/{commit}{path}#{line}",
-    sitename="AztecDiamonds.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://julia.mit.edu/AztecDiamonds.jl",
-        edit_link="main",
-        assets=String[],
+    modules = [AztecDiamonds],
+    authors = "Simeon David Schaub <schaub@mit.edu> and contributors",
+    repo = "https://github.com/JuliaLabs/AztecDiamonds.jl/blob/{commit}{path}#{line}",
+    sitename = "AztecDiamonds.jl",
+    format = Documenter.HTML(;
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://julia.mit.edu/AztecDiamonds.jl",
+        edit_link = "main",
+        assets = String[],
     ),
-    pages=[
+    pages = [
         "Home" => "index.md",
         #"Examples" => [
         #    "Basics" => "https://julia.mit.edu/AztecDiamonds.jl/examples/dev/notebook.html",
@@ -23,6 +23,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/JuliaLabs/AztecDiamonds.jl",
-    devbranch="main",
+    repo = "github.com/JuliaLabs/AztecDiamonds.jl",
+    devbranch = "main",
 )

examples/notebook.jl

@@ -6,8 +6,8 @@ using InteractiveUtils
 
 # ╔═╡ a609b8a8-04ac-4533-9a33-61ea33805846
 begin
-	using AztecDiamonds, CairoMakie
-	CairoMakie.activate!(type = "svg")
+    using AztecDiamonds, CairoMakie
+    CairoMakie.activate!(type = "svg")
 end
 
 # ╔═╡ 84f88e89-c55e-41ba-97ad-fd561458c7e9
@@ -18,12 +18,12 @@ D = diamond(N)
 
 # ╔═╡ 1cf94d6d-a0bc-474b-b479-5b4f4c916ea5
 let
-	f = Figure()
-	ax = Axis(f[1, 1]; aspect=1)
-	plot!(ax, D; domino_padding=0)
-	lines!(ax, -N:N, parent(dr_path(D)); linewidth=3, label="DR-path", color=:orange)
-	axislegend(ax)
-	f
+    f = Figure()
+    ax = Axis(f[1, 1]; aspect = 1)
+    plot!(ax, D; domino_padding = 0)
+    lines!(ax, -N:N, parent(dr_path(D)); linewidth = 3, label = "DR-path", color = :orange)
+    axislegend(ax)
+    f
 end
 
 # ╔═╡ ab0968e2-43c7-4610-87ba-47433c003081

src/AztecDiamonds.jl

@@ -7,15 +7,15 @@ export Tiling, diamond, ka_diamond, dr_path
 
 @enum Edge::UInt8 NONE UP RIGHT SHOULD_FILL
 
-inds(N) = (1-N:N, 1-N:N)
+inds(N) = ((1 - N):N, (1 - N):N)
 
-struct Tiling{M<:AbstractMatrix{Edge}}
+struct Tiling{M <: AbstractMatrix{Edge}}
     N::Int
     x::OffsetMatrix{Edge, M}
 end
-Tiling(N::Int; sizehint=N) = Tiling(N, fill(NONE, inds(sizehint)))
+Tiling(N::Int; sizehint = N) = Tiling(N, fill(NONE, inds(sizehint)))
 
-in_diamond(N, i, j) = abs(2i-1) + abs(2j-1) ≤ 2N
+in_diamond(N, i, j) = abs(2i - 1) + abs(2j - 1) ≤ 2N
 Base.checkbounds(::Type{Bool}, (; N)::Tiling, i, j) = in_diamond(N, i, j)
 function Base.checkbounds(t::Tiling, i, j)
     checkbounds(Bool, t, i, j) || throw(BoundsError(t, (i, j)))
@@ -47,30 +47,30 @@ struct DiamondFaces <: Transducers.Foldable
 end
 faces((; N)::Tiling) = DiamondFaces(N)
 Base.eltype(::DiamondFaces) = Tuple{Int, Int, Bool}
-Base.length((; N)::DiamondFaces) = N * (N+1) * 2
+Base.length((; N)::DiamondFaces) = N * (N + 1) * 2
 function Transducers.__foldl__(rf::R, val::V, (; N)::DiamondFaces) where {R, V}
-    for j in 1-N:N
-        j′ = max(j, 1-j)
-        for i in j′-N:N-j′+1
-            isdotted = isodd(i+j-N)
+    for j in (1 - N):N
+        j′ = max(j, 1 - j)
+        for i in (j′ - N):(N - j′ + 1)
+            isdotted = isodd(i + j - N)
             val = @next(rf, val, (i, j, isdotted))
         end
     end
     return complete(rf, val)
 end
 
 
-struct BlockIterator{good, T<:Tiling} <: Transducers.Foldable
+struct BlockIterator{good, T <: Tiling} <: Transducers.Foldable
     t::T
-    BlockIterator{good}(t::T) where {good, T<:Tiling} = new{good, T}(t)
+    BlockIterator{good}(t::T) where {good, T <: Tiling} = new{good, T}(t)
 end
 Base.@propagate_inbounds function isblock(t::Tiling, i, j, ::Val{good}) where {good}
     (; N) = t
-    isdotted = isodd(i+j-N)
+    isdotted = isodd(i + j - N)
     tile = t[i, j]
-    if tile == UP && j < N && get(t, (i, j+1), NONE) == UP
+    if tile == UP && j < N && get(t, (i, j + 1), NONE) == UP
         return good == isdotted
-    elseif tile == RIGHT && i < N && get(t, (i+1, j), NONE) == RIGHT
+    elseif tile == RIGHT && i < N && get(t, (i + 1, j), NONE) == RIGHT
         return good == isdotted
     end
     return false
@@ -86,9 +86,9 @@ end
 function remove_bad_blocks!(t::Tiling)
     foreach(BlockIterator{false}(t)) do (i, j)
         @inbounds if t[i, j] == UP
-            t[i, j+1] = NONE
+            t[i, j + 1] = NONE
         else
-            t[i+1, j] = NONE
+            t[i + 1, j] = NONE
         end
         @inbounds t[i, j] = NONE
     end
@@ -101,26 +101,26 @@ function slide_tiles!(t′::Tiling, t::Tiling)
         tile = @inbounds t[i, j]
         inc = isdotted ? -1 : 1
         @inbounds if tile == UP
-            t′[i, j+inc] = UP
+            t′[i, j + inc] = UP
         elseif tile == RIGHT
-            t′[i+inc, j] = RIGHT
+            t′[i + inc, j] = RIGHT
         end
     end
     return t′
 end
 
 Base.@propagate_inbounds function is_empty_tile(t′::Tiling, i, j)
-    return t′[i, j] == NONE && get(t′, (i-1, j), NONE) != UP && get(t′, (i, j-1), NONE) != RIGHT
+    return t′[i, j] == NONE && get(t′, (i - 1, j), NONE) != UP && get(t′, (i, j - 1), NONE) != RIGHT
 end
 
 # filling
 function fill_empty_blocks!(t′::Tiling)
     foreach(faces(t′)) do (i, j)
         @inbounds if is_empty_tile(t′, i, j)
             if rand(Bool)
-                t′[i, j] = t′[i, j+1] = UP
+                t′[i, j] = t′[i, j + 1] = UP
             else
-                t′[i, j] = t′[i+1, j] = RIGHT
+                t′[i, j] = t′[i + 1, j] = RIGHT
             end
         end
     end
@@ -138,15 +138,15 @@ end
 function diamond!(t, t′, N)
     for N in 1:N
         (; x) = t′
-        view(x, inds(N-1)...) .= NONE
+        view(x, inds(N - 1)...) .= NONE
         t′ = Tiling(N, x)
         t, t′ = step!(t′, t), t
     end
     return t
 end
 
 function diamond(N)
-    t, t′ = Tiling(0; sizehint=N), Tiling(0; sizehint=N)
+    t, t′ = Tiling(0; sizehint = N), Tiling(0; sizehint = N)
     return diamond!(t, t′, N)
 end
 

src/dr_path.jl

@@ -4,9 +4,9 @@ function dr_path(t::Tiling)
     y[-N] = -0.5
     prev = UP
     i = -1
-    for j in 1-N:N
-        @assert checkbounds(Bool, t, i+1, j)
-        tile = x[i+1, j]
+    for j in (1 - N):N
+        @assert checkbounds(Bool, t, i + 1, j)
+        tile = x[i + 1, j]
         if prev == RIGHT
             y[j] = i + 0.5
         elseif tile == UP

src/ka.jl

@@ -11,9 +11,9 @@ KernelAbstractions.get_backend((; x)::Tiling) = KernelAbstractions.get_backend(x
 
     @inbounds if in_diamond(N, i, j) && isblock(t, i, j, Val(false))
         if t[i, j] == UP
-            t[i, j+1] = NONE
+            t[i, j + 1] = NONE
         else
-            t[i+1, j] = NONE
+            t[i + 1, j] = NONE
         end
         t[i, j] = NONE
     end
@@ -27,12 +27,12 @@ end
 
     @inbounds if in_diamond(N, i, j)
         tile = @inbounds t[i, j]
-        isdotted = isodd(i+j-N)
+        isdotted = isodd(i + j - N)
         inc = ifelse(isdotted, -1, 1)
         @inbounds if tile == UP
-            t′[i, j+inc] = UP
+            t′[i, j + inc] = UP
         elseif tile == RIGHT
-            t′[i+inc, j] = RIGHT
+            t′[i + inc, j] = RIGHT
         end
     end
 end
@@ -71,9 +71,9 @@ end
     @inbounds if in_diamond(N, i, j)
         if scratch[i, j] == SHOULD_FILL
             if rand(Bool)
-                t′[i, j] = t′[i, j+1] = UP
+                t′[i, j] = t′[i, j + 1] = UP
             else
-                t′[i, j] = t′[i+1, j] = RIGHT
+                t′[i, j] = t′[i + 1, j] = RIGHT
             end
         end
     end
@@ -99,7 +99,7 @@ function ka_diamond!(t, t′, N; backend)
     t, t′ = t′, t
 
     for N in 2:N
-        zero!(t′, N-1; ndrange)
+        zero!(t′, N - 1; ndrange)
         t′ = Tiling(N, t′.x)
 
         remove_bad_blocks!(t; ndrange)
@@ -116,7 +116,7 @@ end
 function ka_diamond(N, ArrayT)
     mem = ntuple(_ -> fill!(ArrayT{Edge}(undef, 2N, 2N), NONE), 2)
     t, t′ = map(x -> Tiling(0, OffsetMatrix(x, inds(N))), mem)
-    return ka_diamond!(t, t′, N; backend=KernelAbstractions.get_backend(mem[1]))
+    return ka_diamond!(t, t′, N; backend = KernelAbstractions.get_backend(mem[1]))
 end
 
 # rotation of tilings
@@ -129,10 +129,10 @@ end
     edge = NONE
     if @inbounds t.x[i, j] == RIGHT
         edge = UP
-    elseif get(t, (i-1, j), NONE) == UP
+    elseif get(t, (i - 1, j), NONE) == UP
         edge = RIGHT
     end
-    @inbounds t′.x[j, 1-i] = edge
+    @inbounds t′.x[j, 1 - i] = edge
 end
 
 @kernel function rotl90_kernel!(t′::Tiling, @Const(t::Tiling))
@@ -143,10 +143,10 @@ end
     edge = NONE
     if @inbounds t.x[i, j] == UP
         edge = RIGHT
-    elseif get(t, (i, j-1), NONE) == RIGHT
+    elseif get(t, (i, j - 1), NONE) == RIGHT
         edge = UP
     end
-    @inbounds t′.x[1-j, i] = edge
+    @inbounds t′.x[1 - j, i] = edge
 end
 
 @kernel function rot180_kernel!(t′::Tiling, @Const(t::Tiling))
@@ -155,20 +155,20 @@ end
     i, j = I .- N
 
     edge = NONE
-    if get(t, (i-1, j), NONE) == UP
+    if get(t, (i - 1, j), NONE) == UP
         edge = UP
-    elseif get(t, (i, j-1), NONE) == RIGHT
+    elseif get(t, (i, j - 1), NONE) == RIGHT
         edge = RIGHT
     end
-    @inbounds t′.x[1-i, 1-j] = edge
+    @inbounds t′.x[1 - i, 1 - j] = edge
 end
 
 for rot in Symbol.(:rot, ["r90", "l90", "180"])
     @eval function Base.$rot(t::Tiling)
         (; N, x) = t
         t′ = Tiling(N, similar(x))
         backend = KernelAbstractions.get_backend(t)
-        $(Symbol(rot, :_kernel!))(backend)(t′, t; ndrange=(2N, 2N))
+        $(Symbol(rot, :_kernel!))(backend)(t′, t; ndrange = (2N, 2N))
         return t′
     end
 end

src/makie.jl

@@ -1,30 +1,30 @@
 using MakieCore
 using GeometryBasics: Vec2f, Point2f, Rect2f
 
-function prepare_plot(t::Tiling; pad=.1f0)
+function prepare_plot(t::Tiling; pad = 0.1f0)
     tiles = Rect2f[]
     colors = RGB{Colors.N0f8}[]
     arrow_pts, arrows = Point2f[], Vec2f[]
     foreach(faces(t)) do (i, j, isdotted)
         if t[i, j] == UP
-            r = Rect2f(j-1+pad, i-1+pad, 1-2pad, 2-2pad)
+            r = Rect2f(j - 1 + pad, i - 1 + pad, 1 - 2pad, 2 - 2pad)
             col = isdotted ? colorant"red" : colorant"green"
             push!(tiles, r)
             push!(colors, col)
-            off = isdotted ? -.3f0 : .3f0
-            push!(arrow_pts, Point2f(j-.5f0-off, i))
-            push!(arrows, Point2f(isdotted ? -.5f0 : .5f0, 0))
+            off = isdotted ? -0.3f0 : 0.3f0
+            push!(arrow_pts, Point2f(j - 0.5f0 - off, i))
+            push!(arrows, Point2f(isdotted ? -0.5f0 : 0.5f0, 0))
         elseif t[i, j] == RIGHT
-            r = Rect2f(j-1+pad, i-1+pad, 2-2pad, 1-2pad)
+            r = Rect2f(j - 1 + pad, i - 1 + pad, 2 - 2pad, 1 - 2pad)
             col = isdotted ? colorant"yellow" : colorant"blue"
             push!(tiles, r)
             push!(colors, col)
-            off = isdotted ? -.3f0 : .3f0
-            push!(arrow_pts, Point2f(j, i-.5f0-off))
-            push!(arrows, Point2f(0, isdotted ? -.5f0 : .5f0))
+            off = isdotted ? -0.3f0 : 0.3f0
+            push!(arrow_pts, Point2f(j, i - 0.5f0 - off))
+            push!(arrows, Point2f(0, isdotted ? -0.5f0 : 0.5f0))
         end
     end
-    tiles, colors, arrow_pts, arrows
+    return tiles, colors, arrow_pts, arrows
 end
 
 MakieCore.@recipe(TilingPlot, t) do scene
@@ -39,8 +39,8 @@ MakieCore.plottype(::Tiling) = TilingPlot
 
 function MakieCore.plot!(x::TilingPlot{<:Tuple{Tiling}})
     t = adapt(Array, x[:t][])
-    tiles, colors, arrow_pts, arrows = prepare_plot(t; pad=x.domino_padding[])
-    poly!(x, tiles; color=colors, strokewidth=x.domino_stroke)
+    tiles, colors, arrow_pts, arrows = prepare_plot(t; pad = x.domino_padding[])
+    poly!(x, tiles; color = colors, strokewidth = x.domino_stroke)
     x.show_arrows[] && arrows!(x, arrow_pts, arrows)
-    x
+    return x
 end