Add Heavy square code to generators #313
Conversation
Rebasing
Rebasing
Added implementation of [heavy hex](https://journals.aps.org/prx/abstract/10.1103/PhysRevX.10.011022), the input is the code distance, d. In the implementation I chose to add nodes referring to each type of qubit used in the Heavy Hex Code (data, syndrome, and flag) which _may cause the node order to be confusing_, but that was the best way that I figure out how to implement.
Pull Request Test Coverage Report for Build 1160023027
💛 - Coveralls |
src/generators.rs
Outdated
| @@ -983,6 +983,139 @@ pub fn directed_grid_graph( | |||
| }) | |||
| } | |||
|
|
|||
| /// Generate an undirected heavy square graph. | |||
| /// | |||
There was a problem hiding this comment.
There is a variant of the heavy square lattice (see Fig 10.b, right-hand side) whose edge case handling (lines 1054-1075 in the present PR) is a bit different. No comment on whether it's worth including as an option, but it is definitely worth mentioning in the docstring.
There was a problem hiding this comment.
Do you have any suggestion how this can be mentioned in the docstring?
There was a problem hiding this comment.
The only important thing is to bring to the reader's attention that there is another variant and to disambiguate which you mean. So, something like:
NOTE: This function generates the four-frequency variant of the heavy square code. See Fig 10.b left of /1907.09528 , and compare Fig 10.b right.
There was a problem hiding this comment.
The note was added on 60a150b.
|
LGTM, just as on #293 I took care of applying the last suggestions and fixing the tests to include this in the release. Thanks for adding these generators @nahumsa both this and heavy hex will be really nice to integrate with qiiskit-terra's |
Related to #150.
Added implementation of heavy hex, the input is the code distance, d. In the implementation I chose to add nodes referring to each type of qubit used in the Heavy Hex Code (data, syndrome, and flag) which may cause the node order to be confusing, but that was the best way that I figure out how to implement.