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

Add

Adds the elements of two vectors.

Syntax

Case 1. Not-in-place operations on floating point data, and integer data without scaling.

IppStatus ippsAdd_16s(const Ipp16s* pSrc1, const Ipp16s* pSrc2, Ipp16s* pDst, int len);

IppStatus ippsAdd_32f(const Ipp32f* pSrc1, const Ipp32f* pSrc2, Ipp32f* pDst, int len);

IppStatus ippsAdd_64f(const Ipp64f* pSrc1, const Ipp64f* pSrc2, Ipp64f* pDst, int len);

IppStatus ippsAdd_32fc(const Ipp32fc* pSrc1, const Ipp32fc* pSrc2, Ipp32fc* pDst, int len);

IppStatus ippsAdd_64fc(const Ipp64fc* pSrc1, const Ipp64fc* pSrc2, Ipp64fc* pDst, int len);

IppStatus ippsAdd_8u16u(const Ipp8u* pSrc1, const Ipp8u* pSrc2, Ipp16u* pDst, int len);

IppStatus ippsAdd_16u(const Ipp16u* pSrc1, const Ipp16u* pSrc2, Ipp16u* pDst, int len);

IppStatus ippsAdd_32u(const Ipp32u* pSrc1, const Ipp32u* pSrc2, Ipp32u* pDst, int len);

IppStatus ippsAdd_16s32f(const Ipp16s* pSrc1, const Ipp16s* pSrc2, Ipp32f* pDst, int len);

Case 2. Not-in-place operations on integer data with scaling.

IppStatus ippsAdd_8u_Sfs(const Ipp8u* pSrc1, const Ipp8u* pSrc2, Ipp8u* pDst, int len, int scaleFactor);

IppStatus ippsAdd_16u_Sfs(const Ipp16u* pSrc1, const Ipp16u* pSrc2, Ipp16u* pDst, int len, int scaleFactor);

IppStatus ippsAdd_16s_Sfs(const Ipp16s* pSrc1, const Ipp16s* pSrc2, Ipp16s* pDst, int len, int scaleFactor);

IppStatus ippsAdd_32s_Sfs(const Ipp32s* pSrc1, const Ipp32s* pSrc2, Ipp32s* pDst, int len, int scaleFactor);

IppStatus ippsAdd_16sc_Sfs(const Ipp16sc* pSrc1, const Ipp16sc* pSrc2, Ipp16sc* pDst, int len, int scaleFactor);

IppStatus ippsAdd_32sc_Sfs(const Ipp32sc* pSrc1, const Ipp32sc* pSrc2, Ipp32sc* pDst, int len, int scaleFactor);

IppStatus ippsAdd_64s_Sfs(const Ipp64s* pSrc1, const Ipp64s* pSrc2, Ipp64s* pDst, int len, int scaleFactor);

Case 3. In-place operations on floating point data, and integer data without scaling.

IppStatus ippsAdd_16s_I(const Ipp16s* pSrc, Ipp16s* pSrcDst, int len);

IppStatus ippsAdd_32f_I(const Ipp32f* pSrc, Ipp32f* pSrcDst, int len);

IppStatus ippsAdd_64f_I(const Ipp64f* pSrc, Ipp64f* pSrcDst, int len);

IppStatus ippsAdd_32fc_I(const Ipp32fc* pSrc, Ipp32fc* pSrcDst, int len);

IppStatus ippsAdd_64fc_I(const Ipp64fc* pSrc, Ipp64fc* pSrcDst, int len);

IppStatus ippsAdd_16s32s_I(const Ipp16s* pSrc, Ipp32s* pSrcDst, int len);

IppStatus ippsAdd_32u_I(const Ipp32u* pSrc, Ipp32u* pSrcDst, int len);

Case 4. In-place operations on integer data with scaling.

IppStatus ippsAdd_8u_ISfs(const Ipp8u* pSrc, Ipp8u* pSrcDst, int len, int scaleFactor);

IppStatus ippsAdd_16u_ISfs(const Ipp16u* pSrc, Ipp16u* pSrcDst, int len, int scaleFactor);

IppStatus ippsAdd_16s_ISfs(const Ipp16s* pSrc, Ipp16s* pSrcDst, int len, int scaleFactor);

IppStatus ippsAdd_32s_ISfs(const Ipp32s* pSrc, Ipp32s* pSrcDst, int len, int scaleFactor);

IppStatus ippsAdd_16sc_ISfs(const Ipp16sc* pSrc, Ipp16sc* pSrcDst, int len, int scaleFactor);

IppStatus ippsAdd_32sc_ISfs(const Ipp32sc* pSrc, Ipp32sc* pSrcDst, int len, int scaleFactor);

Include Files

ipps.h

Domain Dependencies

Flavors declared in ipps.h:

Headers: ippcore.h, ippvm.h

Libraries: ippcore.lib, ippvm.lib

Flavors declared in ipps64x.h:

Libraries: ippcore.lib, ippvm.lib, ipps.lib, ippcore_tl.lib, ipps_tl.lib

Parameters

pSrc1, pSrc2

Pointers to the source vectors.

pDst

Pointer to the destination vector.

pSrc

Pointer to the source vector for in-place operations.

pSrcDst

Pointer to the source and destination vector for in-place operation.

len

Number of elements in the vector

scaleFactor

Scale factor, refer to Integer Scaling.

Description

This function adds the elements of the vector pSrc1 to the elements of the vector pSrc2, and stores the result in pDst.

The in-place flavors of ippsAdd add the elements of the vector pSrc to the elements of the vector pSrcDst and store the result in pSrcDst.

Functions with Sfs suffix perform scaling of the result value in accordance with the scaleFactor value. If the output value exceeds the data range, the result is saturated.

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

Add:

/*******************************************************************************
* 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()
{
    int len = 32;
    int i;
    Ipp64f *pDst = ippsMalloc_64f(len * sizeof(Ipp64f));
    Ipp64f *pSrc1 = ippsMalloc_64f(len * sizeof(Ipp64f));
    Ipp64f *pSrc2 = ippsMalloc_64f(len * sizeof(Ipp64f));
    IppStatus status;

    printf("\n\nSource vector 1\n");
    for (i = 0; i < len; i++)
    {
        pSrc1[i] = i;
        printf("%.0f; ", pSrc1[i]);
    }
    printf("\n\nSource vector 2\n");
    for (i = 0; i < len; i++)
    {
        pSrc2[i] = 10 + i;
        printf("%.0f; ", pSrc2[i]);
    }

    check_sts(status = ippsAdd_64f(pSrc2, pSrc1, pDst, len));

    printf("\n\nResult\n");
    for (i = 0; i < len; i++) printf("%.2f; ", pDst[i]);
    printf("\n\n");

EXIT_MAIN
    ippsFree(pSrc1);
    ippsFree(pSrc2);
    ippsFree(pDst);
    printf("Exit status %d (%s)\n", (int)status, ippGetStatusString(status));
    return (int)status;
}

Add_I:

/*******************************************************************************
* 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()
{
    int len = 32;
    int i;
    Ipp64f *pSrc1 = ippsMalloc_64f(len * sizeof(Ipp64f));
    Ipp64f *pSrcDst = ippsMalloc_64f(len * sizeof(Ipp64f));
    IppStatus status;

    printf("\n\nSource vector 1\n");
    for (i = 0; i < len; i++)
    {
        pSrcDst[i] = i;
        printf("%.0f; ", pSrcDst[i]);
    }
    printf("\n\nSource vector 2\n");
    for (i = 0; i < len; i++)
    {
        pSrc1[i] = 10 + i;
        printf("%.0f; ", pSrc1[i]);
    }

    check_sts(status = ippsAdd_64f_I(pSrc1, pSrcDst, len));

    printf("\n\nResult\n");
    for (i = 0; i < len; i++) printf("%.2f; ", pSrcDst[i]);
    printf("\n\n");

EXIT_MAIN
    ippsFree(pSrc1);
    ippsFree(pSrcDst);
    printf("Exit status %d (%s)\n", (int)status, ippGetStatusString(status));
    return (int)status;
}

See Also