Add random_layout function and Pos2DMapping #305
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a new function random_layout() which is used to generate a random layout for a graph that can be used in visualization. This is necessary for building a matplotlib drawer (issue Qiskit#298 and a first draft of the implementation Qiskit#304). To make the function more efficient it also adds a new custom return type Pos2DMapping which is used to build an imutable readonly dict compatible result container for the output type from this function. Related to Qiskit#280
Pull Request Test Coverage Report for Build 763754537
💛 - Coveralls |
Co-authored-by: Jielun (Chris) Chen <[email protected]>
nahumsa
reviewed
Apr 12, 2021
Co-authored-by: Nahum Rosa Cruz Sa <[email protected]>
georgios-ts
reviewed
Apr 19, 2021
| @@ -154,3 +165,4 @@ Return Iterator Types | |||
| retworkx.NodeIndices | |||
| retworkx.EdgeList | |||
| retworkx.WeightedEdgeList | |||
| retworkx.Pos2DMapping | |||
There was a problem hiding this comment.
with retworkx.*_layout(graph).keys() a user will see Pos2DMappingKeys. similar with.values(). Should we have docs for these types?
There was a problem hiding this comment.
I'm not sure if it matters too much, we can add it to the documentation it doesn't hurt. I just left it out since there really isn't any documentation for those types and we don't actually export them in the retworkx module. I basically modeled these types on how python's dict works it 'returns a dict_keys, dict_values, and dict_items class for .keys(), .values(), and .items(). I couldn't find any documentation on those classes except in the C-API: https://docs.python.org/3/c-api/dict.html?highlight=dict_keys#c.PyDict_Keys
Co-authored-by: georgios-ts <[email protected]>
This commit changes the input type of the center option to be a fixed 2 element array instead of a tuple. This still works as a tuple for the python interface but has a defined contiguous memory layout in rust. It also is consistent with the type for elements in the position mapping.
georgios-ts
approved these changes
Apr 19, 2021
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a new function
random_layout()which is used togenerate a random layout for a graph that can be used in visualization.
This is necessary for building a matplotlib drawer (issue #298 and a
first draft of the implementation #304). To make the function more
efficient it also adds a new custom return type
Pos2DMappingwhich isused to build an immutable readonly dict compatible result container for
the output type from this function.
Related to #280