Document elementwise functions for DOK arrays #451
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
Codecov Report
@@ Coverage Diff @@
## master #451 +/- ##
=======================================
Coverage 95.15% 95.15%
=======================================
Files 20 20
Lines 2975 2975
=======================================
Hits 2831 2831
Misses 144 144 |
docs/construct.rst
Outdated
| y = sparse.random((10, 10), 0.5, format="dok") | ||
| sparse.elemwise(np.add, x, y) | ||
|
|
||
| :obj:`DOK` arrays also support standard `__ufunc__` operations and operators, including comparison operators, |
There was a problem hiding this comment.
I don't think __ufunc__ is a thing.
docs/construct.rst
Outdated
| y = np.random.random((10, 10)) | ||
| x == y | ||
|
|
||
| :obj:`DOK` arrays are returned from elemwise functions and standard `__ufunc__` operations if and only if all |
There was a problem hiding this comment.
I changed it to just say universal... I'm not sure if there's a better technical term to refer to it by
|
I think the technical term would be operators and ufuncs, without the double-underscore. |
|
@hameerabbasi I've made that change. Is there anything else you'd like documented? |
hameerabbasi
approved these changes
Mar 23, 2021
|
Thanks, @DragaDoncila! |
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.
@hameerabbasi I've updated the docs to include elementwise operations for DOK arrays.
At this point I'm not sure whether you want to keep the DOK documentation in Construct Sparse Arrays, or whether you'd like to pull it out as its own section, but please let me know if that's the case, and whether you want more detail on the elementwise operations e.g. more detail on comparisons, etc. As it is, I tried to follow the convention already used for the COO arrays.