Developer Reference

  • 2020
  • 07/15/2020
  • Public Content
Contents

Magnitude

Computes the magnitudes of the elements of a complex vector.

Syntax

IppStatus ippsMagnitude_32f(const Ipp32f*
pSrcRe
, const Ipp32f*
pSrcIm
, Ipp32f*
pDst
, int
len
);
IppStatus ippsMagnitude_64f(const Ipp64f*
pSrcRe
, const Ipp64f*
pSrcIm
, Ipp64f*
pDst
, int
len
);
IppStatus ippsMagnitude_32fc(const Ipp32fc*
pSrc
, Ipp32f*
pDst
, int
len
);
IppStatus ippsMagnitude_64fc(const Ipp64fc*
pSrc
, Ipp64f*
pDst
, int
len
);
IppStatus ippsMagnitude_16s32f(const Ipp16s*
pSrcRe
, const Ipp16s*
pSrcIm
, Ipp32f*
pDst
, int
len
);
IppStatus ippsMagnitude_16sc32f(const Ipp16sc*
pSrc
, Ipp32f*
pDst
, int
len
);
IppStatus ippsMagnitude_16s_Sfs(const Ipp16s*
pSrcRe
, const Ipp16s*
pSrcIm
, Ipp16s*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsMagnitude_16sc_Sfs(const Ipp16sc*
pSrc
, Ipp16s*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsMagnitude_32sc_Sfs(const Ipp32sc*
pSrc
, Ipp32s*
pDst
, int
len
, int
scaleFactor
);
Include Files
ipps.h
Domain Dependencies
Headers:
ippcore.h
,
ippvm.h
Libraries:
ippcore.lib
,
ippvm.lib
Parameters
pSrc
Pointer to the source vector.
pSrcRe
Pointer to the vector with the real parts of complex elements.
pSrcIm
Pointer to the vector with the imaginary parts of complex elements.
pDst
Pointer to the destination vector.
len
Number of elements in the vector
scaleFactor
Scale factor, refer to Integer Scaling.
Description
The complex flavor of this function computes the element-wise magnitude of the complex vector
pSrc
and stores the result in
pDst
. The element-wise magnitude is defined by the formula:
magn
[
n
] = (
pSrc
[
n
].
re
2
+
pSrc
[
n
].
im
2
)
1/2
The real flavor of the function
ippsMagnitude
computes the element-wise magnitude of the complex vector whose real and imaginary components are specified in the vectors
pSrcRe
and
pSrcIm
, respectively, and stores the result in
pDst
. The element-wise magnitude is defined by the formula:
magn
[
n
] = (
pSrcRe
[
n
]
2
+
pSrcIm
[
n
]
2
)
1/2
Return Values
ippStsNoErr
Indicates no error.
ippStsNullPtrErr
Indicates an error when any of the specified pointers is
NULL
.
ippStsSizeErr
Indicates an error when
len
is less than or equal to 0.

Example

/******************************************************************************* * Copyright 2017-2020 Intel Corporation. * * This software and the related documents are Intel copyrighted materials, and * your use of them is governed by the express license under which they were * provided to you (License). Unless the License provides otherwise, you may not * use, modify, copy, publish, distribute, disclose or transmit this software or * the related documents without Intel's prior written permission. * * This software and the related documents are provided as is, with no express * or implied warranties, other than those that are expressly stated in the * License. *******************************************************************************/ #include <stdio.h> #include "ipp.h" /* Next two defines are created to simplify code reading and understanding */ #define EXIT_MAIN exitLine: /* Label for Exit */ #define check_sts(st) if((st) != ippStsNoErr) goto exitLine; /* Go to Exit if Intel(R) Integrated Primitives (Intel(R) IPP) function returned status different from ippStsNoErr */ /* Results of ippMalloc() are not validated because Intel(R) IPP functions perform bad arguments check and will return an appropriate status */ int main() { Ipp32fc pSrc[5] = { { 1.2, 3.2 }, { 0.0, 0.3 }, { 4.3, 6.7 }, { 4.2, 0.0 }, { 1.2, 1.2 } }; Ipp32f pDstIm[5]; IppStatus status; int i; printf("\nSource vector\n"); for (i = 0; i < 5; i++) printf("%.1f, %.1f; ", pSrc[i].re, pSrc[i].im); check_sts(status = ippsMagnitude_32fc(pSrc, pDstIm, 5)); printf("\nResult values vector\n"); for (i = 0; i < 5; i++) printf("%.1f ", pDstIm[i]); EXIT_MAIN printf("\nExit status %d (%s)\n", (int)status, ippGetStatusString(status)); return (int)status; }

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804