tuple_atan2tuple_atan2TupleAtan2TupleAtan2 (Operator)
Name
tuple_atan2tuple_atan2TupleAtan2TupleAtan2 — Compute the arctangent of a tuple for all four quadrants.
Signature
Herror tuple_atan2(double Y, double X, double* ATan)
Herror T_tuple_atan2(const Htuple Y, const Htuple X, Htuple* ATan)
 
void TupleAtan2(const HTuple& Y, const HTuple& X, HTuple* ATan)
HTuple HTuple::TupleAtan2(const HTuple& X) const
 
Description
tuple_atan2tuple_atan2TupleAtan2TupleAtan2TupleAtan2 computes the arctangent of the input tuples
YYYYy/XXXXx while treating all four quadrants
correctly.  The arctangent is always returned as a floating point
number in ATanATanATanATanATan. The angles in ATanATanATanATanATan are represented in
radians. The arctangent of a string is not allowed.
Exception: Empty input tuples
If either or both of the input tuples are empty, the operator returns an
empty tuple.
HDevelop In-line Operation
HDevelop provides an in-line operation for tuple_atan2tuple_atan2TupleAtan2TupleAtan2TupleAtan2,
which can be used in an expression in the following syntax:
ATan := atan2(Y, X)
Execution Information
  - Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
  
YYYYy (input_control)  number(-array) → HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
 
Input tuple of the y-values.
 
  
XXXXx (input_control)  number(-array) → HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
 
Input tuple of the x-values.
 
  
ATanATanATanATanATan (output_control)  angle.rad(-array) → HTupleHTupleHtuple (real) (double) (double) (double)
 
Arctangent of the input tuple.
 
Alternatives
tuple_atantuple_atanTupleAtanTupleAtanTupleAtan, 
tuple_asintuple_asinTupleAsinTupleAsinTupleAsin, 
tuple_acostuple_acosTupleAcosTupleAcosTupleAcos
See also
tuple_tantuple_tanTupleTanTupleTanTupleTan, 
tuple_tanhtuple_tanhTupleTanhTupleTanhTupleTanh
Module
Foundation