-
Notifications
You must be signed in to change notification settings - Fork 56
/
circuitstructure.py
1025 lines (844 loc) · 37.9 KB
/
circuitstructure.py
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
""" Defines the CircuitStructure class and supporting functionality."""
from __future__ import division, print_function, absolute_import, unicode_literals
#***************************************************************************************************
# Copyright 2015, 2019 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
# Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights
# in this software.
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
# in compliance with the License. You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0 or in the LICENSE file in the root pyGSTi directory.
#***************************************************************************************************
import numpy as _np
import copy as _copy
import uuid as _uuid
import itertools as _itertools
from ..tools import listtools as _lt
class CircuitPlaquette(object):
"""
Encapsulates a single "plaquette" or "sub-matrix" within a
circuit-structure. Typically this corresponds to a matrix
whose rows and columns correspdond to measurement and preparation
fiducial sequences.
"""
def __init__(self, base, rows, cols, elements, aliases, fidpairs=None):
"""
Create a new CircuitPlaquette.
Parameters
----------
base : Circuit
The "base" operation sequence of this plaquette. Typically the sequence
that is sandwiched between fiducial pairs.
rows, cols : int
The number of rows and columns of this plaquette.
elements : list
A list of `(i,j,s)` tuples where `i` and `j` are row and column
indices and `s` is the corresponding `Circuit`.
aliases : dict
A dictionary of operation label aliases that is carried along
for calls to :func:`expand_aliases`.
fidpairs : list, optional
A list of `(prepStr, effectStr)` tuples specifying how
`elements` is generated from `base`, i.e. by
`prepStr + base + effectStr`.
"""
self.base = base
self.rows = rows
self.cols = cols
self.elements = elements[:]
self.fidpairs = fidpairs[:] if (fidpairs is not None) else None
self.aliases = aliases
#After compiling:
self._elementIndicesByStr = None
self._outcomesByStr = None
self.num_simplified_elements = None
def expand_aliases(self, dsFilter=None, circuit_simplifier=None):
"""
Returns a new CircuitPlaquette with any aliases
expanded (within the operation sequences). Optionally keeps only
those strings which, after alias expansion, are in `dsFilter`.
Parameters
----------
dsFilter : DataSet, optional
If not None, keep only strings that are in this data set.
circuit_simplifier : Model, optional
Whether to call `simplify_circuits(circuit_simplifier)`
on the new CircuitPlaquette.
Returns
-------
CircuitPlaquette
"""
#find & replace aliased operation labels with their expanded form
new_elements = []
new_fidpairs = [] if (self.fidpairs is not None) else None
for k, (i, j, s) in enumerate(self.elements):
s2 = s if (self.aliases is None) else \
_lt.find_replace_tuple(s, self.aliases)
if new_fidpairs:
prep, effect = self.fidpairs[k]
prep2 = prep if (self.aliases is None) else \
_lt.find_replace_tuple(prep, self.aliases)
effect2 = effect if (self.aliases is None) else \
_lt.find_replace_tuple(effect, self.aliases)
if dsFilter is None or s2 in dsFilter:
new_elements.append((i, j, s2))
if new_fidpairs: new_fidpairs.append((prep2, effect2))
ret = CircuitPlaquette(self.base, self.rows, self.cols,
new_elements, None, new_fidpairs)
if circuit_simplifier is not None:
ret.simplify_circuits(circuit_simplifier, dsFilter)
return ret
def get_all_strs(self):
"""Return a list of all the operation sequences contained in this plaquette"""
return [s for i, j, s in self.elements]
def simplify_circuits(self, model, dataset=None):
"""
Simplified this plaquette so that the `num_simplified_elements` property and
the `iter_simplified()` method may be used.
Parameters
----------
model : Model
The model used to perform the compiling.
dataset : DataSet, optional
If not None, restrict what is simplified to only those
probabilities corresponding to non-zero counts (observed
outcomes) in this data set.
"""
all_strs = self.get_all_strs()
if len(all_strs) > 0:
rawmap, self._elementIndicesByStr, self._outcomesByStr, nEls = \
model.simplify_circuits(all_strs, dataset)
else:
nEls = 0 # nothing to simplify
self.num_simplified_elements = nEls
def iter_simplified(self):
assert(self.num_simplified_elements is not None), \
"Plaquette must be simplified first!"
for k, (i, j, s) in enumerate(self.elements):
yield i, j, s, self._elementIndicesByStr[k], self._outcomesByStr[k]
def __iter__(self):
for i, j, s in self.elements:
yield i, j, s
#iterate over non-None entries (i,j,GateStr)
def __len__(self):
return len(self.elements)
def process_circuits(self, processor_fn, updated_aliases=None):
"""
Manipulate this object's circuits according to `processor_fn`
and return a new `CircuitPlaquette` object.
Parameters
----------
processor_fn : function
A function which takes a single Circuit argument and returns
another (or the same) Circuit.
updated_aliases : dict, optional
Because the Label keys of an alias dictionary (maps
Label -> Circuit) cannot be processed as a Circuit, one must
supply a manualy processed alias dictionary. If you don't use
alias dictionaries just leave this set to None.
Returns
-------
CircuitPlaquette
"""
P = processor_fn
updated_elements = [(i, j, P(s)) for i, j, s in self.elements]
updated_fidpairs = [(P(prep), P(meas)) for prep, meas in self.fidpairs]
return CircuitPlaquette(P(self.base), self.rows, self.cols,
updated_elements, updated_aliases, updated_fidpairs)
def copy(self):
"""
Returns a copy of this `CircuitPlaquette`.
"""
aliases = _copy.deepcopy(self.aliases) if (self.aliases is not None) \
else None
return CircuitPlaquette(self.base, self.rows, self.cols,
self.elements[:], aliases, self.fidpairs)
class CircuitStructure(object):
"""
Encapsulates a set of operation sequences, along with an associated structure.
By "structure", we mean the ability to index the operation sequences by a
4-tuple (x, y, minor_x, minor_y) for displaying in nested color box plots,
along with any aliases.
"""
def __init__(self):
self.uuid = _uuid.uuid4() # like a persistent id(),
# useful for peristent (file) caches
def __hash__(self):
if self.uuid is not None:
return hash(self.uuid)
else:
raise TypeError('Use digest hash')
def __setstate__(self, stateDict):
self.__dict__.update(stateDict)
if 'uuid' not in stateDict:
self.uuid = _uuid.uuid4() # create a new uuid
def xvals(self):
""" Returns a list of the x-values"""
raise NotImplementedError("Derived class must implement this.")
def yvals(self):
""" Returns a list of the y-values"""
raise NotImplementedError("Derived class must implement this.")
def minor_xvals(self):
""" Returns a list of the minor x-values"""
raise NotImplementedError("Derived class must implement this.")
def minor_yvals(self):
""" Returns a list of the minor y-values"""
raise NotImplementedError("Derived class must implement this.")
def get_plaquette(self, x, y):
"""
Returns a the plaquette at `(x,y)`.
Parameters
----------
x, y : values
Coordinates which should be members of the lists returned by
:method:`xvals` and :method:`yvals` respectively.
Returns
-------
CircuitPlaquette
"""
raise NotImplementedError("Derived class must implement this.")
def create_plaquette(self, baseStr):
"""
Creates a the plaquette for the given base string.
Parameters
----------
baseStr : Circuit
Returns
-------
CircuitPlaquette
"""
raise NotImplementedError("Derived class must implement this.")
def used_xvals(self):
"""Lists the x-values which have at least one non-empty plaquette"""
return [x for x in self.xvals() if any([len(self.get_plaquette(x, y)) > 0
for y in self.yvals()])]
def used_yvals(self):
"""Lists the y-values which have at least one non-empty plaquette"""
return [y for y in self.yvals() if any([len(self.get_plaquette(x, y)) > 0
for x in self.xvals()])]
def plaquette_rows_cols(self):
"""
Return the number of rows and columns contained in each plaquette of
this CircuitStructure.
Returns
-------
rows, cols : int
"""
return len(self.minor_yvals()), len(self.minor_xvals())
def get_basestrings(self):
"""Lists the base strings (without duplicates) of all the plaquettes"""
baseStrs = set()
for x in self.xvals():
for y in self.yvals():
p = self.get_plaquette(x, y)
if p is not None and p.base is not None:
baseStrs.add(p.base)
return list(baseStrs)
def simplify_plaquettes(self, model, dataset=None):
"""
Simplifies all the plaquettes in this structure so that their
`num_simplified_elements` property and the `iter_simplified()` methods
may be used.
Parameters
----------
model : Model
The model used to perform the compiling.
dataset : DataSet, optional
If not None, restrict what is simplified to only those
probabilities corresponding to non-zero counts (observed
outcomes) in this data set.
"""
for x in self.xvals():
for y in self.yvals():
p = self.get_plaquette(x, y)
if p is not None:
p.simplify_circuits(model, dataset)
class LsGermsStructure(CircuitStructure):
"""
A type of operation sequence structure whereby sequences can be
indexed by L, germ, preparation-fiducial, and measurement-fiducial.
"""
def __init__(self, Ls, germs, prepStrs, effectStrs, aliases=None,
sequenceRules=None):
"""
Create an empty operation sequence structure.
Parameters
----------
Ls : list of ints
List of maximum lengths (x values)
germs : list of Circuits
List of germ sequences (y values)
prepStrs : list of Circuits
List of preparation fiducial sequences (minor x values)
effecStrs : list of Circuits
List of measurement fiducial sequences (minor y values)
aliases : dict
Operation label aliases to be propagated to all plaquettes.
sequenceRules : list, optional
A list of `(find,replace)` 2-tuples which specify string replacement
rules. Both `find` and `replace` are tuples of operation labels
(or `Circuit` objects).
"""
self.Ls = Ls[:]
self.germs = germs[:]
self.prepStrs = prepStrs[:]
self.effectStrs = effectStrs[:]
self.aliases = aliases.copy() if (aliases is not None) else None
self.sequenceRules = sequenceRules[:] if (sequenceRules is not None) else None
self.allstrs = []
self.allstrs_set = set()
self.unindexed = [] # unindexed strings
self._plaquettes = {}
self._firsts = []
self._baseStrToLGerm = {}
super(LsGermsStructure, self).__init__()
#Base class access in terms of generic x,y coordinates
def xvals(self):
""" Returns a list of the x-values"""
return self.Ls
def yvals(self):
""" Returns a list of the y-values"""
return self.germs
def minor_xvals(self):
""" Returns a list of the minor x-values"""
return self.prepStrs
def minor_yvals(self):
""" Returns a list of the minor y-values"""
return self.effectStrs
def add_plaquette(self, basestr, L, germ, fidpairs=None, dsfilter=None):
"""
Adds a plaquette with the given fiducial pairs at the
`(L,germ)` location.
Parameters
----------
basestr : Circuit
The base operation sequence of the new plaquette.
L : int
germ : Circuit
fidpairs : list
A list if `(i,j)` tuples of integers, where `i` is a prepation
fiducial index and `j` is a measurement fiducial index. None
can be used to mean all pairs.
dsfilter : DataSet, optional
If not None, check that this data set contains all of the
operation sequences being added. If dscheck does not contain a gate
sequence, it is *not* added.
Returns
-------
missing : list
A list of `(prep_fiducial, germ, L, effect_fiducial, entire_string)`
tuples indicating which sequences were not found in `dsfilter`.
"""
missing_list = []
from ..construction import circuitconstruction as _gstrc # maybe move used routines to a circuittools.py?
if fidpairs is None:
fidpairs = list(_itertools.product(range(len(self.prepStrs)),
range(len(self.effectStrs))))
if dsfilter:
inds_to_remove = []
for k, (i, j) in enumerate(fidpairs):
el = self.prepStrs[i] + basestr + self.effectStrs[j]
trans_el = _gstrc.translate_circuit(el, self.aliases)
if trans_el not in dsfilter:
missing_list.append((self.prepStrs[i], germ, L, self.effectStrs[j], el))
inds_to_remove.append(k)
if len(inds_to_remove) > 0:
fidpairs = fidpairs[:] # copy
for i in reversed(inds_to_remove):
del fidpairs[i]
plaq = self.create_plaquette(basestr, fidpairs)
for x in (_gstrc.manipulate_circuit(opstr, self.sequenceRules) for i, j, opstr in plaq):
if x not in self.allstrs_set:
self.allstrs_set.add(x)
self.allstrs.append(x)
#_lt.remove_duplicates_in_place(self.allstrs) # above block does this more efficiently
self._plaquettes[(L, germ)] = plaq
#keep track of which L,germ is the *first* one to "claim" a base string
# (useful for *not* duplicating data in color box plots)
if basestr not in self._baseStrToLGerm:
self._firsts.append((L, germ))
self._baseStrToLGerm[basestr] = (L, germ)
return missing_list
def add_unindexed(self, gsList, dsfilter=None):
"""
Adds unstructured operation sequences (not in any plaquette).
Parameters
----------
gsList : list of Circuits
The operation sequences to add.
dsfilter : DataSet, optional
If not None, check that this data set contains all of the
operation sequences being added. If dscheck does not contain a gate
sequence, it is *not* added.
Returns
-------
missing : list
A list of elements in `gsList` which were not found in `dsfilter`
and therefore not added.
"""
from ..construction import circuitconstruction as _gstrc # maybe move used routines to a circuittools.py?
#if dsfilter and len(dsfilter) > 8000: dsfilter = None # TEST DEBUG - remove dsfilter check
missing_list = []
for opstr in gsList:
if opstr not in self.allstrs_set:
if dsfilter:
trans_opstr = _gstrc.translate_circuit(opstr, self.aliases)
if trans_opstr not in dsfilter:
missing_list.append(opstr)
continue
self.allstrs_set.add(opstr)
self.allstrs.append(opstr)
self.unindexed.append(opstr)
return missing_list
def done_adding_strings(self):
"""
Called to indicate the user is done adding plaquettes.
"""
#placeholder in case there's some additional init we need to do.
pass
def get_plaquette(self, L, germ, onlyfirst=True):
"""
Returns a the plaquette at `(L,germ)`.
Parameters
----------
L : int
The maximum length.
germ : Circuit
The germ.
onlyfirst : bool, optional
If True, then when multiple plaquettes have been added with the
same base string, only the *first* added plaquette will be
returned normally. Requests for the other plaquettes will be
given an empty plaquette. This behavior is useful for color
box plots where we wish to avoid duplicated data.
Returns
-------
CircuitPlaquette
"""
if (L, germ) not in self._plaquettes:
p = self.create_plaquette(None, []) # no elements
p.simplify_circuits(None) # just marks as "simplified"
return p
if not onlyfirst or (L, germ) in self._firsts:
return self._plaquettes[(L, germ)]
else:
basestr = self._plaquettes[(L, germ)].base
p = self.create_plaquette(basestr, []) # no elements
p.simplify_circuits(None) # just marks as "simplified"
return p
def truncate(self, Ls=None, germs=None, prepStrs=None, effectStrs=None, seqs=None):
"""
Truncate this operation sequence structure to a subset of its current strings.
Parameters
----------
Ls : list, optional
The integer L-values to keep. If None, then all are kept.
germs : list, optional
The (Circuit) germs to keep. If None, then all are kept.
prepStrs, effectStrs : list, optional
The (Circuit) preparation and effect fiducial sequences to keep.
If None, then all are kept.
seqs : list
Keep only sequences present in this list of Circuit objects.
Returns
-------
LsGermsStructure
"""
Ls = self.Ls if (Ls is None) else Ls
germs = self.germs if (germs is None) else germs
prepStrs = self.prepStrs if (prepStrs is None) else prepStrs
effectStrs = self.effectStrs if (effectStrs is None) else effectStrs
cpy = LsGermsStructure(Ls, germs, prepStrs,
effectStrs, self.aliases, self.sequenceRules)
#OLD iPreps = [i for i, prepStr in enumerate(self.prepStrs) if prepStr in prepStrs]
#OLD iEffects = [i for i, eStr in enumerate(self.effectStrs) if eStr in effectStrs]
#OLD fidpairs = list(_itertools.product(iPreps, iEffects))
all_fidpairs = list(_itertools.product(list(range(len(prepStrs))), list(range(len(effectStrs)))))
for (L, germ), plaq in self._plaquettes.items():
basestr = plaq.base
if seqs is None:
fidpairs = all_fidpairs
else:
fidpairs = []
for i, j in all_fidpairs:
if prepStrs[i] + basestr + effectStrs[j] in seqs:
fidpairs.append((i, j))
if (L in Ls) and (germ in germs):
cpy.add_plaquette(basestr, L, germ, fidpairs)
cpy.add_unindexed(self.unindexed) # preserve unindexed strings
return cpy
def create_plaquette(self, baseStr, fidpairs=None):
"""
Creates a the plaquette for the given base string and pairs.
Parameters
----------
baseStr : Circuit
fidpairs : list
A list if `(i,j)` tuples of integers, where `i` is a prepation
fiducial index and `j` is a measurement fiducial index. If
None, then all pairs are included (a "full" plaquette is created).
Returns
-------
CircuitPlaquette
"""
if fidpairs is None:
fidpairs = list(_itertools.product(range(len(self.prepStrs)),
range(len(self.effectStrs))))
elements = [(j, i, self.prepStrs[i] + baseStr + self.effectStrs[j])
for i, j in fidpairs] # note preps are *cols* not rows
real_fidpairs = [(self.prepStrs[i], self.effectStrs[j]) for i, j in fidpairs] # strings, not just indices
return CircuitPlaquette(baseStr, len(self.effectStrs),
len(self.prepStrs), elements,
self.aliases, real_fidpairs)
def plaquette_rows_cols(self):
"""
Return the number of rows and columns contained in each plaquette of
this LsGermsStructure.
Returns
-------
rows, cols : int
"""
return len(self.effectStrs), len(self.prepStrs)
def process_circuits(self, processor_fn, updated_aliases=None):
"""
Manipulate this object's circuits according to `processor_fn`,
returning a new circuit structure with processed circuits.
Parameters
----------
processor_fn : function
A function which takes a single Circuit argument and returns
another (or the same) Circuit.
updated_aliases : dict, optional
Because the Label keys of an alias dictionary (maps
Label -> Circuit) cannot be processed as a Circuit, one must
supply a manualy processed alias dictionary. If you don't use
alias dictionaries just leave this set to None.
Returns
-------
LsGermsStructure
"""
P = processor_fn # shorhand
cpy = LsGermsStructure(self.Ls, list(map(P, self.germs)),
list(map(P, self.prepStrs)), list(map(P, self.effectStrs)),
updated_aliases, self.sequenceRules)
cpy.allstrs = list(map(P, self.allstrs))
cpy.allstrs_set = set(cpy.allstrs)
cpy.unindexed = list(map(P, self.unindexed))
cpy._plaquettes = {k: v.process_circuits(P, updated_aliases) for k, v in self._plaquettes.items()}
cpy._firsts = [(L, P(germ)) for (L, germ) in self._firsts]
cpy._baseStrToLGerm = {P(base): (L, P(germ)) for base, (L, germ) in self._baseStrToLGerm.items()}
return cpy
def copy(self):
"""
Returns a copy of this `LsGermsStructure`.
"""
cpy = LsGermsStructure(self.Ls, self.germs, self.prepStrs,
self.effectStrs, self.aliases, self.sequenceRules)
cpy.allstrs = self.allstrs[:]
cpy.allstrs_set = self.allstrs_set.copy()
cpy.unindexed = self.unindexed[:]
cpy._plaquettes = {k: v.copy() for k, v in self._plaquettes.items()}
cpy._firsts = self._firsts[:]
cpy._baseStrToLGerm = _copy.deepcopy(self._baseStrToLGerm.copy())
return cpy
class LsGermsSerialStructure(CircuitStructure):
"""
A type of operation sequence structure whereby sequences can be
indexed by L, germ, preparation-fiducial, and measurement-fiducial.
"""
def __init__(self, Ls, germs, nMinorRows, nMinorCols, aliases=None,
sequenceRules=None):
"""
Create an empty LsGermSerialStructure.
This type of operation sequence structure is useful for holding multi-qubit
operation sequences which have a germ and max-length structure but which have
widely varying fiducial sequences so that is it not useful to use the
minor axes (rows/columns) to represent the *same* fiducials for all
(L,germ) plaquettes.
Parameters
----------
Ls : list of ints
List of maximum lengths (x values)
germs : list of Circuits
List of germ sequences (y values)
nMinorRows, nMinorCols : int
The number of minor rows and columns to allocate space for.
These should be the maximum values required for any plaquette.
aliases : dict
Operation label aliases to be propagated to all plaquettes.
sequenceRules : list, optional
A list of `(find,replace)` 2-tuples which specify string replacement
rules. Both `find` and `replace` are tuples of operation labels
(or `Circuit` objects).
"""
self.Ls = Ls[:]
self.germs = germs[:]
self.nMinorRows = nMinorRows
self.nMinorCols = nMinorCols
self.aliases = aliases.copy() if (aliases is not None) else None
self.sequenceRules = sequenceRules[:] if (sequenceRules is not None) else None
self.allstrs = []
self.allstrs_set = set()
self.unindexed = []
self._plaquettes = {}
self._firsts = []
self._baseStrToLGerm = {}
super(LsGermsSerialStructure, self).__init__()
#Base class access in terms of generic x,y coordinates
def xvals(self):
""" Returns a list of the x-values"""
return self.Ls
def yvals(self):
""" Returns a list of the y-values"""
return self.germs
def minor_xvals(self):
""" Returns a list of the minor x-values (0-based integers)"""
return list(range(self.nMinorCols))
def minor_yvals(self):
""" Returns a list of the minor y-values (0-based integers)"""
return list(range(self.nMinorRows))
def add_plaquette(self, basestr, L, germ, fidpairs, dsfilter=None):
"""
Adds a plaquette with the given fiducial pairs at the
`(L,germ)` location.
Parameters
----------
basestr : Circuit
The base operation sequence of the new plaquette, typically `germ^power`
such that `len(germ^power) <= L`.
L : int
The maximum length value.
germ : Circuit
The germ string.
fidpairs : list
A list if `(prep,meas)` tuples of Circuit objects, specifying
the fiducial pairs for this plaquette. Note that this argument
is different from the corresponding one in
:method:`LsGermsStructure.add_plaquette` which takes pairs of
*integer* indices and can be None. In the present case, this
argument is mandatory and contains tuples of operation sequences.
dsfilter : DataSet, optional
If not None, check that this data set contains all of the
operation sequences being added. If dscheck does not contain a gate
sequence, it is *not* added.
Returns
-------
missing : list
A list of `(prep_fiducial, germ, L, effect_fiducial, entire_string)`
tuples indicating which sequences were not found in `dsfilter`.
"""
missing_list = []
from ..construction import circuitconstruction as _gstrc # maybe move used routines to a circuittools.py?
if dsfilter: # and len(dsfilter) < 8000: # TEST DEBUG
inds_to_remove = []
for k, (prepStr, effectStr) in enumerate(fidpairs):
el = prepStr + basestr + effectStr
trans_el = _gstrc.translate_circuit(el, self.aliases)
if trans_el not in dsfilter:
missing_list.append((prepStr, germ, L, effectStr, el))
inds_to_remove.append(k)
if len(inds_to_remove) > 0:
fidpairs = fidpairs[:] # copy
for i in reversed(inds_to_remove):
del fidpairs[i]
plaq = self.create_plaquette(basestr, fidpairs)
for x in (_gstrc.manipulate_circuit(opstr, self.sequenceRules) for i, j, opstr in plaq):
if x not in self.allstrs_set:
self.allstrs_set.add(x)
self.allstrs.append(x)
# _lt.remove_duplicates_in_place(self.allstrs) # above block does this more efficiently
self._plaquettes[(L, germ)] = plaq
#keep track of which L,germ is the *first* one to "claim" a base string
# (useful for *not* duplicating data in color box plots)
if basestr not in self._baseStrToLGerm:
self._firsts.append((L, germ))
self._baseStrToLGerm[basestr] = (L, germ)
return missing_list
def add_unindexed(self, gsList, dsfilter=None):
"""
Adds unstructured operation sequences (not in any plaquette).
Parameters
----------
gsList : list of Circuits
The operation sequences to add.
dsfilter : DataSet, optional
If not None, check that this data set contains all of the
operation sequences being added. If dscheck does not contain a gate
sequence, it is *not* added.
Returns
-------
missing : list
A list of elements in `gsList` which were not found in `dsfilter`
and therefore not added.
"""
from ..construction import circuitconstruction as _gstrc # maybe move used routines to a circuittools.py?
missing_list = []
for opstr in gsList:
if opstr not in self.allstrs_set:
if dsfilter:
trans_opstr = _gstrc.translate_circuit(opstr, self.aliases)
if trans_opstr not in dsfilter:
missing_list.append(opstr)
continue
self.allstrs_set.add(opstr)
self.allstrs.append(opstr)
self.unindexed.append(opstr)
return missing_list
def done_adding_strings(self):
"""
Called to indicate the user is done adding plaquettes.
"""
#placeholder in case there's some additional init we need to do.
pass
def get_plaquette(self, L, germ, onlyfirst=True):
"""
Returns a the plaquette at `(L,germ)`.
Parameters
----------
L : int
The maximum length.
germ : Circuit
The germ.
onlyfirst : bool, optional
If True, then when multiple plaquettes have been added with the
same base string, only the *first* added plaquette will be
returned normally. Requests for the other plaquettes will be
given an empty plaquette. This behavior is useful for color
box plots where we wish to avoid duplicated data.
Returns
-------
CircuitPlaquette
"""
if (L, germ) not in self._plaquettes:
p = self.create_plaquette(None, []) # no elements
p.simplify_circuits(None) # just marks as "simplified"
return p
if not onlyfirst or (L, germ) in self._firsts:
return self._plaquettes[(L, germ)]
else:
basestr = self._plaquettes[(L, germ)].base
p = self.create_plaquette(basestr, []) # no elements
p.simplify_circuits(None) # just marks as "simplified"
return p
def truncate(self, Ls=None, germs=None, nMinorRows=None, nMinorCols=None):
"""
Truncate this operation sequence structure to a subset of its current strings.
Parameters
----------
Ls : list, optional
The integer L-values to keep. If None, then all are kept.
germs : list, optional
The (Circuit) germs to keep. If None, then all are kept.
nMinorRows, nMinorCols : int or "auto", optional
The number of minor rows and columns in the new structure. If the
special "auto" value is used, the number or rows/cols is chosen
automatically (to be as small as possible). If None, then the values
of the original (this) circuit structure are kept.
Returns
-------
LsGermsSerialStructure
"""
Ls = self.Ls if (Ls is None) else Ls
germs = self.germs if (germs is None) else germs
nMinorCols = self.nMinorCols if (nMinorCols is None) else nMinorCols
nMinorRows = self.nMinorRows if (nMinorRows is None) else nMinorRows
if nMinorCols == "auto" or nMinorRows == "auto":
#Pre-compute fidpairs lists per plaquette to get #fidpairs for each
maxEls = 0
for (L, germ), plaq in self._plaquettes.items():
if (L in Ls) and (germ in germs):
maxEls = max(maxEls, len(plaq.elements))
if nMinorCols == "auto" and nMinorRows == "auto":
#special behavior: make as square as possible
nMinorRows = nMinorCols = int(_np.floor(_np.sqrt(maxEls)))
if nMinorRows * nMinorCols < maxEls: nMinorCols += 1
if nMinorRows * nMinorCols < maxEls: nMinorRows += 1
assert(nMinorRows * nMinorCols >= maxEls), "Logic Error!"
elif nMinorCols == "auto":
nMinorCols = maxEls // nMinorRows
if nMinorRows * nMinorCols < maxEls: nMinorCols += 1
else: # nMinorRows == "auto"
nMinorRows = maxEls // nMinorCols
if nMinorRows * nMinorCols < maxEls: nMinorRows += 1
cpy = LsGermsSerialStructure(Ls, germs, nMinorRows, nMinorCols,
self.aliases, self.sequenceRules)
for (L, germ), plaq in self._plaquettes.items():
basestr = plaq.base
fidpairs = plaq.fidpairs
if (L in Ls) and (germ in germs):
cpy.add_plaquette(basestr, L, germ, fidpairs)
cpy.add_unindexed(self.unindexed) # preserve unindexed strings
return cpy
def create_plaquette(self, baseStr, fidpairs):
"""
Creates a the plaquette for the given base string and pairs.
Parameters
----------
baseStr : Circuit
fidpairs : list
A list if `(prep,meas)` tuples of Circuit objects, specifying
the fiducial pairs for this plaquette. Note that this argument
is mandatory and cannot be None as for :class:`LsGermsStructure`.
Returns
-------
CircuitPlaquette
"""
ji_list = list(_itertools.product(list(range(self.nMinorRows)),
list(range(self.nMinorCols))))
assert(len(ji_list) >= len(fidpairs)), "Number of minor rows/cols is too small!"
elements = [(j, i, prepStr + baseStr + effectStr)
for (j, i), (prepStr, effectStr) in
zip(ji_list[0:len(fidpairs)], fidpairs)] # note preps are *cols* not rows
return CircuitPlaquette(baseStr, self.nMinorRows,
self.nMinorCols, elements,
self.aliases, fidpairs[:])
def plaquette_rows_cols(self):
"""
Return the number of rows and columns contained in each plaquette of
this LsGermsStructure.
Returns
-------
rows, cols : int
"""
return self.nMinorRows, self.nMinorCols
def process_circuits(self, processor_fn, updated_aliases=None):
"""
Manipulate this object's circuits according to `processor_fn`,
returning a new circuit structure with processed circuits.
Parameters
----------
processor_fn : function
A function which takes a single Circuit argument and returns
another (or the same) Circuit.
updated_aliases : dict, optional
Because the Label keys of an alias dictionary (maps
Label -> Circuit) cannot be processed as a Circuit, one must
supply a manualy processed alias dictionary. If you don't use
alias dictionaries just leave this set to None.
Returns
-------
LsGermsSerialStructure
"""