default to plotting a single classical line for all bits (#26)

Author: Krastanov

.github/workflows/ci.yml

@@ -14,8 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
-          - '1.9'
+          - '1.11'
           - '1'
         os:
           - ubuntu-latest

.github/workflows/downgrade.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ['1.9']
+        version: ['1.11']
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1

Project.toml

@@ -1,7 +1,7 @@
 name = "Quantikz"
 uuid = "b0d11df0-eea3-4d79-b4a5-421488cbf74b"
 authors = ["Stefan Krastanov <[email protected]>"]
-version = "1.3.1"
+version = "1.4.0"
 
 [deps]
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
@@ -15,5 +15,5 @@ tectonic_jll = "d7dd28d6-a5e6-559c-9131-7eb760cdacc5"
 FileIO = "1.6"
 Ghostscript_jll = "9.53"
 ImageMagick = "1.1"
-julia = "1.6"
+julia = "1.11"
 tectonic_jll = "0.11"

src/Quantikz.jl

@@ -4,6 +4,7 @@ A module for drawing quantum circuits through the Quantikz latex package.
 module Quantikz
 
 using Base.Filesystem
+using Base.ScopedValues: @with, ScopedValue
 using Pkg.Artifacts
 
 using FileIO
@@ -25,11 +26,15 @@ export MultiControl, CNOT, CPHASE, SWAP, H, P, Id, U,
        string2image,
        circuit2image,
        displaycircuit,
-       savecircuit
+       savecircuit,
+       @with, ScopedValue
 
 const quantikzname = "tikzlibraryquantikz.code.tex"
 const quantikzfile = joinpath(artifact"quantikz", "quantikz", quantikzname)
 
+const classicalbitslayout = ScopedValue(:compressed)
+classicalbitslayout_error() = error("`classicalbitslayout` config variable has to be either `:expanded` or `:complressed`. Instead it is `$(classicalbitslayout[])`")
+
 # This is necessary because typeof(ibegin:iend) <: AbstractRange is false
 const ArrayOrRange = Union{A,B,C} where {A<:AbstractVector, B<:EndpointRanges.EndpointUnitRange, C<:EndpointRanges.EndpointStepRange}
 
@@ -237,10 +242,19 @@ Measurement(is::ArrayOrRange, b::Integer) = Measurement("\\;\\;", is, b)
 affectedqubits(m::Measurement) = m.targets
 function update_table!(qtable,step,meas::Measurement)
     table = qubitsview(qtable)
+    layoutbit = if isnothing(meas.bit)
+        nothing
+    elseif classicalbitslayout[] == :expanded
+        meas.bit
+    elseif classicalbitslayout[] == :compressed
+        1
+    else
+        classicalbitslayout_error()
+    end
     if length(meas.targets) == 1
         table[meas.targets[1],step] = "\\meterD{$(meas.str)}"
-        if !isnothing(meas.bit)
-            bitsview(qtable)[meas.bit,step] = "\\cwbend{$(-(qtable.qubits-meas.targets[1])-qtable.ancillaries-meas.bit)}"
+        if !isnothing(layoutbit)
+            bitsview(qtable)[layoutbit,step] = "\\cwbend{$(-(qtable.qubits-meas.targets[1])-qtable.ancillaries-layoutbit)}"
         end
     else
         step = step+1
@@ -250,8 +264,8 @@ function update_table!(qtable,step,meas::Measurement)
         ancillaryview(qtable)[1,step-1] = "\\lstick{}"
         ancillaryview(qtable)[1,step] = "\\ctrl{$(M-qtable.qubits-1)}"
         ancillaryview(qtable)[1,step+1] = "\\meterD{}"
-        if !isnothing(meas.bit)
-            bitsview(qtable)[meas.bit,step+1] = "\\cwbend{$(1-qtable.ancillaries-meas.bit)}"
+        if !isnothing(layoutbit)
+            bitsview(qtable)[layoutbit,step+1] = "\\cwbend{$(1-qtable.ancillaries-layoutbit)}"
         end
     end
     qtable
@@ -311,16 +325,23 @@ affectedbits(g::ClassicalDecision) = g.bits
 function update_table!(qtable,step,g::ClassicalDecision)
     qvtable = qubitsview(qtable)
     bvtable = bitsview(qtable)
-    bits = explicit_targets(bvtable, g.bits)
-    startpoint = minimum(bits)
+    actualbits = explicit_targets(bvtable, g.bits)
+    layoutbits = if classicalbitslayout[] == :expanded
+        actualbits
+    elseif classicalbitslayout[] == :compressed
+        [1]
+    else
+        classicalbitslayout_error()
+    end
+    startpoint = minimum(layoutbits)
     if !isa(g.targets,AbstractVector) || length(g.targets)>0
         m, M = explicit_extrema(qvtable, g.targets)
         draw_rectangle!(qvtable,step,g.targets,g.str)
         bvtable[startpoint,step] = "\\cwbend{$(-(qtable.qubits-M)-qtable.ancillaries-startpoint)}"
     else
         bvtable[startpoint,step] = "\\cwbend{0}"
     end
-    for b in sort(bits)[2:end]
+    for b in sort(layoutbits)[2:end]
         bvtable[b,step] = "\\cwbend{$(startpoint-b)}"
         startpoint = b
     end
@@ -391,13 +412,23 @@ function circuit2table_expanded(circuit, qubits)
         qubitsview(table)[affectedqubits(op),current_step:end] .= "\\qw"
         qubitsview(table)[deleteoutputs(op),current_step:end] .= ""
     end
-    return table
+    layoutbits = if classicalbitslayout[] == :expanded
+        table.bits
+    elseif classicalbitslayout[] == :compressed
+        1
+    else
+        classicalbitslayout_error()
+    end
+    cutoff = table.qubits+table.ancillaries+layoutbits
+    return QuantikzTable(table.table[begin:cutoff,:], table.qubits, table.ancillaries, layoutbits)
 end
 
+"""Turn implicit endpoints to explicit integer indices and take the extrema"""
 function explicit_extrema(table,r)
     t = explicit_targets(table,r)
     isempty(t) ? t : extrema(t)
 end
+"""Turn implicit endpoints to explicit integer indices"""
 function explicit_targets(table,targets)
     targets = (1:size(table,1))[targets]
 end
@@ -412,6 +443,7 @@ function circuit2table_compressed(circuit, qubits)
     filled_up_to = fill(1+PADDING,qubits)
     afilled_up_to = fill(1+PADDING,table.ancillaries)
     bfilled_up_to = fill(1+PADDING,table.bits)
+    maxbit = 0
     for op in circuit
         qubits = extrema2range(explicit_extrema(qvtable, affectedqubits(op)))
         if circuitwidthbits(op)!=0 || neededancillaries(op)!=0
@@ -422,20 +454,29 @@ function circuit2table_compressed(circuit, qubits)
             end
         end
         bits = extrema2range(explicit_extrema(bvtable, affectedbits(op)))
+        layoutbits = if isempty(bits) || classicalbitslayout[] == :expanded
+            bits
+        elseif classicalbitslayout[] == :compressed
+            [1]
+        else
+            classicalbitslayout_error()
+        end
+        maxbit = max(maxbit, layoutbits...)
         ancillaries = neededancillaries(op)
         steps = nsteps(op)
         current_step = maximum([filled_up_to[qubits]...,afilled_up_to[1:ancillaries]...,bfilled_up_to[bits]...])
         filled_up_to[qubits] .= current_step+steps
         afilled_up_to[1:ancillaries] .= current_step+steps
         if circuitwidthbits(op)!=0
             filled_up_to[qubits.stop:end] .= current_step+steps
-            bfilled_up_to[bits] .= current_step+steps
+            bfilled_up_to[layoutbits] .= current_step+steps
         end
         qvtable[affectedqubits(op),current_step:end] .= "\\qw"
         qvtable[deleteoutputs(op),current_step:end] .= ""
         update_table!(table,current_step,op)
     end
-    return QuantikzTable(table.table[:,1:maximum(filled_up_to)-1+PADDING],table.qubits,table.ancillaries,table.bits)
+    cutoff = table.qubits+table.ancillaries+maxbit
+    return QuantikzTable(table.table[begin:cutoff,1:maximum(filled_up_to)-1+PADDING],table.qubits,table.ancillaries,maxbit)
 end
 
 function circuit2table(circuit, qubits; mode=:compressed, kw...)

test/runtests.jl

@@ -1,8 +1,9 @@
-using Quantikz, Test
+using Test
+using Quantikz
 using Quantikz.VendoredEndpointRanges
 const EndpointRanges = VendoredEndpointRanges
 
-function stringtests()
+function classical_expanded_stringtests()
 @testset "Misc string conversions" begin
 circuit = [
            CNOT(1,2),CPHASE(2,3),
@@ -173,5 +174,13 @@ function filetests()
 end
 end
 
-stringtests()
+function classical_compressed_stringtests()
+    @testset "Misc string conversions" begin
+        circuit = [CNOT(1,2), Measurement(1,1), Measurement(1,2), ClassicalDecision([1,2,4],[1,2,4]), ClassicalDecision(1,1), ClassicalDecision(2,2), Measurement([1,2],3)]
+        @test circuit2string(circuit, mode=:expanded) == "\\begin{quantikz}[transparent, row sep={0.8cm,between origins}]\n\\qw & \\ctrl{0} & \\meterD{} & \\meterD{} & \\gate[4,disable auto height]{\\;\\;} & \\gate[1]{\\;\\;} & \\qw & \\qw & \\gate[2,disable auto height]{\\;\\;} & \\qw & \\qw\\\\\n\\qw & \\targ{}\\vqw{-1} & \\qw & \\qw & \\qw & \\qw & \\gate[1]{\\;\\;} & \\qw & \\qw & \\qw & \\qw\\\\\n\\qw & \\qw & \\qw & \\qw & \\linethrough & \\qw & \\qw & \\qw & \\qw & \\qw & \\qw\\\\\n\\qw & \\qw & \\qw & \\qw & \\qw & \\qw & \\qw & \\qw & \\qw & \\qw & \\qw\\\\\n &  &  &  &  &  &  & \\lstick{} & \\ctrl{-3} & \\meterD{} & \\\\\n\\cw & \\cw & \\cwbend{-5} & \\cwbend{-5} & \\cwbend{-2} & \\cwbend{-5} & \\cwbend{-4} & \\cw & \\cw & \\cwbend{-1} & \\cw\n\\end{quantikz}"
+    end
+end
+
+@with Quantikz.classicalbitslayout=>:expanded classical_expanded_stringtests()
+classical_compressed_stringtests()
 filetests()