Skip to content

tuple_atan2TupleAtan2TupleAtan2tuple_atan2tuple_atan2🔗

Short description🔗

tuple_atan2TupleAtan2TupleAtan2tuple_atan2tuple_atan2 — Compute the arctangent of a tuple for all four quadrants.

Signature🔗

tuple_atan2( number Y, number X, out angle.rad ATan )void TupleAtan2( const HTuple& Y, const HTuple& X, HTuple* ATan )static void HOperatorSet.TupleAtan2( HTuple y, HTuple x, out HTuple ATan )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]] ) -> floatHerror tuple_atan2( double Y, double X, double* ATan )

Herror T_tuple_atan2( const Htuple Y, const Htuple X, Htuple* ATan )

HTuple HTuple::TupleAtan2( const HTuple& X ) const

HTuple HTuple.TupleAtan2( HTuple x )

Description🔗

tuple_atan2TupleAtan2 computes the arctangent of the input tuples \(\textrm{Y}/\textrm{X}\) while treating all four quadrants correctly. The arctangent is always returned as a floating point number in ATanATanatan. The angles in ATanATanatan 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_atan2TupleAtan2, which can be used in an expression in the following syntax:

ATan := atan2(Y, X)

Execution information🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

Yyy (input_control) number(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)

Input tuple of the y-values.

Xxx (input_control) number(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)

Input tuple of the x-values.

ATanATanatan (output_control) angle.rad(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Arctangent of the input tuple.

Combinations with other operators🔗

Combinations

Alternatives

tuple_atanTupleAtan, tuple_asinTupleAsin, tuple_acosTupleAcos

See also

tuple_tanTupleTan, tuple_tanhTupleTanh

Module🔗

Foundation