summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/yquant/doc/yquant-doc.tex
blob: cf32f913e66a721814dec12e84712f51b79d83d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
\documentclass{scrartcl}

\title{yquant.sty package documentation}
\subtitle{Typesetting quantum circuits in a human-readable language}
\author{Benjamin Desef}

% BEGIN_FOLD Packages
\RequirePackage{fontspec}
\setmainfont{XCharter}[Scale=.98]
\RequirePackage[osf, semibold]{sourcesanspro}
\RequirePackage[math-style=ISO, bold-style=ISO, sans-style=italic]{unicode-math}

\usepackage{xcolor}
\definecolor{darkblue}{RGB}{5, 10, 122}
\usepackage[english]{babel}
\usepackage[colorlinks, linkcolor=darkblue, bookmarksdepth=paragraph]{hyperref}
\usepackage{yquant,braket,hyphenat,microtype,hologo,minted,import}
\usetikzlibrary{quotes,fit,shapes.symbols,backgrounds,quantikz}
\useyquantlanguage{qasm}
\usepackage{amsmath,adjustbox,cleveref}
\usepackage[framemethod=tikz]{mdframed}
% END_FOLD

\makeatletter

% BEGIN_FOLD Minted configuration
\begingroup
\catcode`\&=11
% I use Intel Python, which requires using the `activate' command first
\renewcommand{\MintedPygmentize}{activate && pygmentize}
\endgroup

\definecolor{boxGrayBody}{gray}{.94}
\definecolor{boxRedHead} {RGB} {178, 34,  34}
\definecolor{boxRedBody} {RGB} {255, 255, 192}
\definecolor{boxBlueHead}{RGB} {118, 152, 199}
\definecolor{boxBlueBody}{RGB} {242, 247, 255}
\definecolor{mintgreen}  {RGB} {11,  97,  11}
\setminted{frame=none, linenos=false, fontsize=\footnotesize, breaklines, bgcolor=boxGrayBody}
\setmintedinline{bgcolor={}, fontsize=}

\newmintinline[yquant]{text}{}
\newmintinline[tex]{tex}{}
\newmintinline[ebnf]{ebnf}{}
% END_FOLD

% BEGIN_FOLD Block environments (options, code examples, ...)
\def\unskipOpt{\vskip-5mm }
\let\unpatched@minted@inline@iii=\minted@inline@iii%
\def\patched@minted@inline@iii#1{%
   \unpatched@minted@inline@iii{#1}%
   \par%
   \endgroup\vskip-\parskip%
   \noindent\ignorespaces%
}
\newenvironment{option*}[2]{\vskip5mm%
   \noindent\begin{minipage}[t]{\linewidth}%
      \begingroup%
         \let\minted@inline@iii=\patched@minted@inline@iii%
         \raggedleft%
         \hspace*{-1cm}%
         \phantomsection\label{style:/#1/#2}%
         \texttt{\textcolor{gray}{/#1/}\textcolor{mintgreen}{#2}}\hfill default: %
         \tex}{%
   \end{minipage}}
\newenvironment{option}{\csname option*\endcsname{yquant}}{\csname endoption*\endcsname}

\newsavebox\codeexamplebox
\newenvironment{codeexample}{%
   \VerbatimEnvironment%
   \let\FVB@VerbatimOut\minted@FVB@VerbatimOut
   \let\FVE@VerbatimOut\minted@FVE@VerbatimOut
   \minted@configlang{tex}%
   \minted@fvset
   \begin{VerbatimOut}[codes={\catcode`\^^I=12},firstline,lastline]{\minted@jobname.pyg}%
}{
   \end{VerbatimOut}%
   \minted@langlinenoson%
   \savebox\codeexamplebox{\input \minted@jobname.pyg}%
   \ifdim\wd\codeexamplebox>\dimexpr.5\linewidth-3mm\relax%
      \wd\codeexamplebox=.5\linewidth% squeeze if necessary
   \else%
      \wd\codeexamplebox=\dimexpr\wd\codeexamplebox+3mm\relax% else give some space
   \fi%
   \noindent\begin{minipage}{\wd\codeexamplebox}%
      \centering%
      \usebox\codeexamplebox%
   \end{minipage}%
   \begin{minipage}{\dimexpr\linewidth-\wd\codeexamplebox\relax}%
      \minted@pygmentize{\minted@lang}%
   \end{minipage}%
   \minted@langlinenosoff%
   \par%
}

\newenvironment{codeexample*}{%
   \VerbatimEnvironment%
   \let\FVB@VerbatimOut\minted@FVB@VerbatimOut
   \let\FVE@VerbatimOut\minted@FVE@VerbatimOut
   \minted@configlang{tex}%
   \minted@fvset
   \begin{VerbatimOut}[codes={\catcode`\^^I=12},firstline,lastline]{\minted@jobname.pyg}%
}{
   \end{VerbatimOut}%
   \minted@langlinenoson%
   \begin{adjustbox}{center}
      \input \minted@jobname.pyg %
   \end{adjustbox}\nopagebreak
   \minted@pygmentize{\minted@lang}%
   \minted@langlinenosoff%
   \par%
}

\def\bd@boxextra#1{%
   \node[anchor=north west] at (current bounding box.north east) {\hskip7pt#1};%
}

\newcommand*\bd@boxintro[5]{%
   \begingroup%
      \setlength{\parskip}{0pt}%
      \setlength{\parindent}{0pt}%
      \ifstrempty{#5}{%
         \begin{mdframed}[style=bdBox, backgroundcolor=#4, linecolor=#2,
                          firstextra=\bd@boxextra{#1}, singleextra=\bd@boxextra{#1}]%
      }{%
         \begin{mdframed}[style=bdBox, backgroundcolor=#4,
                          frametitlefont=\bfseries\sffamily\color{#3},
                          frametitlebackgroundcolor=#2,
                          frametitle={\strut#5}, linecolor=#2,
                          firstextra=\bd@boxextra{#1}, singleextra=\bd@boxextra{#1}]%
      }%
      \ignorespaces%
}
\def\bd@boxoutro{%
      \end{mdframed}%
   \endgroup%
}
\iffalse% code folding breaks
   \end{mdframed}
\fi
\mdfdefinestyle{bdBox}{
   skipabove=3pt,
   skipbelow=0pt,
   leftmargin=0pt,
   rightmargin=0pt,
   innerleftmargin=7pt,
   innerrightmargin=7pt,
   innertopmargin=5pt,
   innerbottommargin=5pt,
   splittopskip=17pt,
   frametitlealignment=\raggedright,
   frametitleaboveskip=3pt,
   frametitlebelowskip=1.5pt
}
\newenvironment*{warning}[1][]{%
   \bd@boxintro{\raisebox{\baselineskip-\height-6.5pt}{\includegraphics[width=1cm]{Warning.pdf}}}%
               {boxRedHead}{white}{boxRedBody}{#1}%
   \ignorespaces%
}{%
   \bd@boxoutro%
}
\newenvironment*{example}[1][]{%
   \bd@boxintro{\raisebox{\baselineskip-\height-6.5pt}{\includegraphics[width=1cm]{Bulb.png}}}%
               {boxBlueHead}{white}{boxBlueBody}{#1}%
   \ignorespaces%
}{%
   \bd@boxoutro%
}
% END_FOLD

\def\TikZ{\textcolor{brown}{Ti\textit kZ}}
\def\pkg#1{\textcolor{brown}{\texttt{#1}}}
\def\gate#1{\hyperref[gate:#1]{\texttt{#1}}}
\def\style#1{\hyperref[style:#1]{\texttt{#1}}}
\def\Yquant{\pkg{yquant}}
\def\ii{{\symup i}}
\def\ee{{\symup e}}
\def\ketbra#1#2{\ket{#1}\!\bra{#2}}

\frenchspacing
\RequirePackage{scrlayer-scrpage}
\setcounter{tocdepth}{\subsectiontocdepth}
\KOMAoptions{DIV=8}
\addtokomafont{section}{\clearpage}
\recalctypearea

\begin{document}
   \maketitle
   \begin{abstract}
      \noindent This manual introduces \Yquant, a \LaTeX\hyp only package that outputs quantum circuits.
      They are entered using a human\hyp readable language that, even from the source code, allows for a fluent understanding of the logic that underlies the circuit.
      \Yquant{} internally builds on \TikZ{} and can be easily combined with arbitrary \LaTeX{} code.
      More than forty pages of examples complement the formal manual.
   \end{abstract}
   \tableofcontents
   
   \clearpage
   \section{Introduction}
      This document outlines the scope and usage of the \Yquant{} package.
      It contains both a reference and a huge number of examples.
      \Yquant{} is a package that makes typesetting quantum circuits easy; the package is available on CTAN.
      This alpha version~0.3 \emph{should} be stable and interfaces are not very likely to change in an incompatible way in the future.
      Please do report all issues and desirable additions.
      
      \subsection{How to read the manual}
         The probably fastest way to start using \Yquant{} is by just scanning through the examples in \cref{sec:examples}.
         A more formal description of the \Yquant{} grammar and its fundamental concepts can be found in \cref{sec:grammar}.
         If your desire is to change the appearance of \Yquant{} elements, use the configuration reference in \cref{sec:config}.
         The full list of all available gates is provided in \cref{sec:gates}.
         Finally, you may find that \Yquant{} \emph{almost} does what you want, but there is some final tweak that you cannot achieve\dots.
         Then, have a look at \cref{sec:tikz} (or \cref{sec:alt}).
      
      \subsection{Installation}
         The recommended way of installation is through CTAN.
         A direct installation from this Git repository to obtain the latest additions and features is be possible by just cloning it to a path visible to your \TeX{} compiler.
         While the repository may contain new additions, they are not thoroughly tested until they end up on CTAN; features that are not documented in this manual are entirely unreliable.
         For example, you may put them in the same directory as your document (if you just want to give a try), or you may extract them to \texttt{tex/latex/yquant} in your local \texttt{texmf} (followed by an update of the file name database).
      
      \subsection{Purpose of \Yquant, alternatives}\label{sec:alt}
         \Yquant{} is the acronym for ``yet another quantum circuit package.''
         This highlights the fact that nothing that this package provides cannot be achieved by other means.
         In particular, there are at least the following methods to typeset quantum circuits in \TeX.
         \begin{itemize}
            \item Use some external program to draw them and include the output via \tex!\includegraphics!.
            \item Use either \TeX's own drawing capabilities (the \tex!picture! environment) or other drawing packages such as \TikZ{} or \pkg{pstricks}.
            \item Use a package specifically designed to draw quantum circuits (if you feel some other package should be mentioned here, please file an issue):
               \begin{itemize}
                  \item \pkg{qasm} is probably the first of them (in terms of age).
                     It was developed to typeset the circuits found in Nielsen and Chuang's famous \emph{Quantum Computation and Quantum Information} book.
                     \pkg{qasm} consists of a Python~2 script (\texttt{qasm2circ}) that reads a quantum circuit written in a very intuitive language: declare names for your qubits, perform gates on them in each line.
                     \texttt{qasm2circ} converts those circuits into \TeX{} files that internally make use of the \pkg{xy} package to display the output.
                     Consequently, the user is restricted to the set of features that \pkg{qasm} directly offers (which is small).
                     Changes to the output, while possible, will be overwritten if \texttt{qasm2circ} is run again.
                     \pkg{qasm} output often looks sub\hyp optimal do to the fact that, e.g., rectangles are made up of four lines that do not properly connect and give a crumbly general feeling.
                     
                     Note that since version~0.3, \Yquant{} understands \pkg{qasm} syntax, see \cref{sec:foreign:qasm}.
                     
                     Maintenance status: last update of \pkg{qasm} in 2005. Also, \pkg{xy} was last updated in 2013, and the script is not compatible out\hyp of\hyp the\hyp box with Python~3, though an automatic conversion should work.
                  \item \pkg{qcircuit} is probably the most\hyp widely used package.
                     It provides commands that make it much easier to create quantum circuits using the \pkg{xy} package.
                     Its syntax therefore is grid\hyp oriented; inferring what a circuit does or locating a gate in the code can be tough.
                     This is particularly true for multi\hyp qubit gates.
                     Additionally, the \tex!\xymatrix! syntax is also somewhat cryptic.
                     \pkg{qcircuit} provides some flexibility within the limits of \pkg{xy} as to configuring the output.
                     
                     Maintenance status: last update in 2018; and remember this is \pkg{xy} based, with last update in 2013.
                  \item \pkg{quantikz} is a relatively recent package that, following the same grid\hyp based approach as \pkg{qcircuit}, instead builds on \TikZ{} as a backend.
                     As a consequence, it provides the full flexibility of customization that \TikZ{} offers, where hardly anything cannot be done.
                     It also reduces burdens of the \pkg{xy} syntax.
                     However, the disadvantages of the grid\hyp based syntax still remain.
                     
                     Maintenance status: last update in 2020; the underlying \TikZ{} is actively maintained again by now.
                  \item \pkg{qpic} follows the approach of \pkg{qasm}: It makes use of an external Python program that reads the quantum circuits in an own language and converts them into \TikZ{} commands.
                     The language \pkg{qpic} follows is much more powerful than \pkg{qasm}'s.
                     The disadvantage that modifications in the output code will not remain after running the Python script again is mitigated by the possibility to define own \TeX{} macros.
                     Being an external program, \pkg{qpic}'s intrinsic set of features (including, e.g., vertically set circuits) are huge.
                     However, the language \pkg{qpic} uses cannot be understood without a detailed study of the manual, it appears to have been designed with the aim to minimize the length of command names.
                     A disadvantage of external programs is that the amount of space gates need is not accessible by the script; hence, manual intervention may be required.
                     
                     Maintenance status: last update in 2016; the underlying \TikZ{} is actively maintained, and the script is compatible with Python~3.
               \end{itemize}
         \end{itemize}
      
      \subsection{License}
          This work may be distributed and/or modified under the conditions of the \LaTeX{} Project Public License, either version~1.3c of this license or (at your option) any later version.
          The latest version of this license is in
          \begin{center}
             \url{http://www.latex-project.org/lppl.txt}
          \end{center}
          and version~1.3c or later is part of all distributions of LaTeX version 2005/12/01 or later.
   
   \section{Basic elements of \Yquant}\label{sec:grammar}
      \Yquant, as some of the aforementioned packages, builds on \TikZ.
      Its basic syntax is similar to \pkg{pgfplots}: Start a \tex!tikzpicture! environment (perhaps passing some options); inside, start a \tex!yquant! environment.
      
      Inside the \tex!yquant! environment, \TeX{} will now understand the \Yquant{} language---so \Yquant{} falls into the same category as \pkg{qasm} and \pkg{qpic}, providing a human\hyp readable language for the specification of the circuit that is not fixed to the actual layout.
      
      However, \Yquant{} is a \TeX\hyp only package (actually, \hologo{LaTeX2e}, but not \hologo{LaTeX3}) that requires no external script to run---so it also falls into the same category as \pkg{qcircuit} and \pkg{quantikz}.
      
      Since it runs entirely within \TeX, you can at any time interject \Yquant{} code with arbitrary \TeX{} or \TikZ{} code (though if it is ``too arbitrary,'' you may need to restart the \Yquant{} interpreter).
      
      \subsection{General usage}
         \begin{minted}{tex}
% preamble: \usepackage{yquant}
\begin{tikzpicture}% tikz options possible
   % tikz commands go here
   \begin{yquant}% yquant options possible. Watch the newlines!
      % yquant and tikz commands go here
   \end{yquant}
   % tikz commands go here
\end{tikzpicture}
         \end{minted}
         
         Note that \Yquant{} depends on \pkg{etoolbox}, \TikZ, and \pkg{trimspaces}.
         Additionally, it requires a moderately recent version of \hologo{LaTeX2e}, using either \hologo{LuaLaTeX}, or (untested), \hologo{pdfLaTeX} or \hologo{XeLaTeX}.
         
         \begin{warning}[Optional arguments]
            The optional arguments for the \tex!yquant! environment have to appear \emph{on the same line} as the environment itself.
            If you want to put the arguments into a new line, it is crucial to mask the line break by putting a comment symbol after the environment: \tex!\begin{yquant}%!.
            Without this comment, \Yquant{} will detect your line break (this is one of the few places in \TeX{} where line breaks and spaces are different) and assume that the expression in square brackets instead provides arguments for the following operation! \\
            Finally note that in (non\hyp fragile) \pkg{beamer} frames, this discrimination between spaces and new lines does not work; the optional arguments will always be counted for the environment, not for the gate.
            In this case, you can either declare the frame as fragile or (recommended) introduce a blank line between the environment and the options for the first gate.
         \end{warning}
      
      \subsection{Starred vs. unstarred environment}
         You may choose to use either the \tex!yquant! or the \tex!yquant*! environment.
         The former one requires you to define all your registers before you use them (though you may decide to define a register after some operations on \emph{different} registers, but before its first usage).
         
         The starred form additionally supports the use of undeclared registers: it basically declares a registers upon its first usage.
         This will always be a \texttt{qubit} register; but if you use the corresponding option and the first usage is an \gate{init} command, you may overwrite this.
         Subcircuits always use the unstarred form.
         
         Additionally, if you refer to the index $i$ of a vector register of length $L < i$, this register will automatically be enlarged to $i \coloneq L$.
         It is also possible to convert a scalar register into a vector register in this manner.
         To enlarge a register in the unstarred environment, you must precede the number of registers to be added in the second declaration by a plus sign.
         Note that in this manner, you may even create discontiguous vectors.
         
         \emph{This might be a good point to proceed to the examples \cref{sec:examples}.}
      
      \subsection{Formal syntax}
         Every \Yquant{} command has the same structure (described here in EBNF syntax):
         \begin{minted}{ebnf}
Command = { Arguments }, ?command?, [ Value ], [ RegisterList ], Controls, ";";
Arguments = "[", ?pgfkeys?, "]";
Value = "{", ?TeX code?, "}";
Controls = [ "|", [ RegisterSingleList ] ], [ "~", [ RegisterSingleList ] ];

RegisterList = (RegisterSingle | RegisterMulti), [ ",", RegisterList ];
RegisterSingleList = RegisterSingle, [ ",", RegisterSingleList ];

RegisterSingle = RegisterSingleNoRange | RegisterRange;
RegisterSingleNoRange = ?name?, [ "[", IndexMultiList, "]" ];
RegisterMulti = "(", ( RegisterMultiNoRange | [ "*" ], RegisterRange ), ")";
RegisterMultiNoRange = [ "*" ], ?name?, [ "[", IndexSingleMainList, "]" ];
RegisterRange = [ RegisterUnique ], "-", [ RegisterUnique ];
RegisterUnique = ?name?, [ "[", ?number?, "]" ];

IndexMultiList = IndexMulti, [ ",", IndexMultiList ];
IndexSingleList = IndexSingle, [ ",", IndexSingleList ];
IndexSingleMainList = [ "*" ], IndexSingle, [ ",", IndexSingleMainList ];
IndexMulti = IndexSingle | ( "(", IndexSingle, ")" );
IndexSingle = ?number? | ( [ ?number? ], "-", [ ?number? ] );
         \end{minted}
         Note that \Yquant{} is quite tolerant with respect to whitespaces.
         Virtually every comma in the EBNF notation may consist of an arbitrary (including zero) number of whitespaces.
         Not all combinations that can be constructed by this grammar are actually allowed semantically; but it would make the grammar too verbose to spell this out in detail.
         Deviations are noted in this manual.
         
         Valid values for
         \begin{BVerbatim}[commandchars=\\\{\}]
\PYG{n+ni}{?command?}
         \end{BVerbatim}
         \space (case\hyp insensitive) are documented in a \cref{sec:gates}.
         We use
         \begin{BVerbatim}[commandchars=\\\{\}]
\PYG{n+ni}{?pgfkeys?}
         \end{BVerbatim}
         \space to describe any valid content passed to the \tex!\pgfkeys! macro (rather, \tex!\yquantset! is invoked with some subtleties); and by
         \begin{BVerbatim}[commandchars=\\\{\}]
\PYG{n+ni}{?name?}
         \end{BVerbatim}
         \space we denote any valid register name.
         Register names must not contain any of the control literals used before (semicolon, comma, parentheses, square brackets, dash, pipe, tilde, beginning star); and you should avoid using special \TeX{} characters.
         Note that for performance reasons, \Yquant{} does not check whether a register name is valid or not, but expect to either see unintended output or not\hyp so\hyp helpful error messages if you choose an invalid name.
         \begin{BVerbatim}[commandchars=\\\{\}]
\PYG{n+ni}{?number?}
         \end{BVerbatim}
         \space is a decimal integer larger or equal to zero (in the context of register creation, strictly larger; in this context, it may also contain a leading
         \begin{BVerbatim}[commandchars=\\\{\}]
\PYG{l+s+s2}{\PYGZdq{}+\PYGZdq{}}
         \end{BVerbatim}
         ).
         
      \subsection{Registers}\label{sec:registers}
         Every quantum circuit is structured by means of \emph{registers}.
         A register has a \emph{type} that specifies how its wire is drawn, and that may even change during its lifetime.
         At the moment, \Yquant{} supports four types:
         \begin{enumerate}
            \item \gate{qubit} is the most common type, used for a quantum register.
               It corresponds to a single line.
            \item \gate{cbit} is a classical register, which can be either declared from the beginning or arises by using measurements.
               It corresponds to a double line.
            \item \gate{qubits} is a ``quantum bundle,'' i.e., a bunch of quantum registers that are always addressed in a group as a single register.
               Operations between bundles of the same length should be interpreted as transversal.
               It corresponds to a triple line.
               An alternative (and more common) representation is to use the \gate{qubit} type and a \gate{slash} gate at its very beginning.
            \item \gate{nobit} is the most obscure type, corresponding to a non\hyp existing wire.
               Mostly, this register type arises by using the \gate{discard} command.
               However, it can also be directly declared, which on rare occasions might be necessary (its type can then be changed by means of an \gate{init} or \gate{setwire} pseudo\hyp gate).
               If you want to declare a register only at a certain horizontal position in the circuit, consider using the \texttt{after} argument instead.
         \end{enumerate}
         
         Registers must be declared before they can be used (though in the \tex!yquant*! environment, this declaration may be implicit, creating a \gate{qubit} register).
         
         Registers can have a vector character, i.e., not only a \emph{name}, but also an \emph{index} (or, in the declaration, a \emph{length}).
         The index (zero\hyp based) or length is specified in square brackets following the name, which closely mimics the OpenQASM language.
         
         Since version 0.1.1, vector registers may be non\hyp contiguous: Whenever you create a bunch of registers, it is put at the bottom of the circuit.
         If you later on again create registers of the same name---either implicitly in the \tex!yquant*! environment, or explicitly by preceding the length of the vectors entries to be added by a plus, as in \yquant!qubit a[+3];!---they will be put to what is \emph{now} the bottom of the circuit, even if some other registers are interspersed.
         
         Registers are referenced---i.e., used in operations---by their name and index.
         If the latter is omitted, all indices of the register are targeted.
         Multiple registers can be referenced by joining their names in a comma\hyp separated list, or by means of a range specifier: give the name of the first (topmost), a dash, and the last (bottom\hyp most) register.
         Both are inclusive.
         In a range specifier, omitting the start name means that the range begins at the first known register; omitting the end name means that the range ends at the last known (at the moment of its use) register.
         Omitting both indicates a range over all known registers.
         
         Since version 0.1.1, it is also possible to use comma\hyp separated lists and ranges within the indices themselves, so that, e.g., \yquant!a[0, 2, 5-], b[-2]! will target the zeroth and second index of \yquant!a!; the remaining indices of \yquant!a! starting from five; and the first three indices of \yquant!b!.
         However, if you use an \emph{outer} range (i.e., a range between indices of registers with different names), the initial and final register of the range must be unique, i.e., either you omit the index (targeting the first or last register with the given name) or specify a single one.
         
         \begin{warning}[Ranges and discontiguous registers]
            Assume a configuration in which the vector register \yquant!a! begins with one qubit, then the single register \yquant!b! follows, and after that \yquant!a! is continued with another qubit.
            
            The range \yquant!a-b! will target \yquant!a[0]! and \yquant!b[0]!, but not \yquant!a[1]!.
            As \yquant!a! is used as the initial register in the range without an explicit index specification, \Yquant{} automatically translates this into \yquant!a[0]!, while \yquant!b!, being used as the final register, is automatically translated into the last register of name \yquant!b! (which here happens to be \yquant!b[0]!).
            Ranges between different register names (outer ranges) are \emph{visual} ranges, i.e., they refer to the top\hyp to\hyp bottom order that is visible.
            Consequently, the register \yquant!a[1]! is left out since it is visually below the others.
            
            Likewise, the range \yquant!b-a! will target \yquant!b[0]! and \yquant!a[1]!.
            
            Ranges within indices are \emph{logical} ranges.
            Hence, \yquant!a!, \yquant!a[-]!, \yquant!a[0-]!, \yquant!a[-1]!, and \yquant!a[0-1]! are all equivalent: they all refer to the registers \yquant!a[0]! and \yquant!a[1]!, but never to \yquant!b!, regardless of any visual position.
         \end{warning}
         
         All that was said so far refers to the operation being carried out on each of the registers \emph{individually}, i.e., producing several copies of the operation.
         This is different from using the operation multiple times on the individual single registers only with regard to the vertical positioning: if specified as a register list with one operation, all copies of the operation will be aligned at the same vertical position (as if an \gate{align} command had been carried out before).
         \begin{warning}
            It is forbidden (in the sense of ``not useful,'' but \Yquant{} does not check for this) to list the same register multiple times (explicitly or via ranges) in one operation.
         \end{warning}
         
         Instead of copies of single\hyp register operations, one might want to carry out a multi\hyp register operation.
         In this case, the desired list of registers (comma separated, range, or both) must be surrounded by parentheses.
         It is possible to mix single- and multi\hyp register operations arbitrarily.
         In an index list, you may also choose to surround only certain indices with parenthesis, provided the whole register is not already a multi\hyp register.
         \begin{warning}
            Note that some gates, such as the \gate{swap} gate, always require (semantically, not grammatically) multi\hyp register operations.
            Since version 0.1.2, the number of constituents is no longer fixed; while a \gate{swap} gate with more than two targets is no longer well\hyp defined, other registers such as \gate{zz} may still be useful.
            \Yquant{} will prevent you from using a gate in a multi\hyp qubit setting when it may only be used for single registers.
         \end{warning}
         Typically, multi\hyp register operations should only be carried out on adjacent registers---but sometimes, one might want to carry out a multi\hyp qubit operation on a visually discontiguous set of registers (which, due to a particular quantum computer topology, might even be physically feasible).
         Since version 0.1.2, \Yquant{} supports these discontiguous operations explicitly (before, a single gate was drawn with all intermediate non\hyp affected register lines laying on top).
         It will draw a \emph{main} part of the gate at the first contiguous slice of registers in the target list---you may select another register for this part by preceding the name or index with a star (which, contrary to the simplified grammar, may only occur \emph{once} in a target specification).
         All other contiguous slices of target registers will be drawn in a \emph{subordinate style} for this gate.
         Finally, all slices will be connected by a single vertical line with the style \style{/yquant/every multi line}.
         Subcircuits, supported as of version~0.2, will always span the full region from the first to the last register specified in a multi\hyp qubit gate.
         This is due to the fact that they may contain arbitrary ancilla registers which may be positioned somewhere in between the parts that actually constitute the subcircuit---so this whole region must not have wires of other registers crossing.
         \begin{warning}[Discontiguous targets and control lines]
            A control line extends from the very first to the very last affected register in an operation.
            A sub\hyp gate line that is used for discontiguous registers will only span the range of a multi\hyp register.
            This distinction becomes crucial if you want to carry out a \emph{controlled} operation on more than one multi\hyp register, where at least one is discontiguous.
            Without the controls, the separate multi\hyp registers could be identified, since no connecting vertical line extends between them (unless, which you should strictly avoid, they are intertwined).
            However, with the controls, the control line will make it hard (for some gates, impossible) to visually distinguish the connected parts.
            \Yquant{} will kindly provide a warning in this case.
            You may choose to suppress this warning using the boolean key \style{/yquant/operator/multi warning}.
         \end{warning}
         \begin{warning}
            There is no established style for discontiguous gates.
            Note that at the moment, main and subordinate style coincide for all gates except for the \gate{measure} gate with a value.
            In order to still make it possible to visually distinguish discontiguous multi\hyp register gates operating on slices of a single register from just a bunch of single\hyp register gates that are executed in a parallel manner, if controls are present, \Yquant's default vertical line style for the former case is a wavy line instead of a straight one.
            Still, the meaning of this should probably be explained.
            Please feel free to submit issues or pull requests with propositions of how default styles or alternative subordinate gate shapes may additionally help to mitigate the problem.
         \end{warning}
      
      \subsection{Arguments}
         Every command may take one or multiple arguments.
         Those are specified in square brackets that precede the command itself.
         The content of those square brackets is essentially fed to a \tex!\pgfkeys!-like macro.
         The default path is set appropriately such that the arguments of the command can be accessed without and path specifiers.
         If the key is not a valid argument for the command or a global argument and it is not given by an absolute path, it is searched for in the \texttt{/yquant} namespace.
         If it cannot be found there, it is passed to \style{/yquant/operator style}.
         
         Note that commands may have required arguments.
         If a required argument is missing, an error will be issued.
         
         The \texttt{value} attribute can alternatively be given inside curly brackets after the command name and before the register specification.
         This has the advantage that special characters such as a closing square bracket need not be escaped.
         If both alternatives are present, the value inside curly brackets takes precedence and a warning is issued.
      
      \subsection{Controls}
         Lots of gates may have controls, i.e., they are only to be executed if some other gate is set or unset.
         The former case is called a \emph{positive control}, the latter one a \emph{negative control}.
         Those are indicated by filled and empty circles on the control registers and a vertical line that joins the registers that belong together.
         
         The gate specification is followed by the list of target registers.
         By then writing a pipe (``\yquant!|!''), the list of positive controls is introduced; this mimics the mathematical syntax ``conditioned on'' for probabilities or ``given'' for sets.
         If there are no positive controls, the list may be empty or, together with the pipe, omitted.
         Preceded by a tilde (``\yquant!~!''), the list of negative controls then follows; this mimics the syntax of many programming languages that denote logical negation by a tilde.
         If there are no negative controls, the list may be empty or, together with the pipe, omitted.
         
      \clearpage
      \subsection{Importing circuits from files}\label{sec:import}
         Since version~0.2, \Yquant{} provides a simple way to import circuits that are stored in external files.
         The macro \tex!\yquantimport! can be used in three different contexts:
         \begin{itemize}
            \item Outside of a \TikZ{} picture environment. \\
               In this case, \tex!\yquantimport[<options>]{<filename>}! will be equivalent to
               \begin{minted}{tex}
\begin{tikzpicture}
   \begin{yquant}[<options>]
      % the content of <filename> goes here
   \end{yquant}
\end{tikzpicture}
               \end{minted}
               The starred form, \tex!\yquantimport*[<options>]{<filename>}!, instead inserts the starred \Yquant{} environment.
               Note that the options are always \Yquant{} options; if you want to pass \TikZ{} options, you will have to create the picture environment by yourself or change the option path to the correct one (\texttt{/tikz/.cd}).
            \item Inside a \TikZ{} picture environment, but outside of a \Yquant{} environment. \\
               This is the same as before, just that no extra picture environment will be added.
            \item Inside both a \TikZ{} picture environment and a \Yquant{} environment. \\
               The file will be inserted directly into the environment.
               \Yquant's parser is automatically restarted after this.
               The content will always be put in a \TeX{} group; if additional options are provided, \Yquant{} also inserts a \TikZ{} \tex!scope! and executes \tex!\yquantset{<options>}! directly after the scope.
               If \tex!\yquantimport! is used, the content will be read as if the containing environment was an unstarred one; if \tex!\yquantimport*! is used, the content will be read as if the containing environment was a starred one.
         \end{itemize}
         Note that \Yquant{} internally uses plain \TeX's \tex!\import! command (i.e., \tex!\@@import! in \LaTeX).
         However, when the \pkg{import} package is loaded, it uses \\ \tex!\subimport{\yquantimportpath}{<filename>}!, where \tex!\yquantimportpath! defaults to \texttt{./}---so by changing this, files from other folders may be imported which by themselves again include other files, and the relative path resolution will work.
         
         Note that you may in particular import the content of a \gate{subcircuit}.
      
      \subsection{Defining own gates}
         \begin{warning}[Scope]
            All gate declarations are always global.
         \end{warning}
         
         Since version~0.2.1, if you want to define a gate that corresponds to a single \gate{box} gate with a certain pre\hyp defined content, you may use the macro\\
         \tex!\yquantdefinebox{<name>}[<style>]{<content>}!, which is far more efficient than the much more general \tex!\yquantdefinegate! introduced below.
         It works in the following way:
         \begin{itemize}
            \item It creates a new gate with name \texttt{<name>} that can be accessed as all the other build\hyp in gates.
               Note that \texttt{<name>} is case\hyp insensitive and may not contain spaces.
               Special characters are allowed if \TeX{} can cope with them (i.e., no comment signs, no unbalanced braces, no backslashes...).
            \item It creates a style \style{/yquant/operators/every <name>} and assigns the optional \texttt{<style>} to it.
               If no style is provided, the default style will inherit from \style{/yquant/operators/every box}.
            \item It defines \texttt{<content>} to be the value that is written into the box.
               This \texttt{<content>} is expanded in a protected manner at the time of gate declaration.
               You may need to prefix fragile macros by \tex!\protect!.
         \end{itemize}
         
         Sometimes, you may wish to define gates that are more than just a single box---perhaps a succession of multiple gates or even multi\hyp register gates with individual operations on the input registers. \\
         Since version~0.2, \Yquant{} provides a simple macro that allows this.
         The macro \tex!\yquantdefinegate{<name>}[<style>]{<content>}! works in the following way:
         \begin{itemize}
            \item It creates a new gate with name \texttt{<name>} that can be accessed as all the other built\hyp in gates.
               Note that \texttt{<name>} is case\hyp insensitive and may not contain spaces.
               Special characters are allowed if \TeX{} can cope with them (i.e., no comment signs, no unbalanced braces, no backslashes...).
            \item It creates a style \style{/yquant/operators/every <name>} and assigns the optional \texttt{<style>} to it.
               If no style is provided, the default style will inherit from \style{/yquant/operators/every custom gate}.
               This will make the gate ``seamless,'' i.e., avoid highlighting the fact that this is a custom gate.
            \item It defines a macro that contains \texttt{<content>} (expanded in a protected manner) and that will be inserted as a subcircuit whenever this gate is invoked.
               This in particular means that if you use \hyperref[sec:import]{\tex!\yquantimport!} within the gate, the file will only be loaded once at the time of declaration.
         \end{itemize}
         When the gate is later drawn, the styles are invoked in the following order---remember custom gates are implemented by means of subcircuits---:
         \begin{enumerate}
            \item \style{/yquant/every operator}
            \item \style{/yquant/operators/every <name>}
            \item \style{/yquant/operators/every subcircuit box}
            \item \style{/yquant/this operator}
            \item \style{/yquant/operators/this subcircuit box}
         \end{enumerate}
         Gates defined in this way can only make use of the default gates or other custom gates.
         They do not accept custom arguments, and it is not possible to declare own, custom shapes in this way (though other predefined shapes may be used).
         If they are used in a multi\hyp qubit manner, they will never be split into contiguous slices (but their content will be, so if you use the default style that turns off the box, the only way to notice this is that intermediate unaffected gates will not be allowed to place gates within the custom gate).
         
         \begin{warning}[Redefining existing gates]
            The above macros will issue an error if the gate already exists.
            You can use \tex!\yquantredefinebox! or \tex!\yquantredefinegate! to overwrite existing gate definitions.
            Note that this will overwrite \emph{any} gate, even the built\hyp in ones.
            
            Generally, it is discouraged to make use of this possibility.
            For custom gates, if you redefine a gate as a box which was previously a general subcircuit\hyp based gate, the macro that contains the subcircuit will still be held in memory.
            Overwriting built\hyp in gates will not clear the attributes associated to this gate (though required attributes will no longer be required afterwards).
            Again, this is not a problem but prevents \Yquant{} from issuing potentially helpful error message if such a---now meaningless---attribute is used.
            
            Finally, once a built\hyp in gate is overwritten, it cannot be restored.
            In particular, the register creation pseudo\hyp gates \gate{qubit}, \gate{cbit}, \gate{qubits}, and \gate{nobit} perform some magic that cannot be mimicked with custom gates.
         \end{warning}
         
         More advanced declaration of custom gates requires the use of backend macros.
         Refer to \texttt{yquant-lang.tex} for this.
         For the declaration of custom shapes, see \texttt{yquant-shapes.tex} for examples.
      
   \section{Configuration}\label{sec:config}
      \Yquant{} uses \pkg{pgfkeys} to control its options, which are located in the path \texttt{/yquant}.
      The following list contains all options and styles that are recognized, apart from gate arguments.
      Those are listed together with their operations.
      
      \subsection{Circuit layout}\unskipOpt
         \begin{option}{register/minimum height}!3mm!
            \Yquant{} automatically determines the total height of a register as the height of the largest operation.
            This might be too small for two reasons:
            \begin{itemize}
               \item if the register is used only with small gates (e.g., only as a control, or as a swap), and it does not have a label (or one containing only x\hyp height letters).
               \item if the register is used only with multi\hyp qubit gates.
                  For those, \Yquant{} cannot decide where to put the height---and it is easy to see that an equal distribution over all affected registers is not necessarily a good solution.
                  Hence, multi\hyp qubit gates are ignored in the height calculation.
                  Usually, this is not a problem since those operations are large enough as they take the height of all involved registers and separations.
            \end{itemize}
            This key provides an easy alleviation of the problem by requiring a minimal height for every register.
         \end{option}
         
         \begin{option}{register/separation}!1mm!
            This key controls the amount of vertical space that is inserted between two successive registers.
            Half of this value is also the length that multi\hyp\gate{init} or multi\hyp\gate{output} braces extend beyond the mid position of the register.
         \end{option}
         
         \begin{option}{operator/minimum width}!3mm!
            \Yquant{} automatically determines the width of an operator according to its content.
            However, single\hyp letter boxes are among the most common operators, and giving them slightly different widths would result in a very uneven spacing, as \Yquant{} does not use a grid layout but stacks the operators horizontally one after each other.
            Hence, this key provides a minimum width that will be set for every operator.
            This does not imply that the \emph{visual} appearance (i.e., the \texttt{x radius} key) is enlarged, but that operators of a smaller actual width will be centered in a virtual box of the minimum width.
         \end{option}
         
         \begin{option}{operator/separation}!1mm!
            This key controls the amount of horizontal space that is inserted between two successive operators.
         \end{option}
         
         \begin{option}{operator/multi warning}!true!
            If this key is \texttt{true}, a warning is displayed whenever more than a single multi\hyp register gate, where at least one is discontiguous, are employed together with controls.
            Even if a visual distinction between control and multi\hyp qubit line may be possible (depending on the style in use), they will overlap and produce unaesthetic output.
            You may disable this warning globally, on a per\hyp circuit, or even on a per\hyp gate basis.
         \end{option}
      
      \subsection{Register creation}\unskipOpt
         \begin{option}{register/default name}!\regidx!
            The printed name that is used by default if a new register is created explicitly (\gate{qubit}, \gate{cbit}, \gate{qubits}; not used for \gate{nobit} or for implicit declarations) and no value is specified.
            The following macros are available:
            \begin{itemize}
               \item \tex!\reg! contains the internal name that is used to identify this register.
               \item \tex!\idx! contains the index (zero\hyp based) of the current register within a vector register.
               \item \tex!\regidx! expands to \tex!\reg! if the register is of length one, and to \tex!\reg[\idx]! else.
               \item \tex!\len! contains the length of the current register vector.
            \end{itemize}
         \end{option}
         
         \begin{option}{every label}!shape=yquant-text, anchor=center, align=right!
            This style is installed for every single register name label (i.e., upon creation and when used with the \gate{init} gate).
            The default style allows to use line breaks in the labels.
         \end{option}
         
         \begin{option}{every initial label}!anchor=east!
            This style is installed for every single register name label at the left border of the circuit.
            Hence, it is only used for the \gate{init} gate if in the \tex!yquant*! environment, the gate occurs for a new register (which allows to override the default register type).
         \end{option}
         
         \begin{option}{every qubit label}!!
            This style is installed for every single register name label of a register of type \gate{qubit}.
         \end{option}
         
         \begin{option}{every cbit label}!!
            This style is installed for every single register name label of a register of type \gate{cbit}.
         \end{option}
         
         \begin{option}{every qubits label}!!
            This style is installed for every single register name label of a register of type \gate{qubits}.
         \end{option}
         
         \begin{option}{every multi label}!shift={(-.075, 0)}, draw, decoration={gapped brace, mirror}, decorate, /yquant/gapped brace/apply shift, every node/.append style={shape=yquant-text, anchor=east, align=right, shift={(-.05, 0)}, pos=-1}!
            This style is installed for every register name label that is attached to a multi\hyp qubit register by means of the \gate{init} gate.
            \Yquant{} additionally inserts a straight line that connects the topmost and the bottom\hyp most register at their left ends.
            The default style turns this line into a brace and places the description at the appropriate position.
            The decoration \texttt{gapped brace} allows to additionally specify the regions in which a line should be drawn by using the \texttt{/tikz/decoration/from to} key, which expects a comma\hyp separated list of dimension ranges, and which is automatically populated by \Yquant.
            Since it may happen that the arch of the brace needs to be shifted from the value specified in \texttt{/tikz/decoration/aspect} (else, it would be drawn into a gap), the special key \texttt{/yquant/gapped brace/apply shift} is installed, which transforms the \texttt{pos=-1} specification into a position that corresponds to the actual \texttt{aspect} value.
         \end{option}
         
         \begin{option}{every input label}!!
            This style is installed for every register name label in a \gate{subcircuit} when the register is an input (or input and output) register.
         \end{option}
      
      \subsection{Register outputs}\unskipOpt
         \begin{option}{every output}!shape=yquant-text, anchor=west, align=left!
            This style is installed for every \gate{output} label at the end of the circuit.
            The default style allows to use line breaks in the labels.
         \end{option}
         
         \begin{option}{every qubit output}!!
            This style is installed for every \gate{output} label of a register of type \gate{qubit}.
         \end{option}
         
         \begin{option}{every cbit output}!!
            This style is installed for every \gate{output} label of a register of type \gate{cbit}.
         \end{option}
         
         \begin{option}{every qubits output}!!
            This style is installed for every \gate{output} label of a register of type \gate{qubits}.
         \end{option}
         
         \begin{option}{every multi output}!shift={(.075, 0)}, draw, decoration={gapped brace}, decorate, /yquant/gapped brace/apply shift, every node/.append style={shape=yquant-text, anchor=west, align=left, shift={(.05, 0)}, pos=-1}!
            This style is installed for every \gate{output} label that is attached to a multi\hyp qubit register.
            \Yquant{} additionally inserts a straight line that connects the topmost and the bottom\hyp most register at their right ends.
            The default style turns this line into a brace and places the description at the appropriate position.
            See \style{/yquant/every multi label} for a more detailed explanation.
         \end{option}
      
      \subsection{General styling}\unskipOpt
         \begin{option}{every circuit}!every node/.prefix style={transform shape}, every label/.prefix style={transform shape=false}!
            Style that is installed for every \tex!yquant! and \tex!yquant*! environment, as if it had been given as an option.
            Since version 0.1.2, the style's default path is, as with all other styles, \texttt{/tikz}.
            The default style will make all nodes (which in particular means, all gates) respect outer canvas transformations.
            Due to \TikZ{} bug \href{https://github.com/pgf-tikz/pgf/issues/843}{\#843}, this must be undone for \texttt{label}s.
         \end{option}
         
         \begin{option}{every wire}!draw!
            This style is installed whenever a wire is drawn.
         \end{option}
         
         \begin{option}{every qubit wire}!!
            This style is installed whenever a wire for a register of type \gate{qubit} is drawn.
         \end{option}
         
         \begin{option}{every cbit wire}!!
            This style is installed whenever a wire for a register of type \gate{cbit} is drawn.
         \end{option}
         
         \begin{option}{every qubits wire}!!
            This style is installed whenever a wire for a register of type \gate{qubits} is drawn.
         \end{option}
         
         \begin{option}{every control line}!draw!
            This style is used to draw the vertical control line that connects controlled operations and their controls.
         \end{option}
         
         \begin{option}{every control}!shape=yquant-circle, anchor=center, radius=.5mm!
            This style is used to draw the node for a control, both positive and negative.
         \end{option}
         
         \begin{option}{every positive control}!fill=black!
            This style is installed for every positive control (i.e., one that conditions on the register being in state $\ket1$ or $1$).
         \end{option}
         
         \begin{option}{every negative control}!draw!
            This style is installed for every negative control (i.e., one that conditions on the register being in state $\ket0$ or $0$).
         \end{option}
         
         \begin{option}{every operator}!anchor=center!
            This style is installed for every gate (and also pseudo\hyp gates such as the \gate{slash} operator) that acts on one or multiple registers.
         \end{option}
         
         \begin{option}{every multi line}!draw, decoration={snake, amplitude=.25mm, segment length=5pt}, decorate!
            This style is used to draw the vertical line that connects discontiguous slices of sub\hyp gates.
         \end{option}
         
         \begin{option}{this operator}!!
            This style is appended to the current style installed for an operator; it should be used only locally to overwrite any global configuration effect.
         \end{option}
         
         \begin{option}{this control}!!
            This style is appended to the current style installed for a control; it should be used only locally to overwrite any global configuration effect.
         \end{option}
         
         \begin{option}{operator style}!/yquant/this operator/.append style={#1}!
            This is a shorthand that can be used to modify the appearance of the current operator.
         \end{option}
         
         \begin{option}{control style}!/yquant/every control line/.append style={#1}, /yquant/this control/.append style={#1}!
            This is a shorthand that can be used to modify the appearance of the current control and its associated line.
         \end{option}
         
         \begin{option}{style}!/yquant/operator style={#1}, /yquant/control style={#1}!
            This is a shorthand that modifies the appearance of both the current operator and any controls or control lines.
         \end{option}
         
         \begin{option}{operator/multi as single}!/yquant/every multi line/.style=/yquant/every control line!
            This option is automatically set for certain gates such as the \gate{swap} or the \gate{zz} gate.
            For those gates, neighboring registers will be treated as discontiguous; and this style will enforce their connecting line to have the style used by control lines.
            
            The default \style{/yquant/every multi line} is a wavy line; this allows to distinguish discontiguous multi\hyp qubit gates from multiple single\hyp qubit gates when using controls.
            Still, some gates have such an established appearance that---despite being logically misleading---we rather use the same style as for a control line.
         \end{option}
      
      \subsection{Styles for operators}\unskipOpt
         \begin{option}{operators/every barrier}!shape=yquant-line, dashed, draw!
            This style is installed for every \gate{barrier} pseudo\hyp gate, i.e., the one that is used to explicitly denote a separation between ``before'' and ``after'' within the circuit.
         \end{option}
      
         \begin{option}{operators/every box}!shape=yquant-rectangle, draw, align=center, inner xsep=1mm, x radius=2mm, y radius=2.47mm!
            This style is installed for every \gate{box} operator.
         \end{option}
         
         \begin{option}{operators/every custom gate}!/yquant/operators/this subcircuit box/.append style={draw=none, inner sep=0pt}, /yquant/register/default name=!
            This style is by default installed for every user\hyp defined gate (since version~0.2).
            User\hyp defined gates are implemented via subcircuits; this style suppresses the box that surrounds the subcircuit and by default suppresses all register names.
            This allows a seamless integration of the gate/subcircuit into the main circuit, without putting particular emphasis to the fact that what was defined as the custom gate indeed belongs together.
         \end{option}
         
         \begin{option}{operators/every dmeter}!shape=yquant-dmeter, x radius=2mm, y radius=2mm, fill=white, draw!
            This style is installed for every \gate{dmeter} gate.
            The \texttt{yquant-dmeter} shape consists of a rectangle whose right side is replaced by a circle, resembling the letter ``D.''
         \end{option}
         
         \begin{option}{operators/every h}!/yquant/operators/every box!
            This style is installed for every \gate{h} (Hadamard) operator.
         \end{option}
         
         \begin{option}{operators/every measure}!shape=yquant-measure, x radius=4mm, y radius=2.5mm, draw!
            This style is installed for every \gate{measure} gate.
            The \texttt{yquant-measure} shape is a rectangle that contains a ``meter'' symbol.
            It allows for a text to be put inside (e.g., a basis), which then shifts the meter symbol accordingly.
         \end{option}
         
         \begin{option}{operators/every measure meter}!draw, -{Latex[length=2.5pt]}!
            This style is applied to the path that resembles the ``meter'' symbol that is drawn by the \texttt{yquant-measure} shape.
            Due to the default style, the \TikZ{} library \pkg{arrows.meta} is automatically loaded with \Yquant.
         \end{option}
         
         \begin{option}{operators/every not}!shape=yquant-oplus, radius=1.3mm, draw!
            This style is installed for every \gate{not} or \gate{cnot} gate (which are synonyms, and actually do the same as the Pauli~$\sigma_x$ gate).
            The \texttt{yquant-oplus} shape resembles the addition\hyp modulo\hyp two symbol $\oplus$.
         \end{option}
         
         \begin{option}{operators/every pauli}!/yquant/operators/every box!
            This style is installed for every Pauli operator, i.e., \gate{x}, \gate{y}, and \gate{z}.
         \end{option}
         
         \begin{option}{operators/every phase}!shape=yquant-circle, radius=.5mm, fill!
            This style is installed for every \gate{phase} gate $\ketbra00 + \ee^{\ii\phi} \ketbra11$.
         \end{option}
         
         \begin{option}{operators/every slash}!shape=yquant-slash, x radius=.5mm, y radius=.7mm, draw!
            This style is installed for every \gate{slash} pseudo\hyp gate, i.e., the one that is used to indicate that a single register line actually denotes multiple registers.
         \end{option}
         
         \begin{option}{operators/every subcircuit}!!
            This style is installed for every \gate{subcircuit}.
         \end{option}
         
         \begin{option}{operators/every subcircuit box}!/yquant/operators/every box!
            This style is installed for every \gate{subcircuit}.
            Note that in contrast to all other styles such as \style{/yquant/operators/every subcircuit} or \style{/yquant/this operator}, this style is only applied to the ``container'' node of the subcircuit, but not to the elements in the subcircuit themselves.
         \end{option}
         
         \begin{option}{subcircuit box style}!/yquant/operators/every subcircuit box/.append style={#1}!
            This is a shorthand to apply styles to the subcircuit box only.
         \end{option}
         
         \begin{option}{operators/this subcircuit box}!!
            This style is appended to the current style installed for the \gate{subcircuit}, but will not apply to its contents.
            Additionally, this style will be reset to an empty style at the beginning of each subcircuit, so that it really only applies to exactly the subcircuit box it is explicitly specified on, not to nested subcircuit boxes.
         \end{option}
         
         \begin{option}{this subcircuit box style}!/yquant/operators/this subcircuit box/.append style={#1}!
            This is a shorthand to apply styles to the current subcircuit box only.
         \end{option}
         
         \begin{option}{operators/every swap}!shape=yquant-swap, radius=.75mm, draw!
            This style is installed for every \gate{swap} gate that interchanges two qubits.
            The \texttt{yquant-swap} shape consists of a single cross.
         \end{option}
         
         \begin{option}{operators/every wave}!shape=yquant-circle, radius=.5mm, fill!
            This style is installed for every \gate{correlate} gate.
         \end{option}
         
         \begin{option}{operators/every x}!/yquant/operators/every pauli!
            This style is installed for every Pauli operator $\sigma_x$, i.e., \gate{x}.
         \end{option}
         
         \begin{option}{operators/every xx}!shape=yquant-rectangle, radius=.75mm, draw!
            This style is installed for every \gate{xx} gate in symmetrized notation ($\ketbra{++}{++} + \ketbra{+-}{+-} + \ketbra{-+}{-+} - \ketbra{--}{--}$).
         \end{option}
         
         \begin{option}{operators/every y}!/yquant/operators/every pauli!
            This style is installed for every Pauli operator $\sigma_y$, i.e., \gate{y}.
         \end{option}
         
         \begin{option}{operators/every z}!/yquant/operators/every pauli!
            This style is installed for every Pauli operator $\sigma_z$, i.e., \gate{z}.
         \end{option}

         \begin{option}{operators/every zz}!shape=yquant-circle, radius=.5mm, fill!
            This style is installed for every \gate{zz} gate (aka \textsc{CPhase}) in symmetrized notation ($\ketbra{00}{00} + \ketbra{01}{01} + \ketbra{10}{10} - \ketbra{11}{11}$).
         \end{option}
         
   \section{Doing the impossible}\label{sec:tikz}
      \Yquant{} will almost certainly never be able to do everything an author has in mind.
      Sometimes, there is the need to draw something non\hyp standard, and this cannot be implemented in the \Yquant{} language.
      However, since \Yquant{} is a layer on top of \TikZ, it should be very hard to find something (meaningful) that cannot be done by combining the power of both packages.
      
      Before or after any gate, you may interrupt the \Yquant{} instructions to perform arbitrary \TikZ{} path operations.
      After every such operation, \Yquant{} will automatically restart its parser so that you can fluently jump between \Yquant{} and \TikZ{} code.
      You can even interject arbitrary \TeX{} code (or, say, low\hyp level \pkg{pgf} commands); however, then, \Yquant{} is not able to restart its parser.
      For this reason, after the last command in a block of \TeX{} commands, you must issue \tex!\yquant!, which then re\hyp enables the \Yquant{} language.
      
      The feature to perform arbitrary \TikZ{} operations is powerful in itself, but would be of limited use were there no way to access the elements in the quantum circuit.
      \Yquant{} provides a global attribute \texttt{name} that can be assigned to every gate.
      All quantum operations are in fact \TikZ{} nodes, and the name you give to them then becomes a \TikZ{} name, which you can easily reference to get the coordinates of a particular operator.
      Note that the name you specify is only available if a single register is targeted.
      The name is suffixed by \tex!-\idx!, where \tex!\idx! refers to the (zero\hyp based) index of the operation ordered from top to bottom (i.e., if an operator acts on two qubits and should be named \texttt{op}, the topmost operator will be available as \texttt{op-0} and the second as \texttt{op-1}).
      Multiple slices in a discontiguous multi\hyp register are additionally suffixed by \texttt{-s\textit{<slice index>}}.
      All controls are also named, suffixed by \tex!-p\idx! or \tex!-n\idx! for positive and negative controls (i.e., the topmost positive control of the previous operator will be available as \texttt{op-p0}).
      Counters for target registers, positive, and negative controls are all independent.
      Finally, you can even access names within a subcircuit, provided you give a name to the subcircuit.
      All nodes in the subcircuit will then have the name \texttt{\textit{<subcircuit name>}-\textit{<name specified in the subcircuits>}}.
      For nested subcircuits, you will get multiple prefixes.
      
      All \Yquant{} shapes have the anchors available you would typically expect from a \TikZ{} shape of the given outline.
      Before version~0.1.2, \Yquant{} shapes needed to provide a \texttt{circuit} anchor and projection anchors.
      These were removed in version~0.1.2 in favor of the common \texttt{center} anchor and clipping paths.
      The latter is a \Yquant{} extension to \TikZ{} shapes: it is an additional path that must be declared for a given shape.
      This path has to provide the ``clipping outline,'' i.e., anything that should not contain register or control lines.
      There may be a difference between horizontal and vertical clipping outlines.
      To understand clipping paths, \Yquant's drawing pipeline needs to be explained.
      \begin{itemize}
         \item In a first run---this is what happens directly at the position where you type the gate command---\Yquant{} will ``virtually'' draw the gates in order to determine their dimensions and calculate register heights.
            The actual drawing commands are written to a macro (this is the cause that some macros must be preceded by \tex!\protect! if used in a gate \texttt{value}).
         \item When \tex!\end{yquant}! is encountered, the actual drawing commands are executed.
         \item Unless the operation changes the wire type or style, do the following (first two items for every register at which an operator node has to be created).
            \begin{itemize}
               \item Create the operator node at the appropriate position.
               \item Call \tex!\pgfshapeclippath! on the newly created node.
                  This will first determine whether the node was stroked; if not, \tex!\pgflinewidth! is set to zero.
                  Then, it will call the horizontal clipping path, which is supposed to create some soft path commands.
                  Those soft path commands are collected in a macro on a per\hyp register basis and the soft path is cleared.
                  The same happens for the vertical clipping path, which is collected in a macro on a per\hyp operation basis.
               \item If control lines or multi lines are to be drawn, the vertical clipping path commands are now executed and installed as an inverted\footnote{Inverting the clipping has two consequences: First, the region of inversion in vertical direction is given by the width of the operators. The line cannot be wider than the operator. Second, if you specify a register multiple times, whether as target, control, or mixed, funny effects can be expected, as the clipping region is inverted multiple times. Note that using a register more than once is always an error, but \Yquant{} does not check for it due to the high overhead.} clipping path.
               \item Control lines and multi lines are drawn (in this order) from one to the next \texttt{center} anchor.
                  Due to the clipping commands, this will create a perfect connection with the shape of the gate, but even transparent gates are possible without the lines being visible.
            \end{itemize}
         \item If the operation changes the wire type or style, or if there is no operation left on this register, the following is done.
            \begin{itemize}
               \item Load the clipping paths accumulated for all the gates acting on this register and install the inverted clipping.
               \item Draw the wire as one continuous line from where the last wire ended (or the beginning of the circuit) to the center of the last gate, or to the common end position for all wires of the circuit.
               \item Remove the clipping paths stored so far on this register, apart from the clipping on the last gate (which will be needed again if this was not the end of the circuit).
            \end{itemize}
      \end{itemize}
   
   \section{Reference: Gates and operations}\label{sec:gates}
      This section lists all operations \Yquant{} currently understands.
      It also details all arguments that can be given to customize the operation, apart from \texttt{name}, which is always available.
      Note that the \tex![value=<value>]! attribute can (and should) alternatively be given as a braced expression that follows the name of the register.
      
      \subsection{\texorpdfstring{\yquant!addstyle!}{addstyle}}\label{gate:addstyle}
         Syntax: \yquant!setstyle <target>;! \\
         This is an invisible pseudo\hyp gate that immediately changes the \TikZ{} style with which the register lines of all target registers are drawn.
         It adds to the styles that are already installed.
         Use \gate{setstyle} to replace styles.
         It may not span multiple registers and does not allow for controls.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![value=<styles>]! (required) \\
               Denotes the new styles; this should be a string that could be passed to \tex!\tikzset!.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!align!}{align}}\label{gate:align}
         Syntax: \yquant!align <target>;! \\
         This is an invisible pseudo\hyp gate that enforces all affected registers to share a common horizontal position for their next gate, which is determined by the largest position of all gates involved.
         It may not span multiple registers and does not allow for controls.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!barrier!}{barrier}}\label{gate:barrier}
         Syntax: \yquant!barrier <target>;! \\
         This is a pseudo\hyp gate that denotes some physical barrier that ensures execution with a specific timing; it is basically a visible version of the \hyperref[gate:align]{\yquant!align!} gate, denoted by a vertical line.
         It may span multiple registers, but does not allow for controls.
         The style \style{/yquant/operators/every barrier} is installed.
         
         \emph{Possible attributes:} none
         
      \subsection{\texorpdfstring{\yquant!box!}{box}}\label{gate:box}
         Syntax: \yquant!box <target> | <pcontrol> ~ <ncontrol>;! \\
         This is a generic register of a rectangular shape that can be filled with arbitrary content.
         It may span multiple registers and allows for controls.
         The style \style{/yquant/operators/every box} is installed.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![value=<value>]! \\
               Denotes the content of the box.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!cbit!}{cbit}}\label{gate:cbit}
         Syntax: \yquant!cbit <name>[<len>];! \\
         Declares a register of type \texttt{cbit}.
         
         \emph{see \hyperref[gate:qubit]{\yquant!qubit!}}
      
      \subsection{\texorpdfstring{\yquant!correlate!}{correlate}}\label{gate:correlate}
         Syntax: \yquant!correlate <target>;! \\
         This is a pseudo\hyp gate that indicates a correlation (usually a Bell\hyp state) present between the multi\hyp registers involved.
         This gate should span multiple registers and does not allow for controls.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!cnot!}{cnot}}\label{gate:cnot}
         Syntax: \yquant!cnot <target> | <pcontrol> ~ <ncontrol>;! \\
         This is a synonym for the \gate{not} gate.
         Note that despite its name, controls are not mandatory and also here, the style \style{/yquant/operators/every not} is installed.
      
      \subsection{\texorpdfstring{\yquant!discard!}{discard}}\label{gate:discard}
         Syntax: \yquant!discard <target>;! \\
         This is an invisible pseudo\hyp gate that changes the type of all target registers to \gate{nobit}, i.e., no line will be drawn for them.
         This has effect already for the outgoing line of the last visible gate on the target registers.
         The gate may not span multiple registers and does not allow for controls.
         To change into a register type on\hyp the\hyp fly into something different from \gate{nobit}, use the \gate{settype} pseudo\hyp gate.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!dmeter!}{dmeter}}\label{gate:dmeter}
         Syntax: \yquant!dmeter <target>;! \\
         This is a measurement gate, denoted by a ``D'' shape.
         It changes the type of all targets involved.
         It may span multiple registers, but does not allow for controls.
         The style \style{/yquant/operators/every dmeter} is installed.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![value=<value>]! \\
               Allows to specify a text that will be included inside the gate, possible enlarging its width.
               For outside texts, use \TikZ{} \texttt{label}s instead.
            \item \yquant![type=<qubit|cbit|qubits>]! \\
               Allows to specify the type into which the affected targets are converted.
               Default is \gate{cbit}.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!h!}{h}}\label{gate:h}
         Syntax: \yquant!h <target> | <pcontrol> ~ <ncontrol>;! \\
         This is a Hadamard gate, $\frac{1}{\sqrt2} \bigl( \ketbra00 + \ketbra01 + \ketbra10 - \ketbra11 \bigr)$, denoted by a rectangle that contains the letter $H$.
         It may not span multiple registers, but allows for controls. \\
         The style \style{/yquant/operators/every h} is installed.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!hspace!}{hspace}}\label{gate:hspace}
         Syntax: \yquant!hspace <target>;! \\
         This is an invisible pseudo\hyp gate that inserts a certain amount of white space into all target registers.
         It may not span multiple registers and does not allow for controls.
         
         \emph{Possible attributes}:
         \begin{itemize}
            \item \yquant![value=<dim>]! (required) \\
               Gives the amount of white space that is to be inserted. Must be a valid \TeX{} dimension.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!init!}{init}}\label{gate:init}
         Syntax: \yquant!init <target>;! \\
         This is a pseudo\hyp gate that (re)initializes a registers to a given state.
         It may span multiple registers, but does not allow for controls.
         The style \style{/yquant/every label} is installed.
         Note that this pseudo\hyp gate, unlike all others, behaves differently if it the first operation acting on a register: in this case, it does not increment the horizontal position, but uses the space available to the left.
         If it is the first operation, the style \style{/yquant/every initial label} is installed additionally.
         For multiple registers, the style \style{/yquant/every multi label} is installed at the end, and a path is constructed that extends from the left end of the first to the left end of the last register in the multi\hyp register compound.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![type=<qubit|cbit|qubits>]! \\
               Allows to specify the type into which the affected target registers are converted.
               Default is the type of the first target register that is different from \gate{nobit}, or \gate{qubit} if they all are \gate{nobit}.
               The style \texttt{/yquant/every <type> label} is installed additionally.
            \item \yquant![value=<value>]! (required) \\
               Denotes the label that is printed to the left of the wire.
               
               Inside the value, \tex!\idx! expands to the current index within the register list.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!measure!}{measure}}\label{gate:measure}
         Syntax: \yquant!measure <target>;! \\
         This is a measurement gate, denoted by a rectangle with a meter symbol.
         It changes the type of all targets involved.
         It may span multiple registers, but does not allow for controls.
         The style \style{/yquant/operators/every measure} is installed.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![type=<qubit|cbit|qubits>]! \\
               Allows to specify the type into which the affected targets are converted.
               Default is \gate{cbit}.
            \item \yquant![value=<value>]! \\
               Allows to specify a text that will be included at the bottom of the rectangle (which will shift the meter symbol upwards accordingly).
               For outside texts, use \TikZ{} \texttt{label}s instead.
         \end{itemize}
         
      \subsection{\texorpdfstring{\yquant!nobit!}{nobit}}\label{gate:nobit}
         Syntax: \yquant!nobit <name>[<len>];! \\
         Declares a register of type \gate{nobit}.
         The \texttt{<name>} must be a self\hyp chosen name for the register which was not previously used as a register name in this \tex!yquant! environment.
         Names are case\hyp insensitive.
         The register can be made into a vector register by specifying \texttt{<len>} (default \tex!1!).
         
         \clearpage
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![out]! or \yquant![ancilla]! (required in subcircuits) \\
               \emph{see \gate{qubit}}
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!not!}{not}}\label{gate:not}
         Syntax: \yquant!not <target> | <pcontrol> ~ <ncontrol>;! \\
         This is a \textsc{not} gate, $\ketbra01 + \ketbra10$, denoted by the $\oplus$ symbol.
         It may not span multiple registers, but allows for controls.
         Due to its common usage, the synonymous gate \hyperref[gate:cnot]{\yquant!cnot!} is provided.
         The style \style{/yquant/operators/every not} is installed.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!output!}{output}}\label{gate:output}
         Syntax: \yquant!output <target>;! \\
         This is a pseudo\hyp gate that allows to write some text at the very end of the register line.
         It may only be specified once per register.
         It may span multiple registers, but does not allow for controls.
         The style \style{/yquant/every output} is installed, and also the style \texttt{/yquant/every <type> output}, where \texttt{<type>} is the type of the affected register (at the time of printout).
         For outputs on multiple registers, the style \style{/yquant/every multi output} is installed instead of the two previously mentioned ones; and additionally, a path is constructed that extends from the first to the last register in the multi\hyp register compound.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![value=<value>]! (required) \\
               Denotes the text that is to be printed.
               Inside the value, \tex!\idx! expands to the current index within the register list.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!phase!}{phase}}\label{gate:phase}
         Syntax: \yquant!phase <name> | <pcontrol> ~ <ncontrol>;! \\
         This is a phase gate, $\ketbra00 + \ee^{\ii\phi} \ketbra11$, denoted by a filled circle.
         It may not span multiple registers, but allows for controls (and should have them, to make any sense).
         The style \style{/yquant/operators/every phase} is installed.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![value=<value>]! (required) \\
               Denotes the angle $\phi$ that is to be printed together with the gate.
               Position and appearance can be influenced by setting the position of \TikZ{} labels, as this is internally used.
               Note that at the moment, it is not possible to change any label options on a gate\hyp type basis, only locally or fully globally (\TikZ{} feature request \href{https://github.com/pgf-tikz/pgf/issues/811}{\#811}).
         \end{itemize}
         
      \subsection{\texorpdfstring{\yquant!qubit!}{qubit}}\label{gate:qubit}
         Syntax: \yquant!qubit <name>[<len>];! \\
         Declares a register of type \texttt{qubit}.
         The \texttt{<name>} must be a self\hyp chosen name for the register which was not previously used as a register name in this \tex!yquant! environment.
         Names are case\hyp insensitive.
         The register can be made into a vector register by specifying \texttt{<len>} (default \tex!1!).
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![after=<regname>]! \\
               If given, the register will start not at the left of the circuit but instead at the position at which the last gate in the register \texttt{<regname>} ended.
               
               This attribute may not be given in combination with \yquant![in]! or \yquant![inout]!.
            \item \yquant![in]!, \yquant![out]!, \yquant![inout]!, or \yquant![ancilla]! \\
               Default: \yquant![ancilla]! for top\hyp level circuits (do not change there); \yquant![inout]! for subcircuits.
               
               Determines how a subcircuit interacts with its parent circuit.
               
               Registers declared with the \yquant![ancilla]! attribute are available only to the subcircuit; they cannot be connected to an outside wire.
               
               Registers declared with the \yquant![in]! or \yquant![inout]! attribute will expect an outer wire of the same type to be present and will then be identical with this outer wire.
               Any changes applied to the wire within the subcircuit automatically also happen on the associated outer wire.
               If the attribute is \yquant![in]!, the wire will automatically be discarded at the end of the subcircuit (and hence also in the outer circuit, where it may be re\hyp initialized).
               This is different from applying the \gate{discard} gate in that the wire will still extend until the end of the subcircuit and may thus receive proper \gate{output}s.
               
               Registers declared with the \yquant![out]! attribute will expect a discarded outer wire to be present, which will be initialized to a \texttt{qubit} at the beginning of the subcircuit, and from then on be identical with the outer wire.
            \item \yquant![value=<value>]! \\
               Denotes the label that is printed to the left of the wire.
               If the value is omitted, the default is used (\style{/yquant/register/default name}, preinitialized to \tex!\regidx!).
               
               Inside the value, \tex!\reg! expands to \texttt{<name>}, \tex!\len! expands to \texttt{<len>}, \tex!\idx! expands to the current index within the vector register ($0 \leq \text{\tex!\idx!} < \text{\texttt{<len>}}$), and \tex!\regidx! expands to \tex!\reg! if \texttt{<len>} is one, or to \tex!\reg[\idx]! else.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!qubits!}{qubits}}\label{gate:qubits}
         Syntax: \yquant!qubits <name>[<len>];! \\
         Declares a register of type \texttt{qubits}.
         
         \emph{see \hyperref[gate:qubit]{\yquant!qubit!}}
      
      \subsection{\texorpdfstring{\yquant!setstyle!}{setstyle}}\label{gate:setstyle}
         Syntax: \yquant!setstyle <target>;! \\
         This is an invisible pseudo\hyp gate that immediately changes the \TikZ{} style with which the register lines of all target registers are drawn.
         It replaces all previous styles.
         Use \gate{addstyle} to accumulate styles.
         It may not span multiple registers and does not allow for controls.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![value=<styles>]! (required) \\
               Denotes the new styles; this should be a string that could be passed to \tex!\tikzset!.
         \end{itemize}
         
      \subsection{\texorpdfstring{\yquant!settype!}{settype}}\label{gate:settype}
         Syntax: \yquant!settype <target>;! \\
         This is an invisible pseudo\hyp gate that immediately changes the type of the targets registers, taking effect with the output line extending from the last drawn gate.
         It may not span multiple registers and does not allow for controls.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant![value=<qubit|cbit|qubits>]! (required) \\
               Denotes the new type that is assigned to all registers.
               To change the type to \gate{nobit}, use the \hyperref[gate:discard]{\yquant!discard!} pseudo\hyp gate instead.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!setwire!}{setwire}}\label{gate:setwire}
         \emph{Deprecated as of version~0.1.2. Use \gate{settype} instead.}
      
      \subsection{\texorpdfstring{\yquant!slash!}{slash}}\label{gate:slash}
         Syntax: \yquant!slash <target>;! \\
         This is a pseudo\hyp gate used to denote that a single line actually represents multiple registers.
         It is drawn as a short slash through the line of the register.
         Note that this gate, in contrast to all others, is positioned on the line extending from the last gate or the initialization line of the registers and does not advance the register's horizontal position.
         The style \style{/yquant/operators/every slash} is installed.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!subcircuit!}{subcircuit}}\label{gate:subcircuit}
         Syntax: \yquant!subcircuit <target>;! \\
         This is a subcircuit gate which inserts independent quantum circuits at the current position within the circuit.
         It may span multiple registers, but is never split into contiguous slices.
         It allows for controls and may change the type of any target involved, depending on the particular subcircuit.
         The style \style{/yquant/operators/every subcircuit} is installed.
         
         \emph{Possible attributes:}
         \begin{itemize}
            \item \yquant!value=<subcircuit>! (required) \\
               Denotes the content of the subcircuit.
               It is specified in the usual syntax of \Yquant.
               Note that, regardless of the outer environment, a subcircuit always implicitly uses the unstarred form, i.e., you must declare every register explicitly before its first usage.
               This is to make sure that the interface of the circuit, i.e., which registers are taken as input and/or output parameters and in which order, is not accidentally mistaken.
               
               The mapping between input and output registers is trivial for single\hyp qubit uses.
               For multi\hyp qubit uses, it works in the following way---in short, it matches in visual order.
               You declare input and output registers by using the appropriate attributes on the \gate{qubit}, \gate{cbit}, \gate{qubits} (or even \gate{nobit}) gates.
               The list of all non\hyp ancillas, from the topmost to the bottom\hyp most, forms the list of parameter registers of the subcircuit.
               This is exactly the number of registers that must be supplied within one multi\hyp qubit target.
               Also within the multi\hyp qubit target, we sort all registers from the topmost to the bottom\hyp most (in the order as they visually appear, not the order in which they are entered).
               Those two lists of equal length are then mapped $1:1$ to each other.
               Intermixing with ancillas is possible at every position and will lead to a vertical shift of the wires, until all registers, inner and outer, can be displayed flawlessly.
               
               As subcircuits follow the same rules as ordinary circuits, it is possible to mix them with arbitrary \TeX{} code, and also to access named gates within the subcircuit---but note that named gates in the outer circuit cannot be accessed (at least unless you play with the \texttt{name prefix} key in \TikZ).
               In order to access inner nodes from the outer circuit, the subcircuit itself must be named; the inner nodes are then prefixed by the name of the subcircuit and a dash.
               
               It is possible to nest subcircuits arbitrarily.
         \end{itemize}
      
      \subsection{\texorpdfstring{\yquant!swap!}{swap}}\label{gate:swap}
         Syntax: \yquant!swap <targets> | <pcontrol> ~ <ncontrol>;! \\
         This is the two\hyp qubit \textsc{swap} gate $\ketbra{00}{00} + \ketbra{01}{10} + \ketbra{10}{01} + \ketbra{11}{11}$ that exchanges two qubits.
         It is denoted by crosses at the affected registers which are connected by a control line.
         It may span multiple registers (in fact, it should always span exactly two registers, though \Yquant{} does not enforce this), and it allows for controls.
         However, refrain from combining \emph{multiple} two\hyp qubit targets \emph{together} with controls.
         The control line will extend from the first to the last of all registers involved in the operation, so that it is impossible to discern visually which registers should actually be swapped.
         Using multiple swaps without controls in one operation is fine, as well as a single controlled swap.
         The style \style{/yquant/operators/every swap} is installed.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!x!}{x}}\label{gate:x}
         Syntax: \yquant!x <target> | <pcontrol> ~ <ncontrol>;! \\
         This is a Pauli $\sigma_{\symup x}$ gate $\ketbra01 + \ketbra10$, denoted by a rectangle that contains the letter $X$.
         It may not span multiple registers, but allows for controls. \\
         The style \style{/yquant/operators/every x} is installed.
         
         \emph{Possible attributes:} none
         
      \subsection{\texorpdfstring{\yquant!xx!}{xx}}\label{gate:xx}
         Syntax: \yquant!xx <targets>;! \\
         This is a symmetric flip gate, denoted by joined open squares.
         It should span multiple registers and it allows for controls.
         The same warnings as for the \gate{swap} gate apply.
         The style \style{/yquant/operators/every xx} is installed.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!y!}{y}}\label{gate:y}
         Syntax: \yquant!y <target> | <pcontrol> ~ <ncontrol>;! \\
         This is a Pauli $\sigma_{\symup y}$ gate $-\ii\ketbra01 + \ii\ketbra10$, denoted by a rectangle that contains the letter $Y$.
         It may not span multiple registers, but allows for controls. \\
         The style \style{/yquant/operators/every y} is installed.
         
         \emph{Possible attributes:} none
      
      \subsection{\texorpdfstring{\yquant!z!}{z}}\label{gate:z}
         Syntax: \yquant!z <target> | <pcontrol> ~ <ncontrol>;! \\
         This is a Pauli $\sigma_{\symup z}$ gate $\ketbra00 - \ketbra11$, denoted by a rectangle that contains the letter $Z$.
         It may not span multiple registers, but allows for controls. \\
         The style \style{/yquant/operators/every z} is installed.
         
         \emph{Possible attributes:} none
         
      \subsection{\texorpdfstring{\yquant!zz!}{zz}}\label{gate:zz}
         Syntax: \yquant!zz <targets>;! \\
         This is a symmetric phase gate, denoted by joined filled circles.
         It should span multiple registers, but does not allow for controls.
         The same warnings as for the \gate{swap} gate apply.
         The style \style{/yquant/operators/every zz} is installed.
         
         \emph{Possible attributes:} none
         
   
   \section{Examples}\label{sec:examples}
      This section will contain lots of examples.
      On the left\hyp hand side, the output is given, while the code to construct the example is on the right.
      All examples that are provided originate from the examples supplied with \pkg{qasm}, \pkg{qcircuit}, and \pkg{quantikz}.
      We will essentially follow their manuals example\hyp by\hyp example, which gives a nice comparison in how to achieve the given feature using these packages and \Yquant{} instead.
      All examples of course require inclusion of the \Yquant{} package in the preamble, and some also require \pkg{braket}.
      
      \subsection{\pkg{qasm} documentation}
      \begingroup%
         \yquantset{register/default name=$\ket{\reg_{\idx}}$}%
         The \pkg{qasm} documentation most often names the registers in the way $\ket{\mathrm{register}_{\mathrm{index}}}$.
         This can be achieved by writing
         \begin{minted}{tex}
qubit {$\ket{<name>_{\idx}}$} <name>[<len>];
         \end{minted}
         but if you want to realize this naming scheme for all circuits in your document, it is more convenient to say
         \begin{minted}{tex}
\yquantset{register/default name=$\ket{\reg_{\idx}}$}
         \end{minted}
         in the preamble, as is done here.
         
         Note that since version~0.3, \Yquant{} supports the \pkg{qasm} syntax, see \cref{sec:foreign:qasm}
         
         \begin{example}[test1 (create an EPR pair)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[2];
      
      h q[0];
      cnot q[1] | q[0];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \clearpage
         \begin{example}[test2 (simple teleportation circuit)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[3];
      
      h q[1];
      cnot q[2] | q[1];
      cnot q[1] | q[0];
      h q[0];
      measure q[0-1];
      
      z q[2] | q[1];
      x q[2] | q[0];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \begin{example}[test3 (swap circuit)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[2];
      
      cnot q[1] | q[0];
      cnot q[0] | q[1];
      cnot q[1] | q[0];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \clearpage
         \begin{example}[test4 (quantum fourier transform on three qubits)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit j[3];
      
      h j[0];
      box {$S$} j[0] | j[1];
      box {$T$} j[0] | j[2];
      h j[1];
      box {$S$} j[1] | j[2];
      h j[2];
      swap (j[0, 2]);
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \begin{example}[test5 (demonstrate arbitrary qubit matrix ops)]
            \begin{codeexample}
% \usepackage{amsmath}
\begin{tikzpicture}
   \begin{yquant}
      qubit j[2];
      
      box {$\begin{bmatrix}
         e^{i \alpha} & 0 \\
         0 & e^{-i \alpha}
      \end{bmatrix}$} j[1] | j[0];
      box {$\begin{bmatrix}
         \cos\theta & -\sin\theta \\
         \sin\theta & \cos\theta
      \end{bmatrix}$} j[0];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
            
         \clearpage
         \begin{example}[test6 (demonstrate multiple-qubit controlled single-q-gates)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit j[4];
      
      cnot j[2] | j[0, 1];
      x j[0];
      box {$U$} j[1] | j[0, 2-3];
      h j[2];
      measure j[3];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \begin{example}[test7 (measurement of operator with correction)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[2];
      
      h q[0];
      box {$U$} q[1] | q[0];
      h q[0];
      measure q[0];
      box {$V$} q[1] | q[0];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \clearpage
         \begin{example}[test8 (stage in simplification of quantum teleportation)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket{q_0} = \ket\psi$} q[1];
      qubit {$\ket{q_{\idx}} = \ket0$} q[+2];
      
      h q[1];
      cnot q[1] | q[0];
      cnot q[2] | q[1];
      cnot q[1] | q[0];
      h q[0];
      cnot q[2] | q[1];
      z q[0] | q[2];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
            Note that we left out two Hadamards at the end.
            
            Before version 0.1.1, the recommended approach (which of course still works) to define a vector qubit register with various texts was to use case discrimination on \tex!\idx!, for example in the following manner:
            \begin{minted}{tex}
qubit {$\ket{q_{\idx}} = \ifcase\idx\relax \ket\psi \else \ket0 \fi$} q[3];
            \end{minted}
         \end{example}
         
         \begin{example}[test9 (two-qubit gate circuit implementation of Toffoli)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[3];
      
      box {$\sqrt X$} q[2] | q[1];
      cnot q[1] | q[0];
      box {$\sqrt X^\dagger$} q[2] | q[1];
      cnot q[1] | q[0];
      box {$\sqrt X$} q[2] | q[0];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \clearpage
         \begin{example}[test10 (multi-qubit gates also demonstrates use of classical bits)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket{q_0}$} q;
      cbit {$c_1$} c;
      qubit {$\ket{q_2}$} q[+1];
      
      h q[0];
      box {$U$} (q[0], c);
      box {$S$} q[1];
      box {$U$} (c, q[1]);
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
            Instead of a discontigous vector register, we could also have used three scalar registers.
            The labels chosen for \pkg{qasm} do not fit well to the indices \Yquant{} assigns.
            We might also have used a three\hyp register vector and used the \gate{settype} pseudo\hyp gate to immediately change the second register into a classical one, which would give indices matching the labels---but still, the registers would have a common name, which would make this a very unnatural approach.
         \end{example}
         
         \begin{example}[test11 (user-defined multi-qubit ops)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[3];
      
      h q[0];
      box {$U_{f(x)}$} (q[0, 1]);
      h q[1];
      box {$U_{f(x, y)}$} (q);
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
            Here we used the fact that a vector register can also be addressed as a whole.
            Instead of \tex!(q)!, we could have also written, e.g., \tex!(q[0]-q[2])! or \tex!(q[0-2])!, or enumerated all sub\hyp registers in a comma\hyp separated list.
         \end{example}
         
         \clearpage
         \begin{example}[test12 (multi-qubit controlled multi-qubit operations)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[3];
      
      h q[0];
      box {$U$} (q[1-2]) | q[0];
      h q[0];
      box {$V$} (q[0-1]) | q[2];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
         
         \begin{example}[test13 (three-qubit phase estimation circuit with QFT and controlled-U)]
            \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket{j_{\idx}} = \ket0$} j[3];
      qubit s[2];
      
      h j;
      box {$U^4$} (s) | j[0];
      box {$U^2$} (s) | j[1];
      box {$U$} (s) | j[2];
      h j[0];
      box {$S$} j[1] | j[0];
      h j[1];
      box {$T$} j[2] | j[0];
      box {$S$} j[2] | j[1];
      h j[2];
      measure j;
   \end{yquant}
\end{tikzpicture}
            \end{codeexample*}
         \end{example}
         
         \begingroup%
            \mdfapptodefinestyle{bdBox}{%
               leftmargin=-.12\linewidth,
               rightmargin=-.12\linewidth
            }%
            \begin{example}[test14 (three-qubit FT QEC circuit with syndrome measurement)]
               \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant}
      qubit q[3];
      qubit {$\ket{s_{\idx}} = \ket0$} s[2];
      cbit {$c_{\idx} = 0$} c[2];
      
      h s[0];
      cnot s[1] | s[0];
      cnot s[0] | q[0];
      cnot s[1] | q[1];
      cnot s[1] | s[0];
      h s[0];
      measure s;
      cnot c[0] | s[0];
      cnot c[1] | s[1];
      discard s; % to suppress wires extending until re-initialization
      
      init {$\ket0$} s;
      h s[0];
      cnot s[1] | s[0];
      cnot s[0] | q[1];
      cnot s[1] | q[2];
      cnot s[1] | s[0];
      h s[0];
      measure s;
      
      box {Process\\Syndrome} (s, c);
      box {$\symcal R$} (q) | s, c;
   \end{yquant}
\end{tikzpicture}
               \end{codeexample*}
            \end{example}
         \endgroup%
         
         \clearpage
         \begin{example}[test15 (``D-type'' measurement)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket{q_0} = \ket\psi$} q;
      qubit {$\ket{q_1} = \ket+$} q[+1];
      
      zz (q);
      dmeter {$H Z_\theta$} q[0];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
         \end{example}
            
         \begin{example}[test16 (example from Nielsen paper on cluster states)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket{q_{\idx}} = \ket\psi$} q[2];
      qubit {$\ket{q_2} = \ket\phi$} q[+1];
      qubit {$\ket{q_3} = \ket0$} q[+1];
      
      zz (q[1], q[2]);
      align q;
      cnot q[3] | q[2];
      slash q[0];
      dmeter q[3];
      discard q[2];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
            We needed to include an \gate{align} pseudo\hyp gate to put the slash at the desired position.
            Usually, this would be sufficient to put the \gate{cnot} and the \gate{slash} gate directly under each other, as it is in the \pkg{qasm} example.
            However, the \gate{slash} gate is special in that it does not need horizontal space and is put with only half of the usual operator separation into the circuit (for this reason, it can be put at the beginning of a wire without creating weird shifts with respect to the ``unslashed'' registers---it is put in the initial line that every wire even without an operation has).
            Hence, you should normally only use the \gate{slash} gate as the very first gate in a circuit.
            It is not possible to construct the exact same appearance as in the \pkg{qasm} example.
            Note that \gate{discard} currently just drops the wire directly after the last operation.
         \end{example}
         
         \begin{example}[test17 (example from Nielsen paper on cluster states)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket{q_0} = \ket\psi$} q;
      qubit {$\ket{q_{\idx}} = \ket+$} q[+2];
      qubit {$\ket{q_3} = \ket\phi$} q[+1];
      
      zz q[(0-1), (2-3)];
      zz (q[1-2]);
      dmeter {$H$} q[1-2];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
            This example shows how the multi\hyp qubit delimiter (the parenthesis) can even be used within indices.
         \end{example}
         
         \begin{example}[test18 (multiple-control bullet op)]
            \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket{q_{\idx}} = \ket{\ifcase\idx\relax \psi \or + \or + \or \phi \fi}$} q[4];
      
      zz (q);
      dmeter {$H$} q[1, 2];
   \end{yquant}
\end{tikzpicture}
            \end{codeexample}
            This gate is probably a generalization of \gate{zz}, $\symbb1 - 2 \ketbra{1\dotsm1}{1\dotsm1}$, and indeed since version~0.1.2, we can use \gate{zz} for this purpose.
            This time, we also used the common way to initialize a gate with various identifiers as was done before version~0.1.1, using case distinctions.
         \end{example}
      \endgroup
   
      \clearpage
      \subsection{\pkg{qcircuit} documentation}
      \begingroup%
         \yquantset{operator/separation=3mm}
         For a better orientation, we use the same section headings as the \pkg{qcircuit} manual.
         The manual uses unnamed registers a lot; often, we will use the \tex!yquant*! environment to make things more concise.
         As \pkg{qcircuit} uses a much large separation between the operators than \Yquant's default, we globally say\\*\tex!\yquantset{operator/separation=3mm}!.
         
         \subsubsection{I. Introduction}
            \begin{example}
               \begin{codeexample*}
\begin{tikzpicture}[baseline=(current bounding box.center)]
   \begin{yquant*}
      box {$U$} q[2] | q[0, 1];
   \end{yquant*}
\end{tikzpicture}
$=$
\begin{tikzpicture}[baseline=(current bounding box.center)]
   \begin{yquant*}
      box {$V$} q[2] | q[1];
      cnot q[1] | q[0];
      box {$V^\dagger$} q[2] | q[1];
      cnot q[1] | q[0];
      box {$V$} q[2] | q[0];
   \end{yquant*}
\end{tikzpicture}
               \end{codeexample*}
               Here, we chose to realize the equality using two \tex!tikzpicture!s with appropriately set baselines.
               
               If mangling with the baselines becomes problematic, a different approach would be to use an outer \tex!tikzpicture! with three nodes (left circuit, equals, right circuit); but the circuits themselves are \tex!tikzpictures! again, and nesting those is dangerous (but may work).
               Instead they could have been put into \tex!\savebox!es and just used.
               
               Finally, using nested \tex!tikzpictures! for the outer nodes is not really necessary.
               Not using nodes but putting the two \tex!yquant*! environments in a \TikZ{} \tex!scope! with \texttt{shift} transformation would have also worked.
            \end{example}
      
            \begin{example}
               \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket\psi$} a;
      qubit {$\ket0$} b[2];
      
      h b[1];
      cnot b[0] | b[1];
      cnot b[1] | a;
      h a;
      align a, b;
      measure a;
      measure b[0];
      
      x b[1] | b[0];
      z b[1] | a;
      
      discard a;
      discard b[0];
      output {$\ket\psi$} b[1];
   \end{yquant}
\end{tikzpicture}
               \end{codeexample*}
            \end{example}
            
            \begin{example}
               \begin{codeexample*}
% \usetikzlibrary{fit, quotes}
\begin{tikzpicture}
   \begin{yquant}
      qubit {} msg[3];
      [name=inits]
      qubit {$\ket0$} syndrome[3];
      
      [name=scnot0]
      cnot syndrome[0] | msg[0];
      cnot syndrome[0] | msg[1];
      cnot syndrome[1] | msg[1];
      cnot syndrome[1] | msg[2];
      cnot syndrome[2] | msg[0];
      cnot syndrome[2] | msg[2];
      [name=smeas]
      dmeter {$M_{\symbol{\numexpr`a+\idx}}$} syndrome;
      ["Recovery"]
      box {$\symcal R$} (msg) | syndrome;
      discard syndrome;
   \end{yquant}
   \node[draw, dashed, fit=(inits-2) (scnot0-p0) (smeas-2), "Syndrome Measurement"] {};
\end{tikzpicture}
               \end{codeexample*}
               In this case, an implicit register declaration would not have worked: we would have needed to define the first part of the syndrome register \emph{before} the second part of the message register.
               But this would then have mixed data with syndrome registers in the vertical ordering.
               
               This also is a first demonstration of how to access \Yquant{} objects from within \TikZ.
               We name several elements that visually form the enclosing rectangle; then, we use the \TikZ{} library \texttt{fit} to put a node around them all.
               
               Then we see how to apply an operation to multiple registers in parallel while using the \tex!\idx! macro to still give them a different text.
               Since \tex!\idx! gives a numerical index (zero\hyp based), we exploit the ASCII code (actually, this document is compiled in Unicode mode...) to turn this into a letter.
               
               The example also demonstrates how to put a description next to a gate.
               In general, those descriptions should be realized using the \TikZ{} feature \texttt{label}.
               Using the \TikZ{} library \texttt{quotes}, the label is most easily specified.
               Since the label is not part of the valid arguments and also cannot be found in the \texttt{/yquant} path, it is automatically passed to \style{/yquant/operator style}.
            \end{example}
            
         \clearpage
         \subsubsection{IV. Simple Quantum Circuits}
            \begin{example}
               \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      x q;
   \end{yquant*}
\end{tikzpicture}
               \end{codeexample}
            \end{example}
            
            \paragraph{A. Wires and gates}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      h a;
      align a, b;
      z a;
      x b;
      h a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      box {$U$} a;
      box {$U^\dagger$} b;
      setstyle {->} -;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Since version~0.1.2, \Yquant{} allows to change wire styles by means of the \gate{setstyle} and \gate{addstyle} pseudo\hyp gates.
                  Here, we use the gate on all wires in order to set an arrow style.
                  Note that arrowheads are actually very special in two respects:
                  \begin{itemize}
                     \item \Yquant{} draws continuous wires for as long as possible.
                        In this example, the wire path extends from the very left to the end of the circuit; since version 0.1.2, \Yquant{} does not draw a wire \emph{to} the gate and then a separate one \emph{from} the gate to the next or the end.
                        The only way to force \Yquant{} to draw multiple wires is to change the wire style or type mid\hyp circuit.
                        For example, by saying \yquant!addstyle {} -;!, all wire paths will be separated at the current position, which \emph{in theory} allows to draw arrowsheads on intermediate wires.
                     \item \emph{In practice}, this will not work due to the clipping commands that \Yquant{} installs.
                        Every wire extends from the center of the left to the center of the right gate, and the gate's shape acts as a clipping path.
                        Consequently, though the arrowhead is drawn, it is actually drawn at the center of the gate instead of the \texttt{west} anchor and then clipped away (unless the gate is small, in which case you might still see some fragments of the arrowhead).
                  \end{itemize}
                  Thus, it is currently not possible to use arrowheads on intermediate wires.
                  If you really need to do this (say, for only a single gate), you may experiment with the \TikZ{} \texttt{shorten} keys, which allow you to manually reduce the length of the wire, but the amount of reduction must be hand\hyp computed for every gate.
                  If you need this more often, consider filing a feature request.
               \end{example}
               
            \paragraph{B. CNOT and other controlled single qubits gates}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      cnot a[1] | a[0];
      cnot a[0] | a[1];
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      cnot q[2] | q[0];
      cnot q[0] | q[1-3];
      box {$U$} q[0] | q[2];
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
            \clearpage
            \paragraph{C. Vertical wires}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      box {$U_{\protect\the\numexpr\idx+1}$} q[0, 2] | q[1];
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  There is no direct support for this construction, but as with the initialization of a vector registers, \Yquant{} allows to access the macro \tex!\idx! within an operator \texttt{value}.
                  This macro follows the same rules as the name suffix, i.e., it assigns indices (zero\hyp based) to the target registers in top\hyp to\hyp bottom order, regardless of which order was specified in the target list.
                  Since we instead want a one\hyp based subscript, we need to add one.
                  Note that if you want to output \tex!\idx! directly or within an unexpandable expression, you don't need to take any action.
                  However, here, \tex!\the! is expandable; and since \Yquant{} needs to process all its output twice (first in order to determine the vertical spacing, second to actually typeset), you must manually take care that the command is \emph{not} expanded prematurely by inserting \tex!\protect!.
                  Had you not done this, the subscript would have been ``$1$'' for both operators.
                  Note this is not the case if this macro is used upon creation of a register (as is evident by the fact that the previous examples that used \tex!\ifcase! within the value did not need to say \tex!\protect\ifcase ... \protect\or ... \protect\fi!).
                  Probably we can avoid the need for protection in a future release\dots.
               \end{example}
               
            \paragraph{D. Labeling input and output states}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      qubit {$\ket1$} q[2];
      cnot q[0] | q[1];
      output {$\ket\idx$} q;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      {
         \yquantset{every multi label/.append style={decorate=false, draw=none}}
         init {$\ket{0^k}$} (a[-1]);
      }
      init {$\ket\psi$} (b[-1]);
      qubit {\ifcase\idx\relax$A$\or$B$\fi} c[2];
      [every multi label/.append style={decorate=false, draw=none, every node/.append style={shift={(-.3, 0)}}}]
      init {$\ket\psi$} (c);
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Here, three different styles for the initialization of multi\hyp qubit labels are used.
                  The second one (using a curly brace) corresponds to the default.
                  It is overwritten for the first qubit, and to make this modification local, this is done in a group.
                  The third qubit pair uses an overall label and additionally individual labels on the lines.
                  This is achieved by some trickery: the individual labels are given as initialization labels on the register; the global label is given as an \gate{init} multi\hyp qubit gate.
               \end{example}
               
         \clearpage
         \subsubsection{V. More Complicated Circuits: Multiple Qubit gates and Beyond}
            \paragraph{A. Multiple qubit gates}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      box {$U^\dagger$} (a[-2]);
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {} a;
      cbit {} b;
      nobit ellipsis;
      qubit {} c;
      
      [draw=none]
      box {$\dots$} ellipsis;
      box {$U$} (a, b, ellipsis, c);
      [draw=none]
      box {$\dots$} ellipsis;
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample}
                  This demonstrates how a register of type \gate{nobit} might even be useful if the register is never used.
                  We use \gate{box} registers with disabled border to put the ellipsis dots in place.
               \end{example}
               
               \clearpage
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      box {$\symcal F$} (a[-1]);
      box {$\symcal G$} (a[0, 2]);
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  This demonstrates \Yquant's capabilities of discontiguous multi\hyp qubit gates that was added in version~0.1.2.
                  \Yquant{} automatically splits multi\hyp qubit gates into slices of directly adjacent wires (which, for the $\symcal G$ case, are the single wires \yquant!a[0]! and as second slice \yquant!a[2]!).
               \end{example}
               
            \paragraph{B. Measurements and classical bits}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      measure a;
      dmeter {$\chi$} b;
      measure {$\ket{\xi_\pm}$} c;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  The ``tab'' and ``measure'' type are not supported yet.
                  Extracting a meter symbol on its own will not be supported.
                  If you are interested in the code, have a look at \texttt{yquant-shapes.tex} and search for the \texttt{yquant-measure} shape.
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      [rounded corners]
      box {Codebit} a;
      box {$\chi$} b | a;
      discard a;
      measure b;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Rectangles with rounded corners are not a specific style, but since the \texttt{yquant-rectangle} shape internally uses \tex!\pgfpathrectangle!, the ordinary \TikZ{} option can be used (also, an inset specification can control how much the corner is rounded).
               \end{example}
               
               \clearpage
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket\psi$} q;
      
      measure {$\ket{\xi_\pm}$} q;
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      dmeter {Bell} (a[0, 1]);
      discard a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      measure {$\ket{\xi_\mp}$} (a[-1, 3]);
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Multi\hyp qubit gates (including measurements) on non\hyp adjacent registers are properly supported since version~0.1.2.
                  As explained in \cref{sec:registers}, there is one main and multiple subordinate gate in such a discontiguous multi\hyp qubit operation (though at the moment, the \gate{measure} gate with text is the only gate that makes this distinction).
                  In our case, the main part contains the measurement symbol and the text, while the subordinate gates only contain the text.
                  By default, \Yquant{} uses the first slice as main part, but you may influence this by preceding what you want to be ``main'' by a star:
                  
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      measure {$\ket{\xi_\mp}$} (a[-1, *3]);
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
            \clearpage
            \paragraph{C. Non-gate inserts, forcing space, and swap}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      [name=sw]
      swap (a[0-1]);
      [draw=none]
      box {$X$} a[1];
      slash b;
      box {$H^{\otimes n}$} b;
      \node[anchor=199] at (sw-0.north) {Defective Circuit};
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Here, the intermediate text was inserted by using a \gate{box} without drawing.
                  Another way would be to use an \gate{init} command, although this is semantically wrong (probably).
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      qubit {} a;
      [name=ypos]
      qubit {} b[3];
      
      cnot a | b[0];
      [name=left]
      cnot a | b[1];
      hspace {7mm} -;
      [name=right]
      cnot a | b[2];
   \end{yquant*}
   \path (left |- ypos-0) -- (right |- ypos-1) node[midway] {$\dots$};
\end{tikzpicture}
                  \end{codeexample}
                  Note how the register range \texttt{-} was used to denote all registers.
                  We positioned the dots by first naming the relevant registers, so that the vertical position is at the coordinates \texttt{ypos-0} and \texttt{ypos-1}; and then, we also named the \gate{cnot} gates, so that we are able to discern the horizontal position.
               \end{example}
               
            \clearpage
            \paragraph{D. Barriers}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      x a[0, 1];
      barrier (a);
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               Now the \pkg{qcircuit} manual lists three circuits with barriers at different positions.
               They cannot be drawn with \Yquant; however, since neither of them is a valid circuit, this is of no concern.
               
            \paragraph{E. How to control anything}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      zz (a[0, 2]);
      cnot a[1] ~ a[0];
      zz (a[2, 3]);
      h a[3] | a[0] ~ a[1];
      measure a[2, 3];
      box {$U$} (a[0, 1]) | a[3] ~ a[2];
      discard a[2, 3];
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Note that it is not possible to draw a control to measurement (the measurement operations are explicitly defined not to accept controls): Either the measurement is performed or not (which transforms the register type), but a measurement conditioned on a quantum state is not possible.
                  In principle, one could think of a measurement conditioned on a classical register (in which case the register type cannot change, as maybe the state stays quantum; the measurement operation then is similar to a complete dephasing).
                  If there is need for this, please file a feature request.
                  But note the relatively common (though unsupported by \Yquant{} at the moment) use of control lines that directly go from the measurement operator to the controlled operation; in this case, the opposite direction would be meant by using the same notation.
               \end{example}
               
         \subsubsection{VI. Bells and Whistles: Tweaking Your Diagram to Perfection}
            For options how to configure the circuits, refer to \cref{sec:config}.
            
            \clearpage
            \paragraph{A. Spacing}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      swap (a[0, 1]);
      box {$T^\dagger$} a[2] | a[1];
      swap (a[0, 1]);
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
            \paragraph{B. Labeling}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}[every initial label/.style={anchor=south east}]
      qubit {\rlap{\hskip2mm $a$}} a;
      qubit {\rlap{\hskip2mm $b$}} b;
      hspace {5mm} -;
      
      measure b;
      align -;
      measure a;
      output {$A$} a;
      output {$B$} b;
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample}
                  Measurement with vertical output are not supported (yet).
                  Repositioning the initial labels needs some care and manual fine\hyp tuning.
               \end{example}
               
            \clearpage
            \paragraph{C. Grouping}\leavevmode
               \begin{example}
                  \begin{codeexample*}
% \usetikzlibrary{fit}
\begin{tikzpicture}
   \begin{yquant*}[register/separation=3mm]
      cnot a[2] | a[0];
      cnot a[2] | a[1];
      [name=left]
      h a[0, 1];
      z a[2];
      cnot a[1] | a[0];
      [name=righttop]
      h a[0];
      [name=rightbot]
      h a[1] | a[2];
      
      hspace {2mm} -;
   \end{yquant*}
   \node[draw, dashed, fit=(left-0) (left-1) (righttop) (rightbot-0)] {};
\end{tikzpicture}
                  \end{codeexample*}
                  Note that \tex!\begin{yquant*}! must not be followed by a line break (unless masked by \tex!%!) if options follow.
               \end{example}
      \endgroup
      
      \clearpage
      \subsection{\pkg{quantikz} documentation}
      \begingroup
         \yquantset{operator/separation=4mm}%
         Again, our section headings will be the same as in the \pkg{quantikz} manual.
         And since \pkg{quantikz} also has even more space between the gates, we globally say \tex!\yquantset{operator/separation=4mm}!.
         
         \subsubsection{II. A single wire}
            \begin{example}
               \begin{codeexample*}
\begin{tikzpicture}[label position=north east, every label/.style={inner sep=1pt}]
   \begin{yquant}
      qubit {$\ket0$} a;
      
      phase {$\alpha$} a;
      h a;
      phase {$\beta$} a;
      h a;
      phase {$\gamma$} a;
      
      [every output/.append style={align=center}]
      output {Arbitrary\\pure state} a;
   \end{yquant}
\end{tikzpicture}
               \end{codeexample*}
               The captions of \gate{phase} commands are internally implemented using \TikZ{} \texttt{label}s.
               At the moment, it is not possible to change any label options on a gate-type basis, only locally or fully globally (\TikZ{} feature request \href{https://github.com/pgf-tikz/pgf/issues/811}{\#811}).
            \end{example}
            
            \clearpage
            \paragraph{A. Measurements}\leavevmode
               \begin{example}
                  \begin{codeexample}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant*}
      ["$0$"]
      measure a;
      discard a;
      
      init {} a;
      dmeter {$1$} a;
      discard a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Other measurement shapes are not supported at the moment.
               \end{example}
            
            \paragraph{B. Wires and arrows}\leavevmode
               \begin{example}
                  \begin{codeexample*}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant}[operator/separation=1cm, every label/.append style={align=center}]
      qubit {$\ket0$\\initial state} a;
      
      [draw=none]
      box {$X$} a;
      
      ["$0$/$1$", type=qubit]
      measure a;
      
      addstyle {->} a;
      output {$\ket1$} a;
      \yquantset{operator/separation=5mm}
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample*}
                  This example demonstrates how to instruct the \gate{measure} gate to use a different output type than the standard \gate{cbit}.
                  
                  In general, any macros that are used within a \TikZ{} path or a \Yquant{} operation must not be fragile, or must be preceded with \tex!\protect!.
                  In this example, \tex!\\! is a robust command (at least in newer kernels), so protection is not required.
                  Since it may occur quite frequently that \Yquant{} is used within a \tex!center! environment or in \tex!\centering! mode (in which \tex!\\! is still fragile), \Yquant{} takes care of this (it actually robustifies \tex!\@centercr!, which is the meaning of \tex!\\! in these surroundings).
                  
                  In order to change the style of an individual wire, we use \gate{addstyle} as of version~0.1.2.
                  To make the final line smaller, we change the operator separation by issuing \tex!\yquantset! at the end.
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant*}
      qubit {$\ket0^{\otimes n}$} a;
      ["north east:3" {font=\protect\footnotesize, inner sep=0pt}]
      slash a;
      hspace {2mm} a;
      h a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Again, you see an example of how some commands need to be \tex!\protect!ed when used in \Yquant{} options, and that you can indeed exploit all features of the \texttt{quotes} library.
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubits {$\ket0^{\otimes n}$} a;
      h a;
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
            
         \clearpage
         \subsubsection{III. Multiple Qubits}
            \begin{example}
               \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket0$} a;
      qubit {$\ket0$} b;
      
      h a, b;
      cnot b | a;
      box {$U$} a ~ b;
      zz (a, b);
      
      [after=a]
      qubit {} c;
      
      swap (a, c);
      box {$U$} c | a ~ b;
   \end{yquant}
\end{tikzpicture}
               \end{codeexample*}
               This example demonstrates the use of the \texttt{after} argument that instructs the register creation to begin the register only after the current position of another register that already exists.
            \end{example}
            
            \clearpage
            \begin{example}
               \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant*}
      [name=c]
      cnot a[0, 2] | a[1];
      [name=m]
      measure a[1];
      discard a[2];
      \path[/yquant/every wire, /yquant/every qubit wire] (c-1) -- (m.center |- c-1);
      box {$U$} a[0] | a[1];
      discard a[1];
   \end{yquant*}
\end{tikzpicture}
               \end{codeexample*}
               It is not possible for the double control line to directly exit the measurement gate.
               Also, if you discard a gate, this will prevent it from exiting from its last gate.
               \Yquant{} will not allow you (apart from manual drawing) to extend the wire to some arbitrary position, then drop it.
               But of course, as done here, you can always resort to the full power of \TikZ.
               Still, this is inferior to a wire drawn by \Yquant, as it does not use clippings: the connection with the \gate{cnot} gate may not be accurate; in particular, if the wire is of a different color or if you need to draw classical or bundle wires, the connection will become unpleasant.
            \end{example}
            
            \begin{example}
               \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      cnot a[1, 2] | a[0];
      measure a[1], a[2];
      box {$U$} a[0] | a[1];
      box {$V$} a[0] | a[2];
      discard a[1]-;
   \end{yquant*}
\end{tikzpicture}
               \end{codeexample}
            \end{example}
            
         \clearpage
         \subsubsection{IV. Operating on many Qubits}
            \begin{example}
               \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      init {$\ket0^{\otimes3}$} (a[-2]);
      
      box {$U$} (a[1-2]) | a[0];
      measure a[0];
      discard a[0];
      output {$\ket{11}$} (a[1-2]);
   \end{yquant*}
\end{tikzpicture}
               \end{codeexample}
               Multi\hyp qubits inputs are possible using the \gate{init} command.
               The text assigned to a register declaration is always for an individual register.
            \end{example}
            
            \begin{example}
               \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      hspace {7.5mm} a;
      h a;
      hspace {7.5mm} a;
      [x radius=1cm]
      box {$U$} (b, c);
      cnot b | a;
      measure a;
      discard a;
   \end{yquant*}
\end{tikzpicture}
               \end{codeexample}
               \Yquant{} does not use a grid layout: operators are stacked next to each other.
               Therefore, there is no automatic centering of a column, though it could be emulated using hand-crafted \gate{hspace} commands, as was done here (the Hadamard gate uses the \style{/yquant/operator/minimum width}, which is \tex!5mm!, while the large box has a width of \tex!2cm!, so that we need two \tex!7.5mm! spacings at the end, as the \gate{hspace} pseudo\hyp gate only inserts exactly the space you give, but not additional [twice] \style{/yquant/operator/separation}, as would be the case for a hypothetical zero\hyp width gate).
               In fact, we don't even need the second \gate{hspace}, since the two\hyp qubit \gate{cnot} will automatically enforce correct alignment.
            \end{example}
            
            \begin{example}
               \begin{codeexample*}
\begin{tikzpicture}[braced/.style={decoration={brace, #1, pre=moveto, pre length=-1pt, post=moveto, post length=-1mm}, decorate}, inner/.style={font=\footnotesize}]
   \begin{yquant}[register/separation=3mm]
      [name=a]
      qubit {} a[4];
      [x radius=1cm, name=u]
      box {$U$} (a[1-3]) | a[0];
   \end{yquant}
   \draw[braced]
      ([xshift=2pt] a-1 -| u.west) -- ([xshift=2pt] a-2 -| u.west)
      node[inner, anchor=west, xshift=1pt, pos=.55] {$x$};
   \draw[braced=mirror]
      ([xshift=-2pt] a-1 -| u.east) -- ([xshift=-2pt] a-2 -| u.east)
      node[inner, anchor=east, xshift=-1pt, pos=.55] {$x$};
   \node[inner, anchor=west] at (a-3 -| u.west) {\smash{$y$}};
   \node[inner, anchor=east] at (a-3 -| u.east) {\smash{$y \oplus f(x)$}};
\end{tikzpicture}
               \end{codeexample*}
               There is no simple way to draw \emph{within} a gate, unless this gate is a proper quantum circuit itself.
               Instead, here the intricate parts were reproduced using \TikZ: first, we make sure we assign a name to every relevant coordinate.
               Then we use some \TikZ{} styles to draw the braces and nodes at the intersection of these coordinates.
               Here, we also make use of the \texttt{moveto} decoration transformation that comes with \Yquant{} and that allows to enlarge the braces slightly for a good overall appearance.
               Finally, as $y$ has a much smaller height than $y \oplus f(x)$, we make sure this does not affect the vertical positioning; and also, as $x$ has no ascender, we need to slightly position it off\hyp mid for a good look.
            \end{example}
            
            \clearpage
            \begin{example}
               \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      box {$\sqrt Z$} a;
      box {$X$} b;
      box {$\sqrt{\mathrm{SWAP}}$} (a, b);
      measure a;
   \end{yquant*}
\end{tikzpicture}
               \end{codeexample}
               This time, we did not artificially discard the lines.
            \end{example}
            
            \begin{example}
               \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$c_{\idx}$} c[4];
      box {M\\A\\J} (c[-2]);
      box {M\\A\\J} (c[1-]);
   \end{yquant}
\end{tikzpicture}
               \end{codeexample}
            \end{example}
            
            \paragraph{A. Different connections}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}[register/default name=]
      qubit a;
      cbit b;
      nobit c;
      cbit d;
      qubit e;
      box {$U$} (-);
      settype {qubit} c;
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample}
                  This example for the first time demonstrates the declaration of a non\hyp existing register and the \gate{settype} pseudo\hyp gate that acts as a zero\hyp width, no\hyp content \gate{init} gate.
               \end{example}
            
         \clearpage
         \subsubsection{V. Slicing}
            \begin{example}
               \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}
      qubit {} a[3];
      h a[0];
      [red, thick, label=step]
      barrier (a);
      cnot a[1] | a[0];
      measure a[0];
      discard a[0];
      cnot a[2] | a[1];
      h a[1];
   \end{yquant}
\end{tikzpicture}
               \end{codeexample}
               There is nothing like a \texttt{slice all} keyword, as \Yquant's underlying layout is not grid\hyp based.
               Changing the style of slice captions simply means providing label options.
               This time, we used the \texttt{label} key instead of the shorter syntax provided by the \texttt{quotes} library, which is of course also possible.
            \end{example}
            
            \begin{example}
               \begin{codeexample*}
% \usetikzlibrary{quotes}
\begin{tikzpicture}[every label/.style={rotate=40, anchor=south west}]
   \begin{yquant}[operators/every barrier/.append style={blue, thick}]
      qubit {} a[3];
      h a[0];
      ["slice 1"]
      barrier (-);
      cnot a[1] | a[0];
      ["slice 2"]
      barrier (-);
      measure a[0];
      discard a[0];
      cnot a[2] | a[1];
      ["slice 3"]
      barrier (-);
      h a[1];
   \end{yquant}
\end{tikzpicture}
               \end{codeexample*}
            \end{example}
            
            \begin{example}
               \begin{codeexample*}
% \usetikzlibrary{quotes}
\begin{tikzpicture}[label distance=4mm]
   \begin{yquant}[operators/every barrier/.append style={red, thick, shorten <= -2.5mm, shorten >= -2.5mm}]
      qubit {$\ket0$} a;
      h a;
      ["1"]
      barrier (a);
      phase {[label distance=0pt]$\varphi$} a;
      ["2"]
      barrier (a);
      h a;
      ["3"]
      barrier (a);
      output {$\cos\frac\varphi2 \ket0 - i\sin\frac\varphi2 \ket1$};
   \end{yquant}
\end{tikzpicture}
               \end{codeexample*}
               Usually, the \texttt{shorten} keys do not have any effect on \Yquant{} operations, since the latter are all made up of nodes.
               However, the \texttt{yquant-line} shape explicitly takes care of correctly handling them.
               It is the only one that does so.
               Since barriers usually end quite closely to the wires---and the default \texttt{dashed} style may make this worse---the \texttt{shorten}ing may often prove useful.
               Note that if the barriers are enlarged by means of negative \texttt{shorten}ings, this will not affect the bounding box or internal register height calculations, and you must take care of appropriately shifting labels.
               Also note that we used much larger magnitudes in order to achieve a similar appearance as in \pkg{quantikz}.
               To avoid that the large distance also affects the \gate{phase} gate badly, we locally reset the distance; for this, there are two ways.
               The easiest one is to make use of the fact that the value of the \gate{phase} gate is passed directly as \texttt{label} argument, so that we can locally reset the distance.
               The other possibility would be to write
               \begin{minted}[linenos=false, fontsize=\footnotesize, bgcolor=boxGrayBody]{tex}
   {
      \yquantset{/tikz/label distance=0pt}
      phase {$\varphi$} a;
   }
               \end{minted}
               since due to the aforementioned lack of support for a style that sets the options in \TikZ, we must manually use a (grouped) \tex!\yquantset! instruction for this.
               Note that whenever you change a \TikZ{} style in a \Yquant{} environment, use the \tex!\yquantset! macro, \emph{not} \tex!\tikzset! or \tex!\pgfkeys!.
               Not only will the latter two not automatically restart the parser (so that you would have to issue \tex!\yquant! after their use), but \Yquant{} has to process all its content twice in order to properly determine the register height.
               Only \tex!\yquantset! will be properly captured and re\hyp issued at the correct position when the content is actually typeset.
               Had we written \tex!\tikzset{label distance=0pt} \yquant!, no effect at all would have been visible, since this command would only have taken effect in the first (invisible) round when \Yquant{} determines heights.
            \end{example}
            
            \Yquant{} does not provide a mechanism for vertical labels, but you may of course just insert line breaks at appropriate positions (and set the \texttt{align} property of the labels).
         
         \clearpage
         \subsubsection{VI. Spacing}
            \paragraph{A. Local adjustment}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant}[register/default name=]
      [register/minimum height=2cm]
      qubit a;
      qubit {\vbox to 1cm{}} b;
      qubit c;
      
      h a;
      x b-;
      hspace {2cm} -;
      x a;
      z b-;
      h a;
      z b-;
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample}
                  At the moment, the distance between registers is calculated by \Yquant{} automatically.
                  We show various possibilities to intervene in this example.
                  The first is to locally, upon creation of the register, reset \style{/yquant/register/minimum height} to a different value.
                  The second is to artificially enlarge the label that the qubit initializer takes.
                  However, both approaches enlarge the \emph{height} of the registers, i.e., add half of the specified amount to the top and the bottom.
               \end{example}
               
               \begin{example}
                  \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant*}
      [x radius=1cm]
      x a;
      box {\hbox to 1cm{\hfil$X$\hfil}} a;
      hspace {1cm} a;
      x a;
      discard a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample*}
                  Here, we demonstrate two possibilities to enlarge a box: The first is by specifying its size in terms of the \texttt{x radius} or \texttt{y radius} keys beforehand.
                  Those values serve as minimum sizes and would be extended if the text extended beyond the box.
                  The second option is to just enlarge the text artificially by explicitly putting it into a fixed\hyp width box.
                  Note that in the first case, the \emph{radius} is specified, i.e., the half\hyp width, while in the second case, it is the \emph{total} width (both times modulo the inner separation).
                  Also note that the \style{/yquant/operator/minimum width} style is unsuitable for the given task: it would not change the visual width, only what \Yquant{} assumes its width to be.
               \end{example}
               
            \paragraph{B. Global Adjustment}\leavevmode
               \begin{example}
                  \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant*}[operator/separation=1cm]
      h a;
      phase {$\beta$} a;
      h a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample*}
               \end{example}
               
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}[register/minimum height=0pt]
      x a[0, 2];
      zz (a[0, 1]);
      x a[0];
      h b;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  By default, \Yquant{} will use the height that is required by the individual gates, but at least \style{/yquant/register/minimum height} (which defaults to \tex!3mm!).
                  Only manually reducing the default height will produce the cramped spacing displayed here.
               \end{example}
               
            \clearpage
            \paragraph{C. Alignment}\leavevmode
               \begin{example}
                  \begin{codeexample}
\begin{tikzpicture}
   \begin{yquant*}
      x a[0];
      cnot a[1] | a[0];
   \end{yquant*}
\end{tikzpicture}
$=$
\begin{tikzpicture}
   \begin{yquant*}
      cnot a[1] | a[0];
      x a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
                  Not specifying anything for the vertical alignment will lead to the common \TikZ{} problem: the baseline will be at the bottom, which is particularly bad in this case due to the missing $X$ gate.
                  The \style{/yquant/register/minimum height} key does not help here, since it only affects \Yquant's internal handling, but not the bounding box calculated by \TikZ.
                  In the first example of the \pkg{qcircuit} documentation, we demonstrated how the desired task can easily be achieved in terms of \texttt{baseline}s.
                  We will now do the same with scopes instead.\vskip2mm 
                  \begin{codeexample*}
\begin{tikzpicture}[/yquant/register/minimum height=5mm]
   \begin{yquant*}
      x a[0];
      cnot a[1] | a[0];
   \end{yquant*}
   \path (current bounding box.east |- 0, 0) ++(1, 0) coordinate (shift);
   \begin{scope}[shift=(shift)]
      \begin{yquant*}
         cnot a[1] | a[0];
         x a;
      \end{yquant*}
   \end{scope}
   \node at (current bounding box) {$=$};
\end{tikzpicture}
                  \end{codeexample*}
                  Here, we increased the minimum height so that in the left circuit despite the absence of the $X$ gate, the second register has the same separation.
                  We used the meta\hyp node \texttt{current bounding box} to avoid the need to manually specify hard\hyp coded positions.
               \end{example}
               
               \subparagraph{1. Perfecting Vertical Alignment}\leavevmode
                  \begin{example}
                     \begin{codeexample*}
\begin{tikzpicture}[baseline=(W)]
   \begin{yquant}
      qubit {$\ket0$} anc;
      [name=W]
      qubit {} x;
      h x;
      cnot x | anc;
   \end{yquant}
\end{tikzpicture} $\equiv$ \begin{tikzpicture}[baseline=(W)]
   \begin{yquant}
      [name=W]
      qubit {} x;
      h x;
      x x;
   \end{yquant}
\end{tikzpicture}
                     \end{codeexample*}
                     While here, we opted for the most logical choice to name the declaration of the register, a name put to any operation on the desired register would also serve the purpose (as long as this operation is vertically symmetrical, which subcircuits may not be).
                  \end{example}
                  
                  \clearpage
                  \begin{example}
                     \begin{codeexample*}
\begin{tikzpicture}[baseline={([yshift=.2cm]W)}]
   \begin{yquant}
      qubit {$\ket0$} anc;
      [name=W]
      qubit {} x;
      h x;
      cnot x | anc;
   \end{yquant}
\end{tikzpicture} $\equiv$
\begin{tikzpicture}[baseline={([yshift=.2cm]new)}]
   \begin{yquant}
      [name=new]
      qubit {} x;
      h x;
      x x;
   \end{yquant}
\end{tikzpicture}
                     \end{codeexample*}
                     Of course, you may also use the features of the \TikZ{} library \texttt{calc} to achieve the same shift.
                  \end{example}
            
            \paragraph{D. Scaling}\leavevmode
               \begin{example}
                  \begin{codeexample*}
\begin{tikzpicture}[scale=1.5, every label/.append style={scale=1.5}]
   \begin{yquant*}
      h a;
      phase {$\beta$} a;
      h a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample*}
                  Here, we first scaled the circuit itself.
                  The default style for \style{/yquant/every circuit} sets the \texttt{transform shape} key for every node (which means any gate), so that those are also scaled.
                  This is explicitly undone for \texttt{label}s due to \TikZ{} bug \href{https://github.com/pgf-tikz/pgf/issues/843}{\#843}, so the scaling must be specified explicitly for the \texttt{label}s.
               \end{example}
         
         \subsubsection{VII. Typesetting}
            \paragraph{A. Global Styling}\leavevmode
               \begin{example}
                  \begin{codeexample*}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant*}[operators/every h/.append style={fill=red!20}]
      h a;
      phase {$\beta$} a;
      h a;
      ["$\ket\pm$" above right]
      measure a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample*}
                  Instead of setting \style{/yquant/operators/every h}, we could also have changed \style{/yquant/operators/every box}.
                  Had we used \style{/yquant/every operator}, then the measurement would also have changed.
                  Again, due to a \TikZ{} limitation, it is not possible to change the position of labels on a per\hyp style basis, only by using \texttt{label} options or a global setting.
               \end{example}
               
               \begin{example}
                  \begin{codeexample*}
\begin{tikzpicture}[thick]
   \begin{yquant*}[every operator/.prefix style={fill=white}]
      cnot a[1] | a[0];
      box {$R_z(-\theta\fracslash2)$} a[1];
      cnot a[1] | a[0];
      box {$R_z(\theta\fracslash2)$} a[1];
      measure a[1];
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample*}
                  As the ``thin'' style is the default, we present the opposite.
                  By default, all operators are transparent; we changed this by giving all of them a white background color (but as a style \emph{prefix}, so that, e.g., black fillings overwrite this).
                  Contrary to \pkg{quantikz}, this also fills the \gate{cnot}s.
                  If you only want to fill certain operators, you have to selectively target them using their styles.
               \end{example}
               
               \begin{example}
                  \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant}[operators/every box/.append style={fill=white}]
      qubit {} j[3];
      box {$J_{12}$} (-j[1]);
      box {$J_{13}$} (j[0, 2]);
      box {$J_{23}$} (j[1]-);
   \end{yquant}
\end{tikzpicture}
                  \end{codeexample*}
                  \Yquant{} properly splits discontiguous multi\hyp qubit operations as of version~0.1.2.
               \end{example}
            
            \paragraph{B. Per-Gate Styling}\leavevmode
               \begin{example}
                  \begin{codeexample}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant*}
      [fill=red!20, font=\color{cyan}]
      h a;
      [green]
      phase {[green]$\beta$} a;
      ["$\ket\pm$"]
      measure a;
      discard a;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample}
               \end{example}
               
               \clearpage
               \begin{example}
                  \begin{codeexample*}
% \usetikzlibrary{shapes.symbols, fit}
\begin{tikzpicture}
   \begin{yquant}
      qubit {} data;
      qubit {$\ket0$} anc1[2];
      
      h data;
      cnot anc1 | data;
      [after=data]
      qubit {$\ket0$} anc2[2];
      [name=box, draw=none]
      box {\phantom{noise}} (data, anc1);
      cnot anc2[0] | data;
      cnot anc2 | anc1[0];
      cnot anc2[1] | anc1[1];
      measure anc2;
   \end{yquant}
   \node[starburst, cyan, fill=yellow, draw=red,
         line width=2pt, inner xsep=-4pt, inner ysep=-5pt, fit=(box)] {noise};
\end{tikzpicture}
                  \end{codeexample*}
                  \TikZ{} shapes cannot simply be used with \Yquant.
                  Any \Yquant{} shape must be aware of the keys \texttt{x radius} and \texttt{y radius} that control its width and height.
                  Additionally, \Yquant{} shapes must implement clipping paths.
                  Those objects, which are a \Yquant{} addition to \TikZ{} allow \Yquant{} to properly clip wires and vertical lines to the shape of the gate.
                  \Yquant{} draws its elements sequentially; hence, a wire that comes into an operator will be hidden by anything the operator draws on top of it; but outgoing wires will in turn draw on the operator (modulo clipping).
                  To avoid the issues, we construct an invisible box operator and name it; \emph{outside} of the \tex!yquant! environment, we \texttt{fit} the special \TikZ{} shape on top of it.
               \end{example}
               
            \paragraph{C. Boxing/Highlighting Parts of a Circuit}\leavevmode
               \begin{example}
                  \begin{codeexample*}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant*}
      h a;
      cnot b | a;
      [name=left]
      h -;
      cnot b | a;
      [name=right]
      h -;
      cnot b|a;
      h b;
   \end{yquant*}
   \node[fit=(left-0) (left-1) (right-0) (right-1),
         draw, inner sep=6pt, "reversed c-\textsc{not}"] {};
\end{tikzpicture}
                  \end{codeexample*}
                  In this case, since version~0.2, a subcircuit may provide a similar experience:
                  \begin{codeexample*}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant*}
      h a;
      cnot b | a;
      [this subcircuit box style={inner sep=6pt, "reversed c-\textsc{not}"}]
      subcircuit {
         qubit {} x;
         qubit {} y;
         h -;
         cnot y | x;
         h -;
      } (-);
      cnot b | a;
      h b;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample*}
                  Here, we used the key \style{/yquant/this subcircuit box style} to influence only the style of the subcircuit box itself instead of providing global options that apply to every object in the subcircuit (you wouldn't want the label be assigned to every single gate).
               \end{example}
               
               \clearpage
               \begin{example}
                  \begin{codeexample*}
% \usetikzlibrary{quotes}
\begin{tikzpicture}
   \begin{yquant*}
      h a;
      [this subcircuit box style={draw, dashed, rounded corners, fill=blue!20, inner xsep=6pt, inner ysep=10pt, "\textsc{swap}" below}, register/default name=]
      subcircuit {
         qubit a;
         qubit b;
         cnot b | a;
         cnot a | b;
         cnot b | a;
      } (a-b);
      h b;
   \end{yquant*}
\end{tikzpicture}
                  \end{codeexample*}
                  Since version~0.2, fully enclosing a bunch of operations (with no controls extending to some inner component) is possible by means of \gate{subcircuit}s.
                  Before, this had to be done using named operations and layers.
                  Note that here we used the style \style{/yquant/this subcircuit box style} to assign a styling that only applies to the box containing the subcircuit, but not to the inner gates---which would have happened had we just given the arguments to the subcircuit directly.
               \end{example}
               
               \Yquant{} does not support the fancy nearest\hyp neighbor swap gate that \pkg{quantikz} has.
               It would however not be very difficult to implement this particular shape and make it available.
               Maybe even a multi\hyp swap gate using the \texttt{knots} library would be possible.
               
         \clearpage
         \subsubsection{VIII. Otherwise undocumented features}
            \begin{example}
               \begin{codeexample*}
% \usetikzlibrary{quantikz}
\begin{tikzpicture}
   \begin{yquant}[register/default name=]
      qubit a;
      [name=wave, register/minimum height=1cm]
      nobit wave;
      qubit b;
      qubit c;
      
      h a, b;
      box {$U$} c | a;
      [draw=none]
      box {$\dots$} a, b-;
      box {$U^k$} c | b;
      h a, b;
   \end{yquant}
   \node[wave, fit=(wave) (current bounding box.east |- wave), inner ysep=.5pt, inner xsep=0pt] {};
\end{tikzpicture}
               \end{codeexample*}
               Here, we included \pkg{quantikz}, which provides the \texttt{wave} shape, then introduced a register that will contain this wave (and enlarged it sufficiently).
               After the circuit is drawn, we \texttt{fit} the wave along.
               Since the name assigned to a register without any text actually is of a \texttt{coordinate} shape, we need to enlarge the height of the wave by providing a slightly increased \texttt{inner ysep}.
               Additionally, \pkg{quantikz} sets a negative \texttt{inner xsep}, which is probably required for its grid layout; but \Yquant{} positions exactly, so we also need to reset this.
            \end{example}
         
         \clearpage
         \subsubsection{X. Troubleshooting}
            \begin{example}
               \begin{codeexample*}
\begin{tikzpicture}
   \begin{yquant}
      qubit {$\ket0$} a[2];
      box {$\begin{pmatrix}
               \alpha & \beta \\
               \beta & -\alpha
            \end{pmatrix}$} a[0];
      cnot a[1] | a[0];
      box {$U_{\protect\the\numexpr\idx+1}$} a;
   \end{yquant}
\end{tikzpicture}
               \end{codeexample*}
            \end{example}
      \endgroup
   
   \section{Foreign language support}
      \Yquant{} is built in various modules, so that it is not hard to use the quantum circuit rendering backend, but expose a different language frontend.
      Since version~0.3, \Yquant{} not only understands its own language, but also others.
      
      \subsection{qasm}
         By saying \tex!\useyquantlanguage{qasm}! in the preamble after loading \Yquant{} itself, the parser for \pkg{qasm} (not OpenQASM) is loaded.
         It provides the environment \tex!qasm! as well as the macro \tex!\qasmimport!, which works similarly to \tex!\yquantimport! (but does not accept additional options).
         
         \subsubsection{Language specification}
            The \pkg{qasm} language is not formally defined, but an overview is provided at \href{https://web.archive.org/web/20050410022847/https://www.media.mit.edu/quanta/qasm2circ/#spec}{the archived website of \texttt{qasm2circ}}.
            The \Yquant{} implementation is designed to be compatible with the original parser, with the following exceptions:
            \begin{itemize}
               \item In \pkg{qasm}, lines could begin in an arbitrary manner; the first whitespace followed by the first valid command were then the instruction.
                  Contrary to this, \Yquant's parser always expects a line to start with a valid gate (preceded by arbitrary whitespaces), a comment, or to be empty.
               \item In \pkg{qasm}, user\hyp defined gates will be drawn in a box unless they contain the text \texttt{\textbackslash dmeter}, and they will be recognized as measurement gates if they contain \texttt{\textbackslash meter} or \texttt{\textbackslash dmeter}.
                  Contrary to this, \Yquant's parser expect the gates to \emph{start} with one of the \emph{macros} \tex!\meter!, \tex!\dmeter!, or \tex!\dmeterwide!.
                  Using these macros \emph{within} the content of a gate does not make sense from the point of view that in \Yquant, gates are nodes with shapes, so either the full gate has a particular shape or it does not, but not only parts of it.
               \item The \texttt{space} gate is supposed to produce a horizontal whitespace without a gate.
                  In \Yquant's implementation, you have to discard the wire if you want to reproduce this behavior; \texttt{space} and \texttt{nop} are equivalent.
            \end{itemize}
            
            The default \pkg{qasm} style defines several macros that can be used in gates.
            \Yquant{} makes \tex!\m! (matrix; requires \pkg{amsmath}) and \tex!\txt! (switch to text mode) available within the \pkg{qasm} environment.
            
            Do not expect \Yquant's output to match the one of \pkg{qasm} exactly.
            \Yquant{} is not grid based, so that commands such as \texttt{nop} don't even make sense.
            They are implemented for compatibility reasons and will produce a fixed horizontal space of the operator minimum width plus one separation, which might or might not be accurate.
            
            Note that whatever you write between \tex!\begin{qasm}! and \tex!\end{qasm}! is essentially treated as verbatim; only where the specification says so (in the definition of a new gate and in the optional third command to the register definition), it is interpreted as \TeX{} markup.
            Consequently, in \pkg{beamer}, any frame containing these environments must be given the \texttt{verbatim} option.
         
         \subsubsection{Configuration}
            Loading the \pkg{qasm} language interpreter will define several new configuration keys.
            For all the gates, it will use the keys defined in \cref{sec:config}, and it additionally provides the following:
            
            \begin{option}{operators/every s}!/yquant/operators/every box!
               This style is installed for every \texttt{s} operator.
            \end{option}
            
            \begin{option}{operators/every t}!/yquant/operators/every box!
               This style is installed for every \texttt{t} operator.
            \end{option}
            
            \begin{option}{operators/every utwo}!/yquant/operators/every box!
               This style is installed for every \texttt{Utwo} operator.
            \end{option}
            
            \begin{option*}{qasm}{zero}!\qasm@ket0!
               The content of this macro is used as the initialization content whenever the \texttt{zero} gate is invoked.
            \end{option*}
            
            \begin{option*}{qasm}{register/default qubit name}!\qasm@ket{#1}!
               This macro is invoked with a single parameter (the name of a qubit register) and gives back what is printed as the name of the register (will be in math mode automatically).
            \end{option*}
            
            \begin{option*}{qasm}{register/default qubit name value}!\qasm@ket{#1} = \qasm@ket{#2}!
               This macro is invoked with two parameters (the name of a qubit register and its initial value) and gives back what is printed as the name of the register (will be in math mode automatically).
            \end{option*}
         
         \subsubsection{Examples}
            The unaltered\footnote{Only in \texttt{test14.qasm}, \tex!\cal! was replaced by \tex!\symcal!---and this is only necessary as this manual was set with \pkg{unicode-math}. In traditional mode, even this would not be necessary.} \texttt{.qasm} files provided from \href{https://www.media.mit.edu/quanta/qasm2circ/}{the \texttt{qasm2circ} page} were stored in the subfolder \texttt{qasm} relative to this manual's \TeX{} file.
            The following command is then used to print all of them:
            \begin{minted}{tex}
% preamble:
% \usepackage{yquant,import}
% \useyquantlanguage{qasm}
\def\yquantimportpath{qasm/}
\foreach \circuitno in {1, ..., 18} {
   \paragraph{Circuit \#\circuitno}
      \begin{center}
         \qasmimport{test\circuitno.qasm}
      \end{center}
}
            \end{minted}
            
            \def\yquantimportpath{qasm/}
            \foreach \circuitno in {1, ..., 18} {
               \paragraph{Circuit \#\circuitno}\leavevmode\nopagebreak\par\nopagebreak
                  \begin{adjustbox}{center}
                     \qasmimport{test\circuitno.qasm}
                  \end{adjustbox}
            }
      
   \section{Wishlist}
      This section contains some thoughts on future improvements and features.
      \begin{itemize}
         \item Support for more other languages. \\
            Since version~0.3, \Yquant{} understands \pkg{qasm}.
            It would be nice if \Yquant{} could also understand \texttt{OpenQASM} correctly.
            The way \texttt{OpenQASM} treats operations is a bit different from \Yquant{} and also \pkg{qasm}.
            Some machinery would be required to automatically carry out transversal gates; apart from that everything should be available in \Yquant.
         \item Vertical layout. \\
            Sometimes, long quantum circuits on a portrait page can be better represented in a vertical layout.
            Also if lots of explanations are to be added, this becomes problematic in the horizontal version.
            In principle, \Yquant's approach could allow for a simple key switch that changes horizontal to vertical.
            Currently, this is largely unsupported by all quantum circuit packages except for \pkg{qpic}.
      \end{itemize}
   
   \section{Changelog}
      \subsection{2020-03-15: Version 0.1}
         Initial release
      
      \subsection{2020-03-22: Version 0.1.1}
         Complete rewrite of the register name parser.
         \Yquant{} now understands comma\hyp separated lists and ranges in indices, and also is far more tolerant with respect to whitespaces. \\
         \Yquant{} now also supports non\hyp contiguous vector registers and allows to add new registers into an already existing vector that is not the last register, and also in the unstarred mode.
      
      \subsection{2020-04-11: Version 0.1.2}
         Introduce \gate{setstyle} and \gate{addstyle} pseudo\hyp gates that allow to style individual wires; rename \gate{setwire} to \gate{settype} (the old name is still available and shows a deprecation warning). \\
         Complete rewrite of the way \Yquant{} draws wires; projection anchors are removed in favor of clipping paths.
         This allows perfect connections between gates and wires, even if the (rather rectangular) wire lines meets with nonplanar shapes, while still preserving the possibility of transparent wires. \\
         \Yquant{} now also properly draws non\hyp contiguous multi\hyp qubit operations. \\
         New gate: \gate{correlate}.
         Various bug fixes.
      
      \subsection{2020-06-02: Version 0.2}
         Introduce \gate{subcircuit}; required rewriting how \Yquant{} internally positions vertically.
         Provide simple macros to load circuits (or parts) from a file and to declare own custom gates.
      
      \subsection{2020-06-07: Version 0.2.1}
         Introduce a macro to declare a lightweight custom gate, which is only a single box with custom content.
         
      \subsection{2020-06-13: Version 0.3}
         Introduce support for the \pkg{qasm} language.
%END_FOLD
\end{document}