Developer Reference for Intel® Integrated Performance Primitives 2018

Sqr

Computes a square of each element of a vector.

Syntax

IppStatus ippsSqr_32f(const Ipp32f* pSrc, Ipp32f* pDst, int len);

IppStatus ippsSqr_64f(const Ipp64f* pSrc, Ipp64f* pDst, int len);

IppStatus ippsSqr_32fc(const Ipp32fc* pSrc, Ipp32fc* pDst, int len);

IppStatus ippsSqr_64fc(const Ipp64fc* pSrc, Ipp64fc* pDst, int len);

IppStatus ippsSqr_8u_Sfs(const Ipp8u* pSrc, Ipp8u* pDst, int len, int scaleFactor);

IppStatus ippsSqr_16s_Sfs(const Ipp16s* pSrc, Ipp16s* pDst, int len, int scaleFactor);

IppStatus ippsSqr_16u_Sfs(const Ipp16u* pSrc, Ipp16u* pDst, int len, int scaleFactor);

IppStatus ippsSqr_16sc_Sfs(const Ipp16sc* pSrc, Ipp16sc* pDst, int len, int scaleFactor);

IppStatus ippsSqr_32f_I(Ipp32f* pSrcDst, int len);

IppStatus ippsSqr_64f_I(Ipp64f* pSrcDst, int len);

IppStatus ippsSqr_32fc_I(Ipp32fc* pSrcDst, int len);

IppStatus ippsSqr_64fc_I(Ipp64fc* pSrcDst, int len);

IppStatus ippsSqr_8u_ISfs(Ipp8u* pSrcDst, int len, int scaleFactor);

IppStatus ippsSqr_16s_ISfs(Ipp16s* pSrcDst, int len, int scaleFactor);

IppStatus ippsSqr_16u_ISfs(Ipp16u* pSrcDst, int len, int scaleFactor);

IppStatus ippsSqr_16sc_ISfs(Ipp16sc* pSrcDst, 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.

pDst

Pointer to the destination vector.

pSrcDst

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

len

Number of elements in the vector

scaleFactor

Scale factor, refer to Integer Scaling.

Description

This function computes the square of each element of the vector pSrc, and stores the result in pDst. The computation is performed as follows:

pDst[n] = pSrc[ n]2

The in-place flavors of ippsSqrcompute the square of each element of the vector pSrcDst and store the result in pSrcDst. The computation is performed as follows:

pSrcDst[n] = pSrcDst[ n]2

When computing the square of an integer number, the output result can exceed the data range and become saturated. To get a precise result, use the scale factor.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error when the pSrc, pDst, or pSrcDst pointer is NULL.

ippStsSizeErr

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

Example

Sqr.c

Sqr_I.c