git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/DSP_Lib/Source/BasicMathFunctions/arm_dot_prod_q31.c

   1 /* ----------------------------------------------------------------------
   2 * Copyright (C) 2010 ARM Limited. All rights reserved.
   3 *
   4 * $Date:        15. July 2011
   5 * $Revision:    V1.0.10
   6 *
   7 * Project:          CMSIS DSP Library
   8 * Title:                arm_dot_prod_q31.c
   9 *
  10 * Description:  Q31 dot product.
  11 *
  12 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
  13 *
  14 * Version 1.0.10 2011/7/15
  15 *    Big Endian support added and Merged M0 and M3/M4 Source code.
  16 *
  17 * Version 1.0.3 2010/11/29
  18 *    Re-organized the CMSIS folders and updated documentation.
  19 *
  20 * Version 1.0.2 2010/11/11
  21 *    Documentation updated.
  22 *
  23 * Version 1.0.1 2010/10/05
  24 *    Production release and review comments incorporated.
  25 *
  26 * Version 1.0.0 2010/09/20
  27 *    Production release and review comments incorporated.
  28 *
  29 * Version 0.0.7  2010/06/10
  30 *    Misra-C changes done
  31 * -------------------------------------------------------------------- */
  32
  33 #include "arm_math.h"
  34
  35 /**
  36  * @ingroup groupMath
  37  */
  38
  39 /**
  40  * @addtogroup dot_prod
  41  * @{
  42  */
  43
  44 /**
  45  * @brief Dot product of Q31 vectors.
  46  * @param[in]       *pSrcA points to the first input vector
  47  * @param[in]       *pSrcB points to the second input vector
  48  * @param[in]       blockSize number of samples in each vector
  49  * @param[out]      *result output result returned here
  50  * @return none.
  51  *
  52  * <b>Scaling and Overflow Behavior:</b>
  53  * \par
  54  * The intermediate multiplications are in 1.31 x 1.31 = 2.62 format and these
  55  * are truncated to 2.48 format by discarding the lower 14 bits.
  56  * The 2.48 result is then added without saturation to a 64-bit accumulator in 16.48 format.
  57  * There are 15 guard bits in the accumulator and there is no risk of overflow as long as
  58  * the length of the vectors is less than 2^16 elements.
  59  * The return result is in 16.48 format.
  60  */
  61
  62 void arm_dot_prod_q31(
  63   q31_t * pSrcA,
  64   q31_t * pSrcB,
  65   uint32_t blockSize,
  66   q63_t * result)
  67 {
  68   q63_t sum = 0;                                 /* Temporary result storage */
  69   uint32_t blkCnt;                               /* loop counter */
  70
  71
  72 #ifndef ARM_MATH_CM0
  73
  74 /* Run the below code for Cortex-M4 and Cortex-M3 */
  75
  76   /*loop Unrolling */
  77   blkCnt = blockSize >> 2u;
  78
  79   /* First part of the processing with loop unrolling.  Compute 4 outputs at a time.
  80    ** a second loop below computes the remaining 1 to 3 samples. */
  81   while(blkCnt > 0u)
  82   {
  83     /* C = A[0]* B[0] + A[1]* B[1] + A[2]* B[2] + .....+ A[blockSize-1]* B[blockSize-1] */
  84     /* Calculate dot product and then store the result in a temporary buffer. */
  85     sum += ((q63_t) * pSrcA++ * *pSrcB++) >> 14u;
  86     sum += ((q63_t) * pSrcA++ * *pSrcB++) >> 14u;
  87     sum += ((q63_t) * pSrcA++ * *pSrcB++) >> 14u;
  88     sum += ((q63_t) * pSrcA++ * *pSrcB++) >> 14u;
  89
  90     /* Decrement the loop counter */
  91     blkCnt--;
  92   }
  93
  94   /* If the blockSize is not a multiple of 4, compute any remaining output samples here.
  95    ** No loop unrolling is used. */
  96   blkCnt = blockSize % 0x4u;
  97
  98 #else
  99
 100   /* Run the below code for Cortex-M0 */
 101
 102   /* Initialize blkCnt with number of samples */
 103   blkCnt = blockSize;
 104
 105 #endif /* #ifndef ARM_MATH_CM0 */
 106
 107
 108   while(blkCnt > 0u)
 109   {
 110     /* C = A[0]* B[0] + A[1]* B[1] + A[2]* B[2] + .....+ A[blockSize-1]* B[blockSize-1] */
 111     /* Calculate dot product and then store the result in a temporary buffer. */
 112     sum += ((q63_t) * pSrcA++ * *pSrcB++) >> 14u;
 113
 114     /* Decrement the loop counter */
 115     blkCnt--;
 116   }
 117
 118   /* Store the result in the destination buffer in 16.48 format */
 119   *result = sum;
 120 }
 121
 122 /**
 123  * @} end of dot_prod group
 124  */