vsip_arg_p - Compute Phase Angle of Complex Scalar

Core

This manual is preliminary and incomplete.
While our Core implementation implements all functions given in the standard we are still working on completing this documentation.

Please refer to the VSIPL standard for a complete function reference of the Core profile until we have completed work on this documentation.

[next] [prev] [prev-tail] [tail] [up]

2.1.1 vsip_arg_p - Compute Phase Angle of Complex Scalar

vsip_scalar_f vsip_arg_f(vsip_cscalar_f x);

Description

This function computes the phase angle (argument) of a complex scalar value. The phase angle $θ$ is computed as:

θ= atan2(imag(x),real(x))

where $atan2$ is the two-argument arctangent function that correctly handles all quadrants of the complex plane.

The returned phase angle is in the range $[-π,π]$ radians.

Parameters

vsip_cscalar_p x: Input complex scalar value.

Return Value

Returns the phase angle in radians, in the range $[-π,π]$ .

[next] [prev] [prev-tail] [front] [up]