Paper plot (#24)

* initial

* paper plot

* update\

Author: GiggleLiu

.gitignore

@@ -1,4 +1,8 @@
 /.vscode/
 /Manifest.toml
 .DS_Store
-_local/
+_local/
+*.aux
+*.fls
+*.log
+*.fdb_latexmk

flowchart.pdf

@@ -0,0 +1,28 @@
+using UnitDiskMapping.TikzGraph
+
+function routine(centerx, centery, width, height, text; kwargs...)
+    Node(centerx, centery, shape="rectangle", rounded_corners = "0.5ex", minimum_width="$(width)cm", minimum_height="$(height)cm", line_width="1pt", minimum_size="", text=text, kwargs...)
+end
+
+# aspect = width/height
+function decision(centerx, centery, width, height, text; kwargs...)
+    Node(centerx, centery, shape="diamond", minimum_size="$(height)cm", aspect=width/height, text=text, line_width="1pt", kwargs...)
+end
+
+function arrow(nodes...; kwargs...)
+    Line(nodes...; arrow="->", line_width="1pt", kwargs...)
+end
+
+function draw_flowchart()
+    canvas(libs=["shapes"]) do c
+        n1 = routine(0.0, 0.0, 3, 1, "input graph") >> c
+        n2 = decision(0.0, -3, 3, 1, "satisfies the crossing criteria") >> c
+        n3 = decision(0.0, -6, 3, 1, "has a same tropical tensor") >> c
+        arrow(n1, n2) >> c
+        arrow(n2, n3; annotate="T") >> c
+        arrow(n2, (3.0, -3.0), (3.0, 0.0), n1; annotate="F") >> c
+    end
+end
+
+write("_local/flowchart.tex", draw_flowchart())
+run(`latexmk -pdf _local/flowchart.tex`)

project/viz_flowchart.jl

@@ -25,9 +25,9 @@ function viz_gadget(p::Pattern)
     dx2, dy2 = xmid+1, 0
     return canvas(; props=Dict("scale"=>"0.8")) do c
         BoundingBox(-1,Wx-1,-1,Wy-1) >> c
-        Mesh(dx1, Gx+dx1-1, dy1, Gy+dy1-1; step="1cm", draw=rgbcolor!(c, 100,200,200), line_width=0.5) >> c
+        Mesh(dx1, Gx+dx1-1, dy1, Gy+dy1-1; step="1cm", draw=rgbcolor!(c, 200,200,200), line_width=0.5) >> c
         command_graph!(c, locs1, g1, pin1, dx1, dy1, 0.3, "s")
-        Mesh(dx2, Gx+dx2-1, dy2, Gy+dy2-1; step="1cm", draw=rgbcolor!(c, 200,100,100), line_width=0.03) >> c
+        Mesh(dx2, Gx+dx2-1, dy2, Gy+dy2-1; step="1cm", draw=rgbcolor!(c, 200,200,200), line_width=0.03) >> c
         command_graph!(c, locs2, g2, pin2, dx2, dy2, 0.3, "d")
         PlainText(xmid, ymid, "\$\\mathbf{\\rightarrow}\$") >> c
     end

project/vizgadget.jl

@@ -318,16 +318,16 @@ function crossat(ug::UGrid, v, w)
 end
 
 """
-    embed_graph([mode,] g::SimpleGraph; vertex_order=Greedy())
+    embed_graph([mode,] g::SimpleGraph; vertex_order=Branching())
 
 Embed graph `g` into a unit disk grid, where the optional argument `mode` can be `Weighted()` or `UnWeighted`.
 The `vertex_order` can be a vector or one of the following inputs
 
     * `Greedy()` fast but non-optimal.
     * `Branching()` slow but optimal.
 """
-embed_graph(g::SimpleGraph; vertex_order=Greedy()) = embed_graph(UnWeighted(), g; vertex_order)
-function embed_graph(mode, g::SimpleGraph; vertex_order=Greedy())
+embed_graph(g::SimpleGraph; vertex_order=Branching()) = embed_graph(UnWeighted(), g; vertex_order)
+function embed_graph(mode, g::SimpleGraph; vertex_order=Branching())
     if vertex_order isa AbstractVector
         L = PathDecomposition.Layout(g, collect(vertex_order))
     else
@@ -356,7 +356,7 @@ struct MappingResult{CT,WT}
 end
 
 """
-    map_graph([mode=Weighted(),] g::SimpleGraph; vertex_order=Greedy(), ruleset=[...])
+    map_graph([mode=Weighted(),] g::SimpleGraph; vertex_order=Branching(), ruleset=[...])
 
 Map a graph to a unit disk grid graph that being "equivalent" to the original graph.
 Here "equivalent" means a maximum independent set in the grid graph can be mapped back to
@@ -373,10 +373,10 @@ It can be a vector or one of the following inputs
 
 Returns a `MappingResult` instance.
 """
-function map_graph(g::SimpleGraph; vertex_order=Greedy(), ruleset=default_simplifier_ruleset(UnWeighted()))
+function map_graph(g::SimpleGraph; vertex_order=Branching(), ruleset=default_simplifier_ruleset(UnWeighted()))
     map_graph(UnWeighted(), g; ruleset=ruleset, vertex_order=vertex_order)
 end
-function map_graph(mode, g::SimpleGraph; vertex_order=Greedy(), ruleset=default_simplifier_ruleset(mode))
+function map_graph(mode, g::SimpleGraph; vertex_order=Branching(), ruleset=default_simplifier_ruleset(mode))
     ug = embed_graph(mode, g; vertex_order=vertex_order)
     mis_overhead0 = mis_overhead_copylines(ug)
     ug, tape = apply_crossing_gadgets!(mode, ug)
@@ -388,4 +388,4 @@ end
 
 map_configs_back(r::MappingResult{<:Cell}, configs::AbstractVector) = unapply_gadgets!(copy(r.grid_graph), r.mapping_history, copy.(configs))[2]
 default_simplifier_ruleset(::UnWeighted) = vcat([rotated_and_reflected(rule) for rule in simplifier_ruleset]...)
-default_simplifier_ruleset(::Weighted) = weighted.(default_simplifier_ruleset(UnWeighted()))
+default_simplifier_ruleset(::Weighted) = weighted.(default_simplifier_ruleset(UnWeighted()))

src/mapping.jl

@@ -1,28 +1,33 @@
 module TikzGraph
-export rgbcolor!, Node, Line, BoundingBox, Mesh, Canvas, >>, command, canvas, generate_standalone, StringElement, PlainText
+export rgbcolor!, Node, Line, BoundingBox, Mesh, Canvas, >>, command, canvas, generate_standalone, StringElement, PlainText, uselib!
+export Cycle, Controls, annotate, Annotate, autoid!, vizgraph!
 
 const instance_counter = Ref(0)
 abstract type AbstractTikzElement end
 
 struct Canvas
     header::String
+    libs::Vector{String}
     colors::Dict{String, Tuple{Int,Int,Int}}
     contents::Vector{AbstractTikzElement}
     props::Dict{String,String}
 end
 
-function canvas(f; header="", colors=Dict{String,Tuple{Int,Int,Int}}(), props=Dict{String,String}())
-    canvas = Canvas(header, colors, AbstractTikzElement[], props)
+function canvas(f; header="", libs=String[], colors=Dict{String,Tuple{Int,Int,Int}}(), props=Dict{String,String}())
+    canvas = Canvas(header, libs, colors, AbstractTikzElement[], props)
     f(canvas)
     return canvas
 end
 
-Base.:(>>)(element::AbstractTikzElement, canvas::Canvas) = push!(canvas.contents, element)
-Base.:(>>)(element::String, canvas::Canvas) = push!(canvas.contents, StringElement(element))
+Base.:(>>)(element::AbstractTikzElement, canvas::Canvas) = (push!(canvas.contents, element); element)
+Base.:(>>)(element::String, canvas::Canvas) = (push!(canvas.contents, StringElement(element)); element)
 
+function uselib!(canvas::Canvas, lib::String)
+    push!(canvas.libs, lib)
+    return lib
+end
 function rgbcolor!(canvas::Canvas, red::Int, green::Int, blue::Int)
-    instance_counter[] += 1
-    colorname = "color$(instance_counter[])"
+    colorname = "color$(autoid!())"
     canvas.colors[colorname] = (red,green,blue)
     return colorname
 end
@@ -56,7 +61,7 @@ end
 
 function Node(x, y;
         shape::String = "circle",
-        id = string((instance_counter[] += 1; instance_counter[])), 
+        id = autoid!(),
         text::String = "",
         fill = "none",
         draw = "black",
@@ -73,12 +78,13 @@ function Node(x, y;
         kwargs...)
     return Node(x, y, shape, id, text, props)
 end
+autoid!() = string((instance_counter[] += 1; instance_counter[]))
 function build_props(; kwargs...)
     Dict([replace(string(k), "_"=>" ")=>string(v) for (k,v) in kwargs])
 end
 
 function command(node::Node)
-    return "\\node[$(node.shape), $(command(node.props))] at ($(node.x), $(node.y)) ($(node.id)) {$(node.text)};"
+    return "\\node[$(parse_args([string(node.shape)], node.props))] at ($(node.x), $(node.y)) ($(node.id)) {$(node.text)};"
 end
 
 struct Mesh <: AbstractTikzElement
@@ -93,28 +99,52 @@ function Mesh(xmin, xmax, ymin, ymax; step="1.0cm", draw="gray", line_width=0.03
     Mesh(xmin, xmax, ymin, ymax, build_props(; step=step, draw=draw, line_width=line_width, kwargs...))
 end
 function command(grid::Mesh)
-    return "\\draw[$(command(grid.props))] ($(grid.xmin),$(grid.ymin)) grid ($(grid.xmax),$(grid.ymax));"
+    return "\\draw[$(parse_args(String[], grid.props))] ($(grid.xmin),$(grid.ymin)) grid ($(grid.xmax),$(grid.ymax));"
 end
 
-struct Line <: AbstractTikzElement
-    src::String
-    dst::String
-    controls::Vector{Int}
-    props::Dict{String,String}
+struct Cycle end
+struct Controls
+    start::String
+    controls::Vector{String}
+    stop::String
+    Controls(start, c1, stop) = new(parse_path(start), [parse_path(c1)], parse_path(stop))
+    Controls(start, c1, c2, stop) = new(parse_path(start), [parse_path(c1), parse_path(c2)], parse_path(stop))
 end
 
-function Line(src, dst; controls=Int[], line_width = "0.03", kwargs...)
-    Line(string(src), string(dst), controls, build_props(; line_width=line_width, kwargs...))
+struct Annotate
+    args::Vector{String}   # e.g. "[midway, above]"
+    id::String
+    text::String
 end
-Line(src::Node, dst::Node; kwargs...) = Line(src.id, dst.id)
+Base.isempty(ann::Annotate) = isempty(ann.text)
 
+# arrow styles: https://latexdraw.com/exploring-tikz-arrows/
+# line styles: https://tex.stackexchange.com/questions/45275/tikz-get-values-for-predefined-dash-patterns
+struct Line <: AbstractTikzElement
+    path::Vector{String}
+    arrow::String
+    line_style::String
+    annotate::Annotate
+    props::Dict{String,String}
+end
+function Line(path...; annotate::Union{String,Annotate}="", arrow::String="", line_width = "0.03", line_style="", kwargs...)
+    ann = annotate isa String ? Annotate(["midway", "above", "sloped"], "", annotate) : annotate
+    Line(collect(parse_path.(path)), arrow, line_style, ann, build_props(; line_width=line_width, kwargs...))
+end
+parse_path(t::Tuple) = "$(t)"
+parse_path(n::Node) = "($(n.id))"
+parse_path(s::String) = "($s)"
+parse_path(s::Cycle) = "cycle"
+function parse_path(c::Controls)
+    "$(c.start) .. controls $(join(["$c" for c in c.controls], " and ")) .. $(c.stop)"
+end
 function command(edge::Line)
-    head = "\\draw[$(command(edge.props))]"
-    if isempty(edge.controls)
-        return "$head ($(edge.src)) -- ($(edge.dst));"
-    else
-        return "$head ($(edge.src)) .. controls $(join(["($c)" for c in edge.controls], " and ")) .. ($(edge.dst));"
-    end
+    head = "\\draw[$(parse_args([edge.arrow, edge.line_style], edge.props))]"
+    path = join(edge.path, " -- ")
+    ann = edge.annotate
+    isempty(ann) && return "$head $path;"
+    annotate = "node [$(parse_args(ann.args, Dict{String,String}()))] ($(ann.id)) {$(ann.text)}"
+    return "$head $path $annotate;"
 end
 
 struct PlainText <: AbstractTikzElement
@@ -127,28 +157,47 @@ function PlainText(x, y, text; kwargs...)
     PlainText(x, y, text, build_props(; kwargs...))
 end
 function command(text::PlainText)
-    "\\node[$(command(text.props))] at ($(text.x), $(text.y)) {$(text.text)};"
+    "\\node[$(parse_args(String[], text.props))] at ($(text.x), $(text.y)) {$(text.text)};"
 end
 
-function command(node::Dict)  # properties
-    return join(["$k=$v" for (k,v) in node], ", ")
+annotate(node::Node, text; offsetx=0, offsety=0, kwargs...) = PlainText(node.x+offsetx, node.y+offsety, text; kwargs...)
+
+function parse_args(args::Vector, kwargs::Dict)  # properties
+    return join(filter(!isempty, [args..., ["$k=$v" for (k,v) in kwargs if !isempty(v)]...]), ", ")
 end
 
-function generate_standalone(header::String, props::Dict, content::String)
+function generate_standalone(libs::Vector, header::String, props::Dict, content::String)
     return """
 \\documentclass[crop,tikz]{standalone}
+$(join(["\\usepgflibrary{$lib}" for lib in libs], "\n"))
 $(header)
 \\begin{document}
-\\begin{tikzpicture}[$(command(props))]
+\\begin{tikzpicture}[$(parse_args(String[], props))]
 $content
 \\end{tikzpicture}
 \\end{document}
 """
 end
-generate_standalone(canvas::Canvas) = generate_standalone(canvas.header, canvas.props, join([[generate_rgbcolor(k,v...) for (k,v) in canvas.colors]..., command.(canvas.contents)...], "\n"))
+generate_standalone(canvas::Canvas) = generate_standalone(canvas.libs, canvas.header, canvas.props, join([[generate_rgbcolor(k,v...) for (k,v) in canvas.colors]..., command.(canvas.contents)...], "\n"))
 
 function Base.write(io::IO, canvas::Canvas)
     write(io, generate_standalone(canvas))
 end
 
-end
+function vizgraph!(c::Canvas, locations::AbstractVector, edges; fills=fill("black", length(locations)),
+        texts=fill("", length(locations)), ids=[autoid!() for i=1:length(locations)], minimum_size="0.4cm",
+        draw="", line_width="1pt", edgecolors=fill("black", length(edges)))
+    nodes = Node[]
+    lines = Line[]
+    for i=1:length(locations)
+        n = Node(locations[i]...; fill=fills[i], minimum_size=minimum_size, draw=draw, id=ids[i], text=texts[i]) >> c
+        push!(nodes, n)
+    end
+    for (k, (i, j)) in enumerate(edges)
+        l = Line(nodes[i], nodes[j], line_width=line_width, draw=edgecolors[k]) >> c
+        push!(lines, l)
+    end
+    return nodes, lines
+end
+
+end

src/tikz/tikz.jl

@@ -5,7 +5,7 @@ using UnitDiskMapping.TikzGraph, Test
     @test command(n) isa String
     m = Node(0.6, 0.5)
     @test command(n) isa String
-    l = Line(m, n)
+    l = Line(m, Controls(m, (0.3, 0.4), n), Controls(m, (0.2, 0.3), (0.3, 0.4), n), n, Cycle(); arrow="->", annotate="A")
     @test command(n) isa String
     b = BoundingBox(0, 10, 0, 10)
     @test command(b) isa String
@@ -15,6 +15,8 @@ using UnitDiskMapping.TikzGraph, Test
     @test command(s) == "jajaja"
     s = PlainText(20.0, 3.0, "jajaja")
     @test command(s) isa String
+    a = annotate(n, "jajaja"; offsetx=0.1, offsety=0.2)
+    @test command(a) isa String
 end
 
 @testset "canvas" begin