tool/mbed/mbed-sdk/libraries/dsp/cmsis_dsp/BasicMathFunctions/arm_offset_q31.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_offset_q31.c
   9 *
  10 * Description:  Q31 vector offset.
  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 groupMath
  45  */
  46
  47 /**
  48  * @addtogroup offset
  49  * @{
  50  */
  51
  52 /**
  53  * @brief  Adds a constant offset to a Q31 vector.
  54  * @param[in]  *pSrc points to the input vector
  55  * @param[in]  offset is the offset to be added
  56  * @param[out]  *pDst points to the output vector
  57  * @param[in]  blockSize number of samples in the vector
  58  * @return none.
  59  *
  60  * <b>Scaling and Overflow Behavior:</b>
  61  * \par
  62  * The function uses saturating arithmetic.
  63  * Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] are saturated.
  64  */
  65
  66 void arm_offset_q31(
  67   q31_t * pSrc,
  68   q31_t offset,
  69   q31_t * pDst,
  70   uint32_t blockSize)
  71 {
  72   uint32_t blkCnt;                               /* loop counter */
  73
  74 #ifndef ARM_MATH_CM0_FAMILY
  75
  76 /* Run the below code for Cortex-M4 and Cortex-M3 */
  77   q31_t in1, in2, in3, in4;
  78
  79
  80   /*loop Unrolling */
  81   blkCnt = blockSize >> 2u;
  82
  83   /* First part of the processing with loop unrolling.  Compute 4 outputs at a time.
  84    ** a second loop below computes the remaining 1 to 3 samples. */
  85   while(blkCnt > 0u)
  86   {
  87     /* C = A + offset */
  88     /* Add offset and then store the results in the destination buffer. */
  89     in1 = *pSrc++;
  90     in2 = *pSrc++;
  91     in3 = *pSrc++;
  92     in4 = *pSrc++;
  93
  94     *pDst++ = __QADD(in1, offset);
  95     *pDst++ = __QADD(in2, offset);
  96     *pDst++ = __QADD(in3, offset);
  97     *pDst++ = __QADD(in4, offset);
  98
  99     /* Decrement the loop counter */
 100     blkCnt--;
 101   }
 102
 103   /* If the blockSize is not a multiple of 4, compute any remaining output samples here.
 104    ** No loop unrolling is used. */
 105   blkCnt = blockSize % 0x4u;
 106
 107   while(blkCnt > 0u)
 108   {
 109     /* C = A + offset */
 110     /* Add offset and then store the result in the destination buffer. */
 111     *pDst++ = __QADD(*pSrc++, offset);
 112
 113     /* Decrement the loop counter */
 114     blkCnt--;
 115   }
 116
 117 #else
 118
 119   /* Run the below code for Cortex-M0 */
 120
 121   /* Initialize blkCnt with number of samples */
 122   blkCnt = blockSize;
 123
 124   while(blkCnt > 0u)
 125   {
 126     /* C = A + offset */
 127     /* Add offset and then store the result in the destination buffer. */
 128     *pDst++ = (q31_t) clip_q63_to_q31((q63_t) * pSrc++ + offset);
 129
 130     /* Decrement the loop counter */
 131     blkCnt--;
 132   }
 133
 134 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
 135
 136 }
 137
 138 /**
 139  * @} end of offset group
 140  */