arm_dot_prod_q31.c 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. /* ----------------------------------------------------------------------
  2. * Project: CMSIS DSP Library
  3. * Title: arm_dot_prod_q31.c
  4. * Description: Q31 dot product
  5. *
  6. * $Date: 18. March 2019
  7. * $Revision: V1.6.0
  8. *
  9. * Target Processor: Cortex-M cores
  10. * -------------------------------------------------------------------- */
  11. /*
  12. * Copyright (C) 2010-2019 ARM Limited or its affiliates. All rights reserved.
  13. *
  14. * SPDX-License-Identifier: Apache-2.0
  15. *
  16. * Licensed under the Apache License, Version 2.0 (the License); you may
  17. * not use this file except in compliance with the License.
  18. * You may obtain a copy of the License at
  19. *
  20. * www.apache.org/licenses/LICENSE-2.0
  21. *
  22. * Unless required by applicable law or agreed to in writing, software
  23. * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  24. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  25. * See the License for the specific language governing permissions and
  26. * limitations under the License.
  27. */
  28. #include "arm_math.h"
  29. /**
  30. @ingroup groupMath
  31. */
  32. /**
  33. @addtogroup BasicDotProd
  34. @{
  35. */
  36. /**
  37. @brief Dot product of Q31 vectors.
  38. @param[in] pSrcA points to the first input vector.
  39. @param[in] pSrcB points to the second input vector.
  40. @param[in] blockSize number of samples in each vector.
  41. @param[out] result output result returned here.
  42. @return none
  43. @par Scaling and Overflow Behavior
  44. The intermediate multiplications are in 1.31 x 1.31 = 2.62 format and these
  45. are truncated to 2.48 format by discarding the lower 14 bits.
  46. The 2.48 result is then added without saturation to a 64-bit accumulator in 16.48 format.
  47. There are 15 guard bits in the accumulator and there is no risk of overflow as long as
  48. the length of the vectors is less than 2^16 elements.
  49. The return result is in 16.48 format.
  50. */
  51. void arm_dot_prod_q31(
  52. const q31_t * pSrcA,
  53. const q31_t * pSrcB,
  54. uint32_t blockSize,
  55. q63_t * result)
  56. {
  57. uint32_t blkCnt; /* Loop counter */
  58. q63_t sum = 0; /* Temporary return variable */
  59. #if defined (ARM_MATH_LOOPUNROLL)
  60. /* Loop unrolling: Compute 4 outputs at a time */
  61. blkCnt = blockSize >> 2U;
  62. while (blkCnt > 0U)
  63. {
  64. /* C = A[0]* B[0] + A[1]* B[1] + A[2]* B[2] + .....+ A[blockSize-1]* B[blockSize-1] */
  65. /* Calculate dot product and store result in a temporary buffer. */
  66. sum += ((q63_t) *pSrcA++ * *pSrcB++) >> 14U;
  67. sum += ((q63_t) *pSrcA++ * *pSrcB++) >> 14U;
  68. sum += ((q63_t) *pSrcA++ * *pSrcB++) >> 14U;
  69. sum += ((q63_t) *pSrcA++ * *pSrcB++) >> 14U;
  70. /* Decrement loop counter */
  71. blkCnt--;
  72. }
  73. /* Loop unrolling: Compute remaining outputs */
  74. blkCnt = blockSize % 0x4U;
  75. #else
  76. /* Initialize blkCnt with number of samples */
  77. blkCnt = blockSize;
  78. #endif /* #if defined (ARM_MATH_LOOPUNROLL) */
  79. while (blkCnt > 0U)
  80. {
  81. /* C = A[0]* B[0] + A[1]* B[1] + A[2]* B[2] + .....+ A[blockSize-1]* B[blockSize-1] */
  82. /* Calculate dot product and store result in a temporary buffer. */
  83. sum += ((q63_t) *pSrcA++ * *pSrcB++) >> 14U;
  84. /* Decrement loop counter */
  85. blkCnt--;
  86. }
  87. /* Store result in destination buffer in 16.48 format */
  88. *result = sum;
  89. }
  90. /**
  91. @} end of BasicDotProd group
  92. */