Update documentation for mantissa and exponent return values

Clarified documentation regarding zero mantissa handling.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Pratik Mankawde
2026-09-23 14:35:33 +01:00
committed by GitHub
parent 5b17c3369d
commit d188083da3

View File

@@ -618,8 +618,7 @@ public:
* @param mantissa Raw signed mantissa (sign is extracted internally).
* @param exponent Raw exponent.
* @return The normalized (mantissa, exponent) pair in the target range.
* A zero mantissa is returned as {mantissa=0, exponent=0, negative=false}.
* @note The result is bit-identical to the two-pass path: an intermediate
* A zero mantissa is returned as {mantissa=0, exponent=0} (sign is not preserved for zero).
* pass to a strictly wider range cannot change the final
* narrower-range result.
* @note Thread-safety: reads the thread-local rounding mode only; holds no