Menu

#2235 atan2() needs documentation tweak

nextrelease
open-fixed
nobody
None
5
2020-02-08
2020-02-07
No

In the documentation for the atan2() function (included below), there is a good discussion about different orderings of x and y in different implementations, but there is no explicit definition of what x and y actually are. My first assumption is usually that the function returns the value of atan(x/y), but I've seen implementations where it is atan(y/x). This needs to be clearly stated.

public static QDataSet atan2(QDataSet y,
QDataSet x)

element-wise atan2, 4-quadrant atan. Note different languages have different argument order. Microsoft office uses atan2(x,y); IDL uses atan(y,x); Matlab uses atan2(y,x); and NumPy uses arctan2(y,x).

Parameters:
y - the y values
x - the x values
Returns:
angles between -PI and PI

Discussion

  • Jeremy Faden

    Jeremy Faden - 2020-02-08

    I've copied over a couple of sentences from the Java Math documentation. Please close this ticket of you agree this is sufficient.

     

    Last edit: Jeremy Faden 2020-02-08
  • Jeremy Faden

    Jeremy Faden - 2020-02-08
    • status: open --> open-fixed