Skip to content

Commit 4acfef7

Browse files
Updated documentation for issue ARM-software#145
1 parent 91e83cb commit 4acfef7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Source/SupportFunctions/arm_float_to_q31.c

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@
6060
@note
6161
In order to apply rounding, the library should be rebuilt with the ROUNDING macro
6262
defined in the preprocessor section of project options.
63+
64+
@note If the input float values are very big (2**32) then the function
65+
won't be able to saturate to the right values.
66+
If you expect very big float values in the input array then you
67+
should force those values to +1 or -1 before calling this function.
68+
For reasonable float values (< 2**32), the function will saturate correctly.
6369
*/
6470

6571
#if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE)

0 commit comments

Comments
 (0)