Praca z liczbami zmiennoprzecinkowymi (float)

Nette\Utils\Floats to statyczna klasa z przydatnymi funkcjami do porównywania liczb dziesiętnych (zmiennoprzecinkowych).

Instalacja:

composer require nette/utils

Wszystkie przykłady zakładają utworzony alias:

use Nette\Utils\Floats;

Motywacja

Zastanawiasz się, po co właściwie klasa do porównywania liczb zmiennoprzecinkowych? Przecież mogę użyć operatorów <, >, === i mam spokój. Nie jest to do końca prawda. Co myślisz, że wypisze ten kod?

$a = 0.1 + 0.2;
$b = 0.3;
echo $a === $b ? 'same' : 'not same';

Jeśli uruchomisz kod, niektórzy z was na pewno będą zaskoczeni, że program wypisał not same.

Podczas operacji matematycznych na liczbach dziesiętnych dochodzi do błędów wynikających z konwersji między systemem dziesiętnym a binarnym. Na przykład 0.1 + 0.2 daje 0.300000000000000044…. Dlatego przy porównywaniu musimy tolerować niewielką różnicę od pewnego miejsca dziesiętnego.

I to właśnie robi klasa Floats. Poniższe porównanie będzie już działać zgodnie z oczekiwaniami:

echo Floats::areEqual($a, $b) ? 'same' : 'not same'; // same

Przy próbie porównania NAN rzuca wyjątek \LogicException.

Klasa Floats toleruje różnice mniejsze niż 1e-10. Jeśli potrzebujesz pracować z większą precyzją, użyj 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 zachodzi $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 zachodzi $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 zachodzi $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 zachodzi $a >= $b.

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

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

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

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

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

Funkcje pomocnicze

isZero (float $value): bool

Zwraca true, jeśli wartość jest równa zero.

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