git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/DSP_Lib/Source/FilteringFunctions/arm_lms_norm_init_f32.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_lms_norm_init_f32.c
   9 *
  10 * Description:  Floating-point NLMS filter initialization function.
  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 groupFilters
  37  */
  38
  39 /**
  40  * @addtogroup LMS_NORM
  41  * @{
  42  */
  43
  44   /**
  45    * @brief Initialization function for floating-point normalized LMS filter.
  46    * @param[in] *S points to an instance of the floating-point LMS filter structure.
  47    * @param[in] numTaps  number of filter coefficients.
  48    * @param[in] *pCoeffs points to coefficient buffer.
  49    * @param[in] *pState points to state buffer.
  50    * @param[in] mu step size that controls filter coefficient updates.
  51    * @param[in] blockSize number of samples to process.
  52    * @return none.
  53    *
  54  * \par Description:
  55  * <code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order:
  56  * <pre>
  57  *    {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]}
  58  * </pre>
  59  * The initial filter coefficients serve as a starting point for the adaptive filter.
  60  * <code>pState</code> points to an array of length <code>numTaps+blockSize-1</code> samples,
  61  * where <code>blockSize</code> is the number of input samples processed by each call to <code>arm_lms_norm_f32()</code>.
  62  */
  63
  64 void arm_lms_norm_init_f32(
  65   arm_lms_norm_instance_f32 * S,
  66   uint16_t numTaps,
  67   float32_t * pCoeffs,
  68   float32_t * pState,
  69   float32_t mu,
  70   uint32_t blockSize)
  71 {
  72   /* Assign filter taps */
  73   S->numTaps = numTaps;
  74
  75   /* Assign coefficient pointer */
  76   S->pCoeffs = pCoeffs;
  77
  78   /* Clear state buffer and size is always blockSize + numTaps - 1 */
  79   memset(pState, 0, (numTaps + (blockSize - 1u)) * sizeof(float32_t));
  80
  81   /* Assign state pointer */
  82   S->pState = pState;
  83
  84   /* Assign Step size value */
  85   S->mu = mu;
  86
  87   /* Initialise Energy to zero */
  88   S->energy = 0.0f;
  89
  90   /* Initialise x0 to zero */
  91   S->x0 = 0.0f;
  92
  93 }
  94
  95 /**
  96  * @} end of LMS_NORM group
  97  */