Mercurial > octave-libtiff
changeset 21946:9780323c1c89 stable
doc: clarify differences between atan and atan2 (bug #48178)
* data.cc (Fatan2): Expand docstring with wording similar to the C++
standard description of atan2, compare to the arg function.
author | Mike Miller <mtmiller@octave.org> |
---|---|
date | Fri, 17 Jun 2016 14:40:42 -0700 |
parents | 42929c66846d |
children | 835d070ede9c 00f7b278defd |
files | libinterp/corefcn/data.cc |
diffstat | 1 files changed, 5 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/data.cc Thu Jun 16 10:17:21 2016 -0700 +++ b/libinterp/corefcn/data.cc Fri Jun 17 14:40:42 2016 -0700 @@ -216,7 +216,11 @@ Compute atan (@var{y} / @var{x}) for corresponding elements of @var{y}\n\ and @var{x}.\n\ \n\ -@var{y} and @var{x} must match in size and orientation.\n\ +@var{y} and @var{x} must match in size and orientation. The signs of\n\ +elements of @var{y} and @var{x} are used to determine the quadrats of each\n\ +resulting value.\n\ +\n\ +This function is equivalent to @code{arg (complex (@var{x}, @var{y}))}.\n\ @seealso{tan, tand, tanh, atanh}\n\ @end deftypefn") {