Mul_NR

Multiplies the elements of two vectors.

Syntax

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

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

Parameters

pSrc1, pSrc2	Pointers to the source vectors to be multiplied.
pDst	Pointer to the destination vector.
pSrc	Pointer to the vector to be multiplied by the elements of pSrcDst (for in-place operation).
pSrcDst	Pointer to the source and destination vector (for in-place operation).
len	Number of elements in each vector.
scaleFactor	Scale factor for output data scaling.

Description

The function ippsMul_NR is declared in the ippsc.h file. This function multiplies the first source vector pSrc1 by the second source vector pSrc2 element-wise, and stores results in pDst.

The in-place function flavor multiplies the vector pSrc by the vector pSrcDst element-wise, and stores results in pSrcDst.

Both function flavors scale the multiplication results in accordance with the scaleFactor value (see Integer Scaling). If output values exceed the data range, the results are saturated.

Functions ippsMul_NR perform “nearest right” rounding needed to meet the bit-to-bit exactness requirement.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when the pSrc1, pSrc2, pSrc, pSrcDst, or pDst pointer is NULL.
ippStsSizeErr	Indicates an error when len is less than or equal to 0.
ippStsScaleRangeErr	Indicates an error when scaleFactor is less than 0.