mbed official / mbed-dsp

CMSIS DSP library

Dependents:   performance_timer Surfboard_ gps2rtty Capstone ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

cmsis_dsp/StatisticsFunctions/arm_std_q31.c@3:7a284390b0ce, 2013-11-08 (annotated)

Committer:
mbed_official
Date:
Fri Nov 08 13:45:10 2013 +0000
Revision:
3:7a284390b0ce
Parent:
2:da51fb522205
Child:
5:3762170b6d4d
Synchronized with git revision e69956aba2f68a2a26ac26b051f8d349deaa1ce8

Who changed what in which revision?

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