Intel® Integrated Performance Primitives Developer Reference

Developer Reference

  • 2021
  • 01/25/2021
  • Public Content
Contents

CrossCorrNormGetBufferSize

Computes the size of the work buffer for the
ippsCrossCorrNorm
 function.

Syntax

IppStatus ippsCrossCorrNormGetBufferSize (int
src1Len
, int
src2Len
, int
dstLen
, int
lowLag
, IppDataType
dataType
, IppEnum
algType
, int*
pBufferSize
);
Include Files
ipps.h
Parameters
src1Len
Number of elements in the first source vector.
src2Len
Number of elements in the second source vector.
dstLen
Number of elements in the destination vector (length of cross-correlation).
lowLag
Lower value of the range of lags at which the correlation is computed.
dataType
Data type for cross-correlation. Possible values are
ipp32f
,
ipp32fc
,
ipp64f
, or
ipp64fc
.
algType
Bit-field mask for the algorithm type definition. Possible values are the results of composition of the
IppAlgType
 and
IppsNormOp
 values.
pBufferSize
Pointer to the size of the work buffer.
Description
The
ippsCrossCorrNormGetBufferSize
 function computes the size in bytes of the external work buffer needed for the function that performs cross-correlation. The result is stored in the
pBufferSize
 parameter.
Return Values
ippStsNoErr
Indicates no error.
ippStsNullPtrErr
Indicates an error when
pBufferSize
 is
NULL
.
ippStsSizeErr
Indicates an error when the length of the vector is negative, or equal to zero.
ippStsAlgTypeErr
Indicates an error when:
  • the result of the bitwise AND operation between the
    algType
     and
    ippAlgMask
     values differs from the
    ippAlgAuto
    ,
    ippAlgDirect
    , or
    ippAlgFFT
     values.
  • the result of the bitwise AND operation between the
    algType
     and
    ippsNormMask
     values differs from the
    ippsNormNone
    ,
    ippsNormA
    , or
    ippsNormB
     values.
ippStsDataTypeErr
Indicates an error when the
dataType
 value differs from the
Ipp32f
,
Ipp32fc
,
Ipp64f
, or
Ipp64fc
.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.