From 34270920e86f7c989f2cfc1aa7f44167ecda1f31 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Rolland Date: Thu, 15 Sep 2022 09:42:57 +0200 Subject: [PATCH] Revert doxyen documentation (2) --- Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c index ce00cdc8..b73f1bc8 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c @@ -34,15 +34,18 @@ /** @defgroup BiquadCascadeDF2T Biquad Cascade IIR Filters Using a Direct Form II Transposed Structure + This set of functions implements arbitrary order recursive (IIR) filters using a transposed direct form II structure. The filters are implemented as a cascade of second order Biquad sections. These functions provide a slight memory savings as compared to the direct form I Biquad filter functions. Only floating-point data is supported. + This function operate on blocks of input and output data and each call to the function processes blockSize samples through the filter. pSrc points to the array of input data and pDst points to the array of output data. Both arrays contain blockSize values. + @par Algorithm Each Biquad stage implements a second order filter using the difference equation:
@@ -88,10 +91,12 @@
                    The transposed Direct Form II structure, on the other hand, requires a wide dynamic range for the state variables d1 and d2.
                    Because of this, the CMSIS library only has a floating-point version of the Direct Form II Biquad.
                    The advantage of the Direct Form II Biquad is that it requires half the number of state variables, 2 rather than 4, per Biquad stage.
+
   @par           Instance Structure
                    The coefficients and state variables for a filter are stored together in an instance data structure.
                    A separate instance structure must be defined for each filter.
                    Coefficient arrays may be shared among several instances while state variable arrays cannot be shared.
+
   @par           Init Functions
                    There is also an associated initialization function.
                    The initialization function performs following operations:
@@ -127,6 +132,8 @@
   @param[in]     blockSize number of samples to process
   @return        none
  */
+
+
 #if defined(ARM_MATH_NEON)
 void arm_biquad_cascade_df2T_f64(
     const arm_biquad_cascade_df2T_instance_f64 * S,