Skip to content

Commit

Permalink
Updated documentation for issue #145
Browse files Browse the repository at this point in the history
  • Loading branch information
christophe0606 committed Jan 10, 2024
1 parent 91e83cb commit 4acfef7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Source/SupportFunctions/arm_float_to_q31.c
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@
@note
In order to apply rounding, the library should be rebuilt with the ROUNDING macro
defined in the preprocessor section of project options.
@note If the input float values are very big (2**32) then the function
won't be able to saturate to the right values.
If you expect very big float values in the input array then you
should force those values to +1 or -1 before calling this function.
For reasonable float values (< 2**32), the function will saturate correctly.
*/

#if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE)
Expand Down

0 comments on commit 4acfef7

Please sign in to comment.