tool/mbed/mbed-sdk/libraries/dsp/cmsis_dsp/StatisticsFunctions/arm_var_q15.c

   1 /* ----------------------------------------------------------------------
   2 * Copyright (C) 2010-2013 ARM Limited. All rights reserved.
   3 *
   4 * $Date:        17. January 2013
   5 * $Revision:    V1.4.1
   6 *
   7 * Project:          CMSIS DSP Library
   8 * Title:                arm_var_q15.c
   9 *
  10 * Description:  Variance of an array of Q15 type.
  11 *
  12 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
  13 *
  14 * Redistribution and use in source and binary forms, with or without
  15 * modification, are permitted provided that the following conditions
  16 * are met:
  17 *   - Redistributions of source code must retain the above copyright
  18 *     notice, this list of conditions and the following disclaimer.
  19 *   - Redistributions in binary form must reproduce the above copyright
  20 *     notice, this list of conditions and the following disclaimer in
  21 *     the documentation and/or other materials provided with the
  22 *     distribution.
  23 *   - Neither the name of ARM LIMITED nor the names of its contributors
  24 *     may be used to endorse or promote products derived from this
  25 *     software without specific prior written permission.
  26 *
  27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  34 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38 * POSSIBILITY OF SUCH DAMAGE.
  39 * -------------------------------------------------------------------- */
  40
  41 #include "arm_math.h"
  42
  43 /**
  44  * @ingroup groupStats
  45  */
  46
  47 /**
  48  * @addtogroup variance
  49  * @{
  50  */
  51
  52 /**
  53  * @brief Variance of the elements of a Q15 vector.
  54  * @param[in]       *pSrc points to the input vector
  55  * @param[in]       blockSize length of the input vector
  56  * @param[out]      *pResult variance value returned here
  57  * @return none.
  58  *
  59  * @details
  60  * <b>Scaling and Overflow Behavior:</b>
  61  *
  62  * \par
  63  * The function is implemented using a 64-bit internal accumulator.
  64  * The input is represented in 1.15 format.
  65  * Intermediate multiplication yields a 2.30 format, and this
  66  * result is added without saturation to a 64-bit accumulator in 34.30 format.
  67  * With 33 guard bits in the accumulator, there is no risk of overflow, and the
  68  * full precision of the intermediate multiplication is preserved.
  69  * Finally, the 34.30 result is truncated to 34.15 format by discarding the lower
  70  * 15 bits, and then saturated to yield a result in 1.15 format.
  71  *
  72  */
  73
  74
  75 void arm_var_q15(
  76   q15_t * pSrc,
  77   uint32_t blockSize,
  78   q31_t * pResult)
  79 {
  80   q31_t sum = 0;                                 /* Accumulator */
  81   q31_t meanOfSquares, squareOfMean;             /* Mean of square and square of mean */
  82   q15_t mean;                                    /* mean */
  83   uint32_t blkCnt;                               /* loop counter */
  84   q15_t t;                                       /* Temporary variable */
  85   q63_t sumOfSquares = 0;                        /* Accumulator */
  86
  87 #ifndef ARM_MATH_CM0_FAMILY
  88
  89   /* Run the below code for Cortex-M4 and Cortex-M3 */
  90
  91   q31_t in;                                      /* Input variable */
  92   q15_t in1;                                     /* Temporary variable */
  93
  94   /*loop Unrolling */
  95   blkCnt = blockSize >> 2u;
  96
  97   /* First part of the processing with loop unrolling.  Compute 4 outputs at a time.
  98    ** a second loop below computes the remaining 1 to 3 samples. */
  99   while(blkCnt > 0u)
 100   {
 101     /* C = (A[0] * A[0] + A[1] * A[1] + ... + A[blockSize-1] * A[blockSize-1])  */
 102     /* Compute Sum of squares of the input samples
 103      * and then store the result in a temporary variable, sum. */
 104     in = *__SIMD32(pSrc)++;
 105     sum += ((in << 16) >> 16);
 106     sum += (in >> 16);
 107     sumOfSquares = __SMLALD(in, in, sumOfSquares);
 108     in = *__SIMD32(pSrc)++;
 109     sum += ((in << 16) >> 16);
 110     sum += (in >> 16);
 111     sumOfSquares = __SMLALD(in, in, sumOfSquares);
 112
 113     /* Decrement the loop counter */
 114     blkCnt--;
 115   }
 116
 117   /* If the blockSize is not a multiple of 4, compute any remaining output samples here.
 118    ** No loop unrolling is used. */
 119   blkCnt = blockSize % 0x4u;
 120
 121   while(blkCnt > 0u)
 122   {
 123     /* C = (A[0] * A[0] + A[1] * A[1] + ... + A[blockSize-1] * A[blockSize-1]) */
 124     /* Compute Sum of squares of the input samples
 125      * and then store the result in a temporary variable, sum. */
 126     in1 = *pSrc++;
 127     sum += in1;
 128     sumOfSquares = __SMLALD(in1, in1, sumOfSquares);
 129
 130     /* Decrement the loop counter */
 131     blkCnt--;
 132   }
 133
 134   /* Compute Mean of squares of the input samples
 135    * and then store the result in a temporary variable, meanOfSquares. */
 136   t = (q15_t) ((1.0f / (float32_t) (blockSize - 1u)) * 16384);
 137   sumOfSquares = __SSAT((sumOfSquares >> 15u), 16u);
 138
 139   meanOfSquares = (q31_t) ((sumOfSquares * t) >> 14u);
 140
 141 #else
 142
 143   /* Run the below code for Cortex-M0 */
 144
 145   q15_t in;                                      /* Temporary variable */
 146   /* Loop over blockSize number of values */
 147   blkCnt = blockSize;
 148
 149   while(blkCnt > 0u)
 150   {
 151     /* C = (A[0] * A[0] + A[1] * A[1] + ... + A[blockSize-1] * A[blockSize-1]) */
 152     /* Compute Sum of squares of the input samples
 153      * and then store the result in a temporary variable, sumOfSquares. */
 154     in = *pSrc++;
 155     sumOfSquares += (in * in);
 156
 157     /* C = (A[0] + A[1] + A[2] + ... + A[blockSize-1]) */
 158     /* Compute sum of all input values and then store the result in a temporary variable, sum. */
 159     sum += in;
 160
 161     /* Decrement the loop counter */
 162     blkCnt--;
 163   }
 164
 165   /* Compute Mean of squares of the input samples
 166    * and then store the result in a temporary variable, meanOfSquares. */
 167   t = (q15_t) ((1.0f / (float32_t) (blockSize - 1u)) * 16384);
 168   sumOfSquares = __SSAT((sumOfSquares >> 15u), 16u);
 169   meanOfSquares = (q31_t) ((sumOfSquares * t) >> 14u);
 170
 171 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
 172
 173   /* Compute mean of all input values */
 174   t = (q15_t) ((1.0f / (float32_t) (blockSize * (blockSize - 1u))) * 32768);
 175   mean = __SSAT(sum, 16u);
 176
 177   /* Compute square of mean */
 178   squareOfMean = ((q31_t) mean * mean) >> 15;
 179   squareOfMean = (q31_t) (((q63_t) squareOfMean * t) >> 15);
 180
 181   /* Compute variance and then store the result to the destination */
 182   *pResult = (meanOfSquares - squareOfMean);
 183
 184 }
 185
 186 /**
 187  * @} end of variance group
 188  */