feat: generalized grid and line types

Author: jaantollander

scripts/plot_docs.jl

@@ -27,7 +27,10 @@ function plot_line_types(grid)
             end
         end
     end
-    plt = (canvas(; size = (200, 200)), canvas(; size = (200, 200)))
+    plt = (
+        canvas(; size = (200, 200), backgroud = :lightgray),
+        canvas(; size = (200, 200), backgroud = :lightgray)
+    )
     plot_lines!(plt[1], lines[1], colors[1]; linewidth = 3)
     plot_lines!(plt[2], lines[2], colors[2]; linewidth = 3)
     plot_lines!(plt[1], lines2[1], colors2[1]; linewidth = 3, linestyle = :dash)
@@ -41,9 +44,9 @@ grid = Grid(5)
 pattern = (shuffle(1:length(grid)), shuffle(1:length(grid)))
 
 begin
-    plt = canvas(; size = (200, 200))
+    plt = canvas(; size = (200, 200), backgroud = :lightgray)
     plot_grid!(plt, grid; marker = :circle, color = :black, markersize = 5)
-    savefig(plot_grid(grid), "docs/src/plots/grid.svg")
+    savefig(plt, "docs/src/plots/grid.svg")
 end
 
 begin
@@ -53,7 +56,9 @@ begin
 end
 
 for i = 1:2
-    plt = canvas(size = (200, 200))
+    plt = canvas(size = (200, 200), backgroud = :lightgray)
     plot_lock_pattern!(plt, grid, pattern[i])
     savefig(plt, "docs/src/plots/lock_pattern_$i.svg")
 end
+
+# TODO: symmetries

src/functions.jl

@@ -1,6 +1,6 @@
 ## --- Grid ---
 
-# TODO: generalize for arbitrary grids
+# TODO: generalize for arbitrary rectangular grids
 
 """Two-dimensional grid."""
 struct Grid
@@ -11,12 +11,14 @@ end
 
 Base.length(grid::Grid) = prod(grid.n)
 
-function Grid(n::Int)
-    x = [i for i = 1:n for _ = 1:n]
-    y = [j for _ = 1:n for j = 1:n]
-    Grid(x, y, (n, n))
+function Grid(n::Tuple{Int,Int})
+    x = [i for i = 1:n[1] for _ = 1:n[2]]
+    y = [j for _ = 1:n[1] for j = 1:n[2]]
+    Grid(x, y, n)
 end
 
+Grid(n::Int) = Grid((n, n))
+
 
 ## --- Line Types ---
 
@@ -31,29 +33,23 @@ Base.length(t::LineTypes) = length(t.k)
 """Generate all `x` and `y` differences and their multiple `k` 
 that represent each line type in a grid."""
 function LineTypes(grid::Grid)
-    (n, _) = grid.n
-    xs = Int[0, 1, 1, 1]
-    ys = Int[1, 0, 1, -1]
-    ks = Int[n-1, n-1, n-1, n-1]
-    for x = 1:n-2
-        for y = (x+1):n-1
-            if gcd(x, y) == 1
-                k = div(n - 1, y)
-                # 1
-                push!(xs, x)
-                push!(ys, y)
-                push!(ks, k)
-                # 2
-                push!(xs, y)
-                push!(ys, x)
-                push!(ks, k)
-                # 3
-                push!(xs, x)
-                push!(ys, -y)
+    n = grid.n
+    dx_max = n[1] -1
+    dy_max = n[2] -1
+    xs = Int[0, 1]
+    ys = Int[1, 0]
+    ks = Int[dx_max, dy_max]
+    for dx = 1:dx_max
+        for dy = 1:dy_max
+            if gcd(dx, dy) == 1
+                k = min(div(dx_max, dx), div(dy_max, dy))
+                # Increasing y
+                push!(xs, dx)
+                push!(ys, dy)
                 push!(ks, k)
-                # 4
-                push!(xs, y)
-                push!(ys, -x)
+                # Decreasing y
+                push!(xs, dx)
+                push!(ys, -dy)
                 push!(ks, k)
             end
         end

src/plots.jl

@@ -1,13 +1,8 @@
 using Plots
 
-function canvas(; size=(400, 400), backgroud=:lightgray)
-    plot(;
-        xticks = :none,
-        yticks = :none,
-        legend = false,
-        axis = false,
-        size = size,
-        background = backgroud)
+"""Plot """
+function canvas(; kwargs...)
+    plot(; xticks = :none, yticks = :none, legend = false, axis = false, kwargs...)
 end
 
 """Create unique color for all line types in the grid."""
@@ -53,7 +48,7 @@ function create_plots(n::Int, path::AbstractString, directory::AbstractString; l
         if distance ≥ limit
             root = mkpath(joinpath(directory, "$(join(grid.n, "x"))", "$(distance)"))
             for pattern in patterns
-                plt = canvas()
+                plt = canvas(; size=(400, 400), backgroud=:lightgray)
                 plot_lock_pattern!(plt, grid, pattern)
                 savefig(plt, joinpath(root, "$(hash(pattern)).svg"))
             end

test/runtests.jl

@@ -11,6 +11,5 @@ using Test
     tmp = mktempdir()
     create_instance(3, tmp)
     extract_solutions(joinpath(@__DIR__, "output"))
-
     @test true
 end