Enforce type safety in NeighborTable#10774
Merged
Merged
Conversation
jakelishman
added
Changelog: None
Collaborator
|
One or more of the the following people are requested to review this:
|
This hides the internal `.neighbors` field in favour of instead implemented `Index<PhysicalQubit>` on the entire `NeighborTable` struct. This is done because indexing into `.neighbors` required calling `PhysicalQubit::index` to retrieve a `usize`, but a similar method also exists on `VirtualQubit`. This meant that it was previously a normal API pattern to do `neighbors.neighbors[qubit.index()]`, and this threw away the type safety: it would compile without warning whether `qubit` was physical or virtual. To support the hiding of the `.neighbors` field, the constructor of the coupling map is moved to be an associated function on `NeighborTable`, so the unsafe access only happens within the context of all other unsafe operations.
jakelishman
force-pushed
the
rust/typesafe-neighbours
branch
from
452ad44 to
3a3a52d
Compare
Member
Author
|
Now rebased over #10761. |
mtreinish
approved these changes
Sep 5, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
This hides the internal
.neighborsfield in favour of instead implementedIndex<PhysicalQubit>on the entireNeighborTablestruct. This is done because indexing into.neighborsrequired callingPhysicalQubit::indexto retrieve ausize, but a similar method also exists onVirtualQubit. This meant that it was previously a normal API pattern to doneighbors.neighbors[qubit.index()], and this threw away the type safety: it would compile without warning whetherqubitwas physical or virtual.To support the hiding of the
.neighborsfield, the constructor of the coupling map is moved to be an associated function onNeighborTable, so the unsafe access only happens within the context of all other unsafe operations.Details and comments
Follow-on from #10761, which this PR depends on.