diff --git a/Source/FilteringFunctions/arm_conv_q31.c b/Source/FilteringFunctions/arm_conv_q31.c
index adefa2ae6..1cf004d4f 100644
--- a/Source/FilteringFunctions/arm_conv_q31.c
+++ b/Source/FilteringFunctions/arm_conv_q31.c
@@ -56,7 +56,8 @@
The input signals should be scaled down to avoid intermediate overflows.
Scale down the inputs by log2(min(srcALen, srcBLen)) (log2 is read as log to the base 2) times to avoid overflows,
as maximum of min(srcALen, srcBLen) number of additions are carried internally.
- The 2.62 accumulator is right shifted by 31 bits and saturated to 1.31 format to yield the final result.
+ The scalar implementation right shifts the 2.62 accumulator by 31 bits to yield the final 1.31 result.
+ This conversion does not saturate.
@remark
Refer to \ref arm_conv_fast_q31() for a faster but less precise implementation of this function.
diff --git a/Source/FilteringFunctions/arm_correlate_q31.c b/Source/FilteringFunctions/arm_correlate_q31.c
index 46270e23d..b06af5223 100644
--- a/Source/FilteringFunctions/arm_correlate_q31.c
+++ b/Source/FilteringFunctions/arm_correlate_q31.c
@@ -56,7 +56,8 @@
The input signals should be scaled down to avoid intermediate overflows.
Scale down one of the inputs by 1/min(srcALen, srcBLen)to avoid overflows since a
maximum of min(srcALen, srcBLen) number of additions is carried internally.
- The 2.62 accumulator is right shifted by 31 bits and saturated to 1.31 format to yield the final result.
+ The scalar implementation right shifts the 2.62 accumulator by 31 bits to yield the final 1.31 result.
+ This conversion does not saturate.
@remark
Refer to \ref arm_correlate_fast_q31() for a faster but less precise implementation of this function.
diff --git a/Source/FilteringFunctions/arm_fir_decimate_q31.c b/Source/FilteringFunctions/arm_fir_decimate_q31.c
index 751fa12ce..50fc760f6 100644
--- a/Source/FilteringFunctions/arm_fir_decimate_q31.c
+++ b/Source/FilteringFunctions/arm_fir_decimate_q31.c
@@ -52,7 +52,8 @@
The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit.
Thus, if the accumulator result overflows it wraps around rather than clip.
In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits (where log2 is read as log to the base 2).
- After all multiply-accumulates are performed, the 2.62 accumulator is truncated to 1.32 format and then saturated to 1.31 format.
+ The scalar implementation right shifts the 2.62 accumulator by 31 bits to yield the final 1.31 result.
+ This conversion does not saturate.
@remark
Refer to \ref arm_fir_decimate_fast_q31() for a faster but less precise implementation of this function.
diff --git a/Source/FilteringFunctions/arm_fir_interpolate_q31.c b/Source/FilteringFunctions/arm_fir_interpolate_q31.c
index 259a2ff4d..57fe72625 100644
--- a/Source/FilteringFunctions/arm_fir_interpolate_q31.c
+++ b/Source/FilteringFunctions/arm_fir_interpolate_q31.c
@@ -53,7 +53,8 @@
Thus, if the accumulator result overflows it wraps around rather than clip.
In order to avoid overflows completely the input signal must be scaled down by 1/(numTaps/L).
since numTaps/L additions occur per output sample.
- After all multiply-accumulates are performed, the 2.62 accumulator is truncated to 1.32 format and then saturated to 1.31 format.
+ The scalar implementation right shifts the 2.62 accumulator by 31 bits to yield the final 1.31 result.
+ This conversion does not saturate.
*/
#if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE)
diff --git a/Source/FilteringFunctions/arm_fir_q31.c b/Source/FilteringFunctions/arm_fir_q31.c
index 421fbdab3..ceba8e748 100644
--- a/Source/FilteringFunctions/arm_fir_q31.c
+++ b/Source/FilteringFunctions/arm_fir_q31.c
@@ -53,7 +53,8 @@
The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit.
Thus, if the accumulator result overflows it wraps around rather than clip.
In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits.
- After all multiply-accumulates are performed, the 2.62 accumulator is right shifted by 31 bits and saturated to 1.31 format to yield the final result.
+ The scalar implementation right shifts the 2.62 accumulator by 31 bits to yield the final 1.31 result.
+ This conversion does not saturate.
@remark
Refer to \ref arm_fir_fast_q31() for a faster but less precise implementation of this filter.
diff --git a/Source/FilteringFunctions/arm_lms_norm_q31.c b/Source/FilteringFunctions/arm_lms_norm_q31.c
index db94dd193..e3613f58e 100644
--- a/Source/FilteringFunctions/arm_lms_norm_q31.c
+++ b/Source/FilteringFunctions/arm_lms_norm_q31.c
@@ -56,8 +56,8 @@
Thus, if the accumulator result overflows it wraps around rather than clip.
In order to avoid overflows completely the input signal must be scaled down by
log2(numTaps) bits. The reference signal should not be scaled down.
- After all multiply-accumulates are performed, the 2.62 accumulator is shifted
- and saturated to 1.31 format to yield the final result.
+ The scalar implementation shifts the 2.62 accumulator according to postShift
+ to yield the final 1.31 result. This conversion does not saturate.
The output signal and error signal are in 1.31 format.
@par
In this filter, filter coefficients are updated for each sample and the
diff --git a/Source/FilteringFunctions/arm_lms_q31.c b/Source/FilteringFunctions/arm_lms_q31.c
index 0fae211dc..e64ed5816 100644
--- a/Source/FilteringFunctions/arm_lms_q31.c
+++ b/Source/FilteringFunctions/arm_lms_q31.c
@@ -57,8 +57,8 @@
In order to avoid overflows completely the input signal must be scaled down by
log2(numTaps) bits.
The reference signal should not be scaled down.
- After all multiply-accumulates are performed, the 2.62 accumulator is shifted
- and saturated to 1.31 format to yield the final result.
+ The scalar implementation shifts the 2.62 accumulator according to postShift
+ to yield the final 1.31 result. This conversion does not saturate.
The output signal and error signal are in 1.31 format.
@par
In this filter, filter coefficients are updated for each sample and
diff --git a/Source/MatrixFunctions/arm_mat_mult_opt_q31.c b/Source/MatrixFunctions/arm_mat_mult_opt_q31.c
index 40ce25887..6efc302b4 100755
--- a/Source/MatrixFunctions/arm_mat_mult_opt_q31.c
+++ b/Source/MatrixFunctions/arm_mat_mult_opt_q31.c
@@ -58,7 +58,8 @@
distorts the result. The input signals should be scaled down to avoid intermediate
overflows. The input is thus scaled down by log2(numColsA) bits
to avoid overflows, as a total of numColsA additions are performed internally.
- The 2.62 accumulator is right shifted by 31 bits and saturated to 1.31 format to yield the final result.
+ The scalar implementation right shifts the 2.62 accumulator by 31 bits to yield the final 1.31 result.
+ This conversion does not saturate.
@remark
Refer to \ref arm_mat_mult_fast_q31() for a faster but less precise implementation of this function.
@remark
diff --git a/Source/MatrixFunctions/arm_mat_mult_q31.c b/Source/MatrixFunctions/arm_mat_mult_q31.c
index 27e578dba..1ad5aacee 100644
--- a/Source/MatrixFunctions/arm_mat_mult_q31.c
+++ b/Source/MatrixFunctions/arm_mat_mult_q31.c
@@ -57,7 +57,8 @@
distorts the result. The input signals should be scaled down to avoid intermediate
overflows. The input is thus scaled down by log2(numColsA) bits
to avoid overflows, as a total of numColsA additions are performed internally.
- The 2.62 accumulator is right shifted by 31 bits and saturated to 1.31 format to yield the final result.
+ The scalar implementation right shifts the 2.62 accumulator by 31 bits to yield the final 1.31 result.
+ This conversion does not saturate.
@remark
Refer to \ref arm_mat_mult_fast_q31() for a faster but less precise implementation of this function.
*/