Feature arctan2 #593
Feature arctan2 #593
Conversation
Codecov Report
@@ Coverage Diff @@
## master #593 +/- ##
=======================================
Coverage 96.48% 96.49%
=======================================
Files 75 75
Lines 15214 15249 +35
=======================================
+ Hits 14679 14714 +35
Misses 535 535
Continue to review full report at Codecov.
|
heat/core/trigonometrics.py
Outdated
| >>> ht.arctan2(y, x) * 180 / ht.pi | ||
| tensor([-135.0000, -45.0000, 45.0000, 135.0000], dtype=torch.float64) | ||
| """ | ||
| # Special Case: integer -> float because torch.atan2() does not work with integer types on version 1.5.0. |
There was a problem hiding this comment.
This should probably issued as warning to the user
There was a problem hiding this comment.
I'm not sure. numpy allows integer types. I rewrote the comment a little bit.
heat/core/trigonometrics.py
Outdated
| @@ -99,6 +102,44 @@ def arctan(x, out=None): | |||
| return local_op(torch.atan, x, out) | |||
|
|
|||
|
|
|||
| def arctan2(x1, x2, out=None): | |||
There was a problem hiding this comment.
Charlie updated our docstrings (to be found in branch 504). This function needs
a) a return type annotation
b) DNDarray should be :class:DNDarray
Also out should be either removed if not used/applicable
There was a problem hiding this comment.
I hope I found everything.
heat/core/trigonometrics.py
Outdated
| import torch | ||
| from .constants import pi | ||
| from .operations import __local_op as local_op | ||
| from .operations import __binary_op as binary_op | ||
| from . import dndarray |
There was a problem hiding this comment.
This should be from .dndarray import DNDarray, then DNDarray can be annotated directly
heat/core/trigonometrics.py
Outdated
| @@ -99,6 +105,32 @@ def arctan(x, out=None): | |||
| return local_op(torch.atan, x, out) | |||
|
|
|||
|
|
|||
| def arctan2(x1, x2) -> dndarray.DNDarray: | |||
heat/core/trigonometrics.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
| x1 : :class:DNDarray |
There was a problem hiding this comment.
here, the :class:is not needed, can be just DNDarray
heat/core/trigonometrics.py
Outdated
| def arctan2(x1, x2) -> dndarray.DNDarray: | ||
| """ | ||
| Element-wise arc tangent of ``x1/x2`` choosing the quadrant correctly. | ||
| Returns a new :class:``DNDarray`` with the signed angles in radians between vector (``x2``,``x1``) and vector (1,0) |
There was a problem hiding this comment.
This is ok, DNDarray will now be displayed in markdown code-style. If you want to create a cross-reference link to the DNDarray class, you must use :class:~heat.core.dndarray.DNDarray .... with the ~ in front the whole module path will not be displayed in the docs. However, since the returntype is already a link, I don't think this is necessary here, just a note for the future :)
heat/core/trigonometrics.py
Outdated
| ---------- | ||
| x1 : :class:DNDarray | ||
| y-coordinates | ||
| x2 : :class:DNDarray |
There was a problem hiding this comment.
same as above, :class: not needed
heat/core/trigonometrics.py
Outdated
| x1 : :class:DNDarray | ||
| y-coordinates | ||
| x2 : :class:DNDarray | ||
| x-coordinates. If ``x1.shape != x2.shape``, they must be broadcastable to a common shape (which becomes the shape of the output). |
There was a problem hiding this comment.
in Markdown code style, please refrain from using whitespaces around operators (it looks shitty in the docs due to the different font and size)
heat/core/trigonometrics.py
Outdated
| x2 : :class:DNDarray | ||
| x-coordinates. If ``x1.shape != x2.shape``, they must be broadcastable to a common shape (which becomes the shape of the output). | ||
|
|
||
| Example |
Description
Issue/s resolved: #546
This PR adds a arctan2 function to HeAT
Changes proposed:
Type of change
New feature
Due Diligence
Does this change modify the behaviour of other functions? If so, which?
no