Add precision about toFloat() and Infinity

brick · Nov 7, 2018 · 96936b2 · 96936b2
1 parent a16737c
commit 96936b2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/BigNumber.php b/src/BigNumber.php
@@ -387,6 +387,9 @@ abstract public function toInt() : int;
      * Note that this method can discard information as the precision of a floating-point value
      * is inherently limited.
      *
+     * If the number is greater than the largest representable floating point number, positive infinity is returned.
+     * If the number is less than the smallest representable floating point number, negative infinity is returned.
+     *
      * @return float The converted value.
      */
     abstract public function toFloat() : float;