arctan2

Contents

arctan2#

class saiunit.math.arctan2(x, y, unit_to_scale=None, **kwargs)#

Element-wise arc tangent of x / y choosing the quadrant correctly.

Parameters:

  • x (Array | ndarray | bool | number | bool | int | float | complex | saiunit.Quantity) – y-coordinates (numerator).

  • y (Array | ndarray | bool | number | bool | int | float | complex | saiunit.Quantity) – x-coordinates (denominator). Must be broadcastable with x.

  • unit_to_scale (saiunit.Unit | None) – Unit used to convert both inputs to dimensionless numbers.

Returns:

out – Angle in radians, in (-pi, pi].

Return type:

Array

Examples

>>> import saiunit as u
>>> import jax.numpy as jnp
>>> u.math.arctan2(jnp.array([1.0, -1.0]),
...                 jnp.array([1.0, 1.0]))
Array([ 0.7853982, -0.7853982], dtype=float32)
Contents