Phase
Phase
Computes the phase angles of elements of a complex
vector.
Syntax
IppStatus ippsPhase_64fc(const Ipp64fc*
pSrc
, Ipp64f*
pDst
, int
len
);
IppStatus ippsPhase_32fc(const Ipp32fc*
pSrc
, Ipp32f*
pDst
, int
len
);
IppStatus ippsPhase_16sc32f(const
Ipp16sc*
pSrc
, Ipp32f*
pDst
, int
len
);
IppStatus ippsPhase_64f(const Ipp64f*
pSrcRe
, const Ipp64f*
pSrcIm
, Ipp64f*
pDst
, int
len
);
IppStatus ippsPhase_32f(const Ipp32f*
pSrcRe
, const Ipp32f*
pSrcIm
, Ipp32f*
pDst
, int
len
);
IppStatus ippsPhase_16s32f(const Ipp16s*
pSrcRe
, const Ipp16s*
pSrcIm
, Ipp32f*
pDst
, int
len
);
IppStatus ippsPhase_16sc_Sfs(const
Ipp16sc*
pSrc
, Ipp16s*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsPhase_16s_Sfs(const Ipp16s*
pSrcRe
, const Ipp16s*
pSrcIm
, Ipp16s*
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 source vector which stores the real components.
- pSrcIm
- Pointer to the source vector which stores the imaginary components.
- pDst
- Pointer to the vector which stores the phase (angle) components of the elements in radians. Phase values are in the range (-π, π].
- len
- Number of elements in the vector
- scaleFactor
- Scale factor, refer to Integer Scaling .
Description
This function returns the phase angles of elements of the complex
input vector
pSrc
, or
the complex input vector whose real and imaginary components are specified in the
vectors pSrcRe
and
pSrcIm
,
respectively, and stores the result in the vector pDst
. Phase values are
returned in radians and are in the range (-π, π] .Return Values
- ippStsNoErr
- Indicates no error.
- ippStsNullPtrErr
- Indicates an error when at least one of the specified pointers isNULL.
- ippStsSizeErr
- Indicates an error whenlenis less than or equal to zero.
Example
/*******************************************************************************
* Copyright 2015-2021 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 = ippsPhase_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;
}