Praca z liczbami zmiennoprzecinkowymi

Nette\Utils\Floats to klasa statyczna zawierająca przydatne funkcje do porównywania liczb zmiennoprzecinkowych.

Instalacja:

composer require nette/utils

Wszystkie przykłady zakładają, że zdefiniowany jest następujący alias klasy:

use Nette\Utils\Floats;

Motywacja

Zastanawiasz się, po co nam klasa do porównywania liczb zmiennoprzecinkowych? Przecież można użyć operatorów <, >, === i po sprawie, prawda? Cóż, nie do końca. Jak myślisz, co wypisze ten kod?

$a = 0.1 + 0.2;
$b = 0.3;
echo $a === $b ? 'równe' : 'nierówne';

Jeśli uruchomisz ten kod, część z Was może zaskoczyć, że program wypisze nierówne.

Operacje matematyczne na liczbach zmiennoprzecinkowych mogą prowadzić do błędów precyzji wynikających z konwersji między reprezentacją dziesiętną a binarną. Na przykład 0.1 + 0.2 daje coś w rodzaju 0.300000000000000044…. Dlatego przy porównywaniu liczb zmiennoprzecinkowych musimy tolerować niewielką różnicę, epsilon.

I dokładnie to robi klasa Floats. Poniższe porównanie zadziała już zgodnie z oczekiwaniami:

echo Floats::areEqual($a, $b) ? 'równe' : 'nierówne'; // równe

Próba porównania NAN zgłasza \LogicException.

Klasa Floats porównuje z precyzją względną około 1e-10. Jeśli potrzebujesz pracować z wyższą precyzją, rozważ użycie biblioteki BCMath.

Porównywanie liczb zmiennoprzecinkowych

areEqual (float $a, float $b): bool

Zwraca true, jeśli $a = $b.

Floats::areEqual(10, 10.0); // true

isLessThan (float $a, float $b): bool

Zwraca true, jeśli $a < $b.

Floats::isLessThan(9.5, 10.2); // true
Floats::isLessThan(INF, 10.2); // false

isLessThanOrEqualTo (float $a, float $b): bool

Zwraca true, jeśli $a <= $b.

Floats::isLessThanOrEqualTo(9.5, 10.2);    // true
Floats::isLessThanOrEqualTo(10.25, 10.25); // true

isGreaterThan (float $a, float $b): bool

Zwraca true, jeśli $a > $b.

Floats::isGreaterThan(9.5, -10.2); // true
Floats::isGreaterThan(9.5, 10.2);  // false

isGreaterThanOrEqualTo (float $a, float $b): bool

Zwraca true, jeśli $a >= $b.

Floats::isGreaterThanOrEqualTo(9.5, 10.2);  // false
Floats::isGreaterThanOrEqualTo(10.2, 10.2); // true

compare (float $a, float $b): int

Zwraca -1, jeśli $a < $b, 0, jeśli są równe, i 1, jeśli $a > $b.

Można jej użyć na przykład z funkcją usort().

$arr = [1, 5, 2, -3.5];
usort($arr, [Floats::class, 'compare']);
// $arr to teraz [-3.5, 1, 2, 5]

Funkcje pomocnicze

isZero (float $value): bool

Zwraca true, jeśli wartość jest zerem.

Floats::isZero(0.0); // true
Floats::isZero(0);   // true

isInteger (float $value): bool

Zwraca true, jeśli wartość jest liczbą całkowitą.

Floats::isInteger(0);    // true
Floats::isInteger(0.0);  // true
Floats::isInteger(-5.0); // true

Floats::isInteger(-5.1); // false
Floats::isInteger(INF);  // false
Floats::isInteger(NAN);  // false