Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

ID 790148
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

RealToCplx

Returns a complex vector constructed from the real and imaginary parts of two real vectors.

Syntax

IppStatus ippsRealToCplx_16s(const Ipp16s* pSrcRe, const Ipp16s* pSrcIm, Ipp16sc* pDst, int len);

IppStatus ippsRealToCplx_32f(const Ipp32f* pSrcRe, const Ipp32f* pSrcIm, Ipp32fc* pDst, int len);

IppStatus ippsRealToCplx_64f(const Ipp64f* pSrcRe, const Ipp64f* pSrcIm, Ipp64fc* pDst, int len);

Include Files

ipps.h

Domain Dependencies

Headers: ippcore.h, ippvm.h

Libraries: ippcore.lib, ippvm.lib

Parameters

pSrcRe

Pointer to the vector with real parts of complex elements.

pSrcIm

Pointer to the vector with imaginary parts of complex elements.

pDst

Pointer to the destination vector.

len

Number of elements in the vector.

Description

This function returns a complex vector pDst constructed from the real and imaginary parts of the input vectors pSrcRe and pSrcIm.

If pSrcRe is NULL, the real component of the vector is set to zero.

If pSrcIm is NULL, the imaginary component of the vector is set to zero.

Note that the pointers cannot be both NULL.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error when the pDst pointer is NULLNULL. The pointer pSrcRe or pSrcIm can be NULL.

ippStsSizeErr

Indicates an error when len is less than or equal to zero.

Example

/*******************************************************************************
* Copyright 2015 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 Performance 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()
{
    Ipp16s pValsIm[] = { 1, -3, 5, -7, 18, -24, 35, 48 };
    Ipp16s pValsRe[] = { 1, -3, 5, -7, 18, -24, 35, 48 };
    Ipp16sc pOutVals[8];
    IppStatus status;
    int i;

    printf("\nSource vector\n");
    printf("\nRe=");
    for (i = 0; i < 8; i++) printf("%d ", pValsRe[i]);
    printf("\nIm=");
    for (i = 0; i < 8; i++) printf("%d ", pValsRe[i]);

    check_sts(status = ippsRealToCplx_16s(pValsRe, pValsIm, pOutVals, 8));

    printf("\nResult values vector\n");
    for (i = 0; i < 8; i++) printf("%d, %d; ", pOutVals[i].re, pOutVals[i].im);

EXIT_MAIN
    printf("\nExit status %d (%s)\n", (int)status, ippGetStatusString(status));
    return (int)status;
}