vsip_cmagsq_p - Compute Magnitude Squared 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.3 vsip_cmagsq_p - Compute Magnitude Squared of Complex Scalar

vsip_scalar_f vsip_cmagsq_f(vsip_cscalar_f x);

Description

This function computes the squared magnitude of a complex scalar. The squared magnitude is computed as:

2 2 magnitude_squared =real(x) +imag(x)

This function is often preferred over vsip_cmag_f if only magnitudes are to be compared.

Parameters

vsip_cscalar_p x: Input complex scalar value.

Return Value

Returns the squared magnitude of the complex scalar.

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