This chapter provides an overview of the information contained in the functional descriptions.
Framewave functional descriptions include the following types of information.
Signal processing library function definitions use the following parameters.
| dstLen | Specifies the number of elements in destination buffer(this will be the length of auto-correlation) | |
| hint | Hints whether to choose a fast or accurate computation algorithm. | |
| len | Specifies the number of elements in a buffer. | |
| lenFind | Length of the substring. | |
| level | Specifies a threshold level. | |
| levelGT | Specifies a threshold level for greater-than comparison. | |
| levelLT | Specifies a threshold level for less-than comparison. | |
| pDp | Pointer to the destination buffer that contains the dot product of the source buffers. | |
| pDst | Pointer to a destination buffer. | |
| pDst1 | Pointer to destination buffer one. | |
| pDst2 | Pointer to destination buffer two. | |
| pFind | Pointer to the substring. | |
| pIndex | Pointer to the index of the result. | |
| pIndx | Pointer to the destination buffer that contains the index of the maximum or minimum value in the source buffer. | |
| pMax | Pointer to the destination buffer that contains the maximum value in the source buffer. | |
| pMaxAbs | Pointer to the destination buffer that contains the maximum absolute value in the source buffer. | |
| pMaxIndx | Pointer to the destination buffer that contains the index of the maximum value in the source vector. | |
| pMean | Pointer to the destination buffer that contains the mean of the values in the source buffer. | |
| pMin | Pointer to the destination buffer that contains the minimum value in the source buffer. | |
| pMinAbs | Pointer to the destination buffer that contains the minimum absolute value in the source buffer. | |
| pMinIndx | Pointer to the destination buffer that contains the index of the minimum value in the source buffer. | |
| pNorm | Pointer to the destination buffer that contains the NormC, NormL1, or NormL2 of the values in the source buffer, depending on the function call. | |
| pSrc | Pointer to a source buffer. | |
| pSrc1 | Pointer to source buffer one. | |
| pSrc2 | Pointer to source buffer two. | |
| pSrcDst | Pointer to a buffer that is both the source and destination. | |
| pSrcIm | Pointer to a source buffer that contains the imaginary component values of an input signal. | |
| pSrcRe | Pointer to a source buffer that contains the real component values of an input signal. | |
| pStdDev | Pointer to the destination buffer that contains the standard deviation of the values in the source buffer. | |
| pSum | Pointer to the destination buffer that contains the sum of all the elements in the source buffer. | |
| ptr | Pointer to a valid memory. | |
| relOp | Constant that indicates which relational operation to perform. | |
| rndMode | Constant that indicates which rounding mode to use when converting from a scalar to an integer. | |
| scaleFactor | Specifies an integer scaling factor for the Sfs operation. The returned result is multiplied by 2^(-scaleFactor). | |
| srcLen | Specifies the number of elements in source buffer | |
| val | Specified value. | |
| valFind | Value of the element to be found. | |
| value | Specified value. | |
| valueGT | Specifies a value to set when a greater-than comparison evaluates as true. | |
| valueLT | Specifies a value to set when a less-than comparison evaluates as true. | |
| vdiv | Specifies the denominator. | |
| vsub | Specifies the subtrahend. |