-
Notifications
You must be signed in to change notification settings - Fork 415
Fix 2 problems in _multitensor.py
#1293
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mhucka
wants to merge
5
commits into
quantumlib:main
Choose a base branch
from
mhucka:fix-mutable-default-arg
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1a49ff0
Fix 2 problems in `_multitensor.py`
mhucka 5627b53
Add unit tests for `Multitensor` dual basis arg
mhucka c187cab
Fix typo
mhucka 9d025d0
Merge branch 'main' into fix-mutable-default-arg
mhucka 8665b93
Remove no-longer-accurate comment
mhucka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you update or remove the comment above this.
Are we sure
addis the intended operation here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The function name is plural but the argument name is singular. The docstring says "add" but the inline comment says "extend". maybe this was originally an extend-type operation and was changed to an append-type?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, yes, good point. Thanks for catching that. Fixed in the next push.
Yeah, something probably happened there. I also think the bug was never caught before now because the tests in
_multitensor_test.pywere incomplete. (I only ran into the problem because I was working on getting parallel Pytest working, which revealed the problem of initializingMultiTensorwith a mutable object, which led to more poking around.)Here's what's happening:
DualBasisElementobjects are iterable because they implement the__iter__()magic method (c.f._dualbasis.py). Each call to that method returns a tuple of 3 items.In Python, doing
somelist.extend(someobject)invokes the__iter__method onsomeobject. On aDualBasisElementobject, doing that ends up adding a tuple of 3 items tosomelist. That's in contrast with the operationsomelist.append(someobject), which puts theDualBasisElementobject itself onsomelist.The previous
_multitensor_test.pyonly tested adding an item to the listdual_basis.elements, and never tested using the results. The methodsynthesize_dual_basis()eventually calls thesynthesize_element()method on each item on the list, and therein lies the problem:synthesize_element()does a loop like this:That works as expected if the values on the
elementslist inDualBasisare actualDualBasisElementobjects because their__iter__()method will get called in theforloop (yielding the 3 items above), but that won't happen if the values on theelementslist are tuples.