Developer Reference

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

Sub

Subtracts the elements of two vectors.

Syntax

Case 1. Not-in-place operations on floating point data, and integer data without scaling.
IppStatus ippsSub_16s(const Ipp16s*
pSrc1
, const Ipp16s*
pSrc2
, Ipp16s*
pDst
, int
len
);
IppStatus ippsSub_32f(const Ipp32f*
pSrc1
, const Ipp32f*
pSrc2
, Ipp32f*
pDst
, int
len
);
IppStatus ippsSub_64f(const Ipp64f*
pSrc1
, const Ipp64f*
pSrc2
, Ipp64f*
pDst
, int
len
);
IppStatus ippsSub_32fc(const Ipp32fc*
pSrc1
, const Ipp32fc*
pSrc2
, Ipp32fc*
pDst
, int
len
);
IppStatus ippsSub_64fc(const Ipp64fc*
pSrc1
, const Ipp64fc*
pSrc2
, Ipp64fc*
pDst
, int
len
);
IppStatus ippsSub_16s32f(const Ipp16s*
pSrc1
, const Ipp16s*
pSrc2
, Ipp32f*
pDst
, int
len
);
Case 2. Not-in-place operations on integer data with scaling.
IppStatus ippsSub_8u_Sfs(const Ipp8u*
pSrc1
, const Ipp8u*
pSrc2
, Ipp8u*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_16u_Sfs(const Ipp16u*
pSrc1
, const Ipp16u*
pSrc2
, Ipp16u*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_16s_Sfs(const Ipp16s*
pSrc1
, const Ipp16s*
pSrc2
, Ipp16s*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_32s_Sfs(const Ipp32s*
pSrc1
, const Ipp32s*
pSrc2
, Ipp32s*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_16sc_Sfs(const Ipp16sc*
pSrc1
, const Ipp16sc*
pSrc2
, Ipp16sc*
pDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_32sc_Sfs(const Ipp32sc*
pSrc1
, const Ipp32sc*
pSrc2
, Ipp32sc*
pDst
, int
len
, int
scaleFactor
);
Case 3. In-place operations on floating point data and integer data without scaling.
IppStatus ippsSub_16s_I(const Ipp16s*
pSrc
, Ipp16s*
pSrcDst
, int
len
);
IppStatus ippsSub_32f_I(const Ipp32f*
pSrc
, Ipp32f*
pSrcDst
, int
len
);
IppStatus ippsSub_64f_I(const Ipp64f*
pSrc
, Ipp64f*
pSrcDst
, int
len
);
IppStatus ippsSub_32fc_I(const Ipp32fc*
pSrc
, Ipp32fc*
pSrcDst
, int
len
);
IppStatus ippsSub_64fc_I(const Ipp64fc*
pSrc
, Ipp64fc*
pSrcDst
, int
len
);
Case 4. In-place operations on integer data with scaling.
IppStatus ippsSub_8u_ISfs(const Ipp8u*
pSrc
, Ipp8u*
pSrcDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_16u_ISfs(const Ipp16u*
pSrc
, Ipp16u*
pSrcDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_16s_ISfs(const Ipp16s*
pSrc
, Ipp16s*
pSrcDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_32s_ISfs(const Ipp32s*
pSrc
, Ipp32s*
pSrcDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_16sc_ISfs(const Ipp16sc*
pSrc
, Ipp16sc*
pSrcDst
, int
len
, int
scaleFactor
);
IppStatus ippsSub_32sc_ISfs(const Ipp32sc*
pSrc
, Ipp32sc*
pSrcDst
, int
len
, int
scaleFactor
);
Include Files
ipps.h
Domain Dependencies
Headers:
ippcore.h
,
ippvm.h
Libraries:
ippcore.lib
,
ippvm.lib
Parameters
pSrc1
Pointer to the source vector-subtrahend, whose elements are to be subtracted.
pSrc2
Pointer to the source vector-minuend from whose elements the elements of
pSrc1
are to be subtracted.
pDst
Pointer to the destination vector.
pSrc
Pointer to the source vector-subtrahend for in-place operation.
pSrcDst
Pointer to the source vector-minuend and destination vector for in-place operation.
len
Number of elements in the vector.
scaleFactor
Scale factor, refer to Integer Scaling .
Description
This function subtracts the elements of the vector
pSrc1
from the elements of the vector
pSrc2
, and stores the result in
pDst
.
The in-place flavors of
ippsSub
subtract the elements of the vector
pSrc
from the elements of a vector
pSrcDst
and store the result in
pSrcDst
.
Functions with
Sfs
suffixes perform scaling of the result value in accordance with the
scaleFactor
value. If the output value exceeds the data range, the result becomes 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.

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