tuple_atan2tuple_atan2TupleAtan2TupleAtan2tuple_atan2 (Operator)
Name
tuple_atan2tuple_atan2TupleAtan2TupleAtan2tuple_atan2 — 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
def tuple_atan2(y: MaybeSequence[Union[float, int]], x: MaybeSequence[Union[float, int]]) -> Sequence[float]
def tuple_atan2_s(y: MaybeSequence[Union[float, int]], x: MaybeSequence[Union[float, int]]) -> float
Description
tuple_atan2tuple_atan2TupleAtan2TupleAtan2tuple_atan2 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_atan2TupleAtan2TupleAtan2tuple_atan2,
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) → HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Input tuple of the y-values.
XXXxx (input_control) number(-array) → HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Input tuple of the x-values.
ATanATanATanATanatan (output_control) angle.rad(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)
Arctangent of the input tuple.
Alternatives
tuple_atantuple_atanTupleAtanTupleAtantuple_atan,
tuple_asintuple_asinTupleAsinTupleAsintuple_asin,
tuple_acostuple_acosTupleAcosTupleAcostuple_acos
See also
tuple_tantuple_tanTupleTanTupleTantuple_tan,
tuple_tanhtuple_tanhTupleTanhTupleTanhtuple_tanh
Module
Foundation