Add notes on overwriting gufunc inputs to docs #4957
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
It is possible to write gufuncs that overwrite input arrays, but the new values may not be visible outside the gufunc execution, for example if a temporary array is passed in. This commit adds notes to the documentation warning the user of this case.
gmarkall
changed the title
|
Added WIP tag while I see what the build failures are. |
gmarkall
changed the title
|
Removed WIP - I see master is broken with the same problem. |
|
/AzurePipelines run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
2 tasks
docs/source/user/vectorize.rst
Outdated
| [4.2, 4.2, 4.2], | ||
| [4.2, 4.2, 4.2]]) | ||
|
|
||
| This works because Numpy passes a pointer to the input data directly into the |
There was a problem hiding this comment.
Suggested change
| This works because Numpy passes a pointer to the input data directly into the | |
| This works because NumPy can pass the input data directly into the `init_values` function as the data `dtype` matches that of the declared argument. |
Or something like ^. I think this needs to not refer to pointers and note that it's the dtype match that prevents the copy.
stuartarchibald
added
4 - Waiting on author
Co-Authored-By: stuartarchibald <stuartarchibald@users.noreply.github.com>
|
Thanks for the review - all suggestions now applied. I did modify the suggestion about referring to input data rather than pointers, as it left a trailing half-sentence, but otherwise it is applied as you suggested. |
|
Thanks for the fixes so far, one more |
Co-Authored-By: stuartarchibald <stuartarchibald@users.noreply.github.com>
stuartarchibald
added
5 - Ready to merge
stuartarchibald
approved these changes
Jan 21, 2020
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.
As discussed in #4952, one cannot rely on writing to gufunc input values. This PR adds some notes on this to the documentation. I decided against explicitly stating that you shouldn't do it, because I understand it is a "feature" that people make use of from time to time.