diff options
| author | nsfisis <nsfisis@gmail.com> | 2025-10-19 00:23:57 +0900 |
|---|---|---|
| committer | nsfisis <nsfisis@gmail.com> | 2025-10-19 00:23:57 +0900 |
| commit | 7da51e3ed8b0a2fef94b82240def83ab24d5cac8 (patch) | |
| tree | cbf0d4d127f782a73aeb4815c0dcffd445f941eb /README.md | |
| parent | 761fafc46d0d2ae8791f4ef078c4ad164b6aee83 (diff) | |
| download | php-next-after-7da51e3ed8b0a2fef94b82240def83ab24d5cac8.tar.gz php-next-after-7da51e3ed8b0a2fef94b82240def83ab24d5cac8.tar.zst php-next-after-7da51e3ed8b0a2fef94b82240def83ab24d5cac8.zip | |
docs: add PHPDoc to public functions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -5,7 +5,7 @@ A PHP library that provides a port of Java's `Math.nextAfter()` family of functi ## Overview -This library implements IEEE 754 floating-point manipulation functions that return the next representable floating-point value in a given direction: +This library implements IEEE 754 floating-point manipulation functions that return the next representable floating-point number in a given direction: - `nextAfter($x, $y)` - Returns the adjacent float in the direction of another value - `nextUp($x)` - Returns the next float toward positive infinity @@ -61,7 +61,7 @@ Returns the floating-point number adjacent to `$x` in the direction of `$y`. If ### `nextUp(float $x): float` -Returns the floating-point value adjacent to `$x` in the direction of positive infinity. +Returns the floating-point number adjacent to `$x` in the direction of positive infinity. This is semantically equivalent to `nextAfter($x, INF)`. @@ -75,7 +75,7 @@ This is semantically equivalent to `nextAfter($x, INF)`. ### `nextDown(float $x): float` -Returns the floating-point value adjacent to `$x` in the direction of negative infinity. +Returns the floating-point number adjacent to `$x` in the direction of negative infinity. This is semantically equivalent to `nextAfter($x, -INF)`. |
