angle

Contents

angle#

class brainunit.math.angle(x, unit_to_scale=None, **kwargs)#

Return the angle of the complex argument, element-wise.

Parameters:

  • x (Array | ndarray | bool | number | bool | int | float | complex | saiunit.Quantity) – Complex-valued input.

  • unit_to_scale (saiunit.Unit | None) – Unit used to convert x to a dimensionless number first.

Returns:

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

Return type:

Array

Examples

>>> import saiunit as u
>>> import jax.numpy as jnp
>>> u.math.angle(jnp.array([1.0 + 1.0j, 1.0 + 0.0j]))
Array([0.7853982, 0.       ], dtype=float32)
Contents