Unverified Commit 60e1e88f authored by KoenVda88's avatar KoenVda88 Committed by GitHub
Browse files

doc(args): make sure function declarations have the same arguments names (#67)



Co-authored-by: default avatarKoen <koen@gsf.engineering>
parent 8d5aae1e
Loading
Loading
Loading
Loading
+10 −10
Original line number Diff line number Diff line
@@ -403,38 +403,38 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA,
   * @brief  Minimum value of a Q7 vector.
   * @param[in]  pSrc       is input pointer
   * @param[in]  blockSize  is the number of samples to process
   * @param[out] result     is output pointer
   * @param[in]  index      is the array index of the minimum value in the input buffer.
   * @param[out] pResult     is output pointer
   * @param[in]  pIndex      is the array index of the minimum value in the input buffer.
   */
  void arm_min_q7(
  const q7_t * pSrc,
        uint32_t blockSize,
        q7_t * result,
        uint32_t * index);
        q7_t * pResult,
        uint32_t * pIndex);

  /**
   * @brief  Minimum value of absolute values of a Q7 vector.
   * @param[in]  pSrc       is input pointer
   * @param[in]  blockSize  is the number of samples to process
   * @param[out] result     is output pointer
   * @param[in]  index      is the array index of the minimum value in the input buffer.
   * @param[out] pResult    is output pointer
   * @param[in]  pIndex     is the array index of the minimum value in the input buffer.
   */
  void arm_absmin_q7(
  const q7_t * pSrc,
        uint32_t blockSize,
        q7_t * result,
        uint32_t * index);
        q7_t * pResult,
        uint32_t * pIndex);

    /**
   * @brief  Minimum value of absolute values of a Q7 vector.
   * @param[in]  pSrc       is input pointer
   * @param[in]  blockSize  is the number of samples to process
   * @param[out] result     is output pointer
   * @param[out] pResult    is output pointer
   */
  void arm_absmin_no_idx_q7(
  const q7_t * pSrc,
        uint32_t blockSize,
        q7_t * result);
        q7_t * pResult);


  /**
+7 −7
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@
  @param[in]     pSrcA       points to the first input vector
  @param[in]     pSrcB       points to the second input vector
  @param[in]     blockSize   number of samples in input vector
  @param[out]    result      mean square error
  @param[out]    pResult      mean square error
  @return        none
 */

@@ -55,7 +55,7 @@ void arm_mse_f32(
    const float32_t * pSrcA,
    const float32_t * pSrcB,
    uint32_t    blockSize,
    float32_t * result)
    float32_t * pResult)

{
    float32x4_t vecA, vecB;
@@ -98,7 +98,7 @@ void arm_mse_f32(
    sum = vecAddAcrossF32Mve(vecSum);

    /* Store result in destination buffer */
    *result = sum / blockSize;
    *pResult = sum / blockSize;

}

@@ -109,7 +109,7 @@ void arm_mse_f32(
    const float32_t * pSrcA,
    const float32_t * pSrcB,
    uint32_t    blockSize,
    float32_t * result)
    float32_t * pResult)

{
    float32x4_t vecA, vecB;
@@ -163,7 +163,7 @@ void arm_mse_f32(
    }
    
    /* Store result in destination buffer */
    *result = sum / blockSize;
    *pResult = sum / blockSize;

}
#endif
@@ -179,7 +179,7 @@ void arm_mse_f32(
    const float32_t * pSrcA,
    const float32_t * pSrcB,
    uint32_t    blockSize,
    float32_t * result)
    float32_t * pResult)

{
  uint32_t blkCnt;                               /* Loop counter */
@@ -237,7 +237,7 @@ void arm_mse_f32(
  }

  /* Store result in destination buffer */
  *result = sum / blockSize;
  *pResult = sum / blockSize;
}

#endif /* end of test for vector instruction availability */
+3 −3
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@
  @param[in]     pSrcA       points to the first input vector
  @param[in]     pSrcB       points to the second input vector
  @param[in]     blockSize   number of samples in input vector
  @param[out]    result      mean square error
  @param[out]    pResult      mean square error
  @return        none
 */

@@ -50,7 +50,7 @@ void arm_mse_f64(
    const float64_t * pSrcA,
    const float64_t * pSrcB,
    uint32_t blockSize,
    float64_t * result)
    float64_t * pResult)

{
    
@@ -126,7 +126,7 @@ void arm_mse_f64(
    }
    
    /* Store result in destination buffer */
    *result = sum / blockSize;
    *pResult = sum / blockSize;
}