Работа с числами с плавающей точкой
***********************************

.[perex]
[api:Nette\Utils\Floats] - статический класс с полезными функциями для сравнения чисел с плавающей точкой.


Установка:

```shell
composer require nette/utils
```

Во всех примерах предполагается, что определён такой псевдоним класса:

```php
use Nette\Utils\Floats;
```


Зачем это нужно
===============

Вы спрашиваете, зачем нам класс для сравнения чисел с плавающей точкой? Ведь можно использовать операторы `<`, `>`, `===`, и дело сделано, правда? Ну, не совсем. Как вы думаете, что выведет этот код?

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

Если вы запустите этот код, некоторые из вас удивятся, что программа выведет `not same`.

Математические операции с числами с плавающей точкой могут приводить к погрешностям из-за преобразования между десятичным и двоичным представлениями. Например, `0.1 + 0.2` даёт что-то вроде `0.300000000000000044…`. Поэтому при сравнении таких чисел нужно допускать небольшую разницу - эпсилон.

Именно этим и занимается класс `Floats`. Следующее сравнение теперь сработает как ожидается:

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

Попытка сравнить `NAN` выбрасывает `\LogicException`.

.[tip]
Класс `Floats` сравнивает с относительной точностью около `1e-10`. Если вам нужна более высокая точность, подумайте об использовании библиотеки BCMath.


Сравнение чисел с плавающей точкой
==================================


areEqual(float $a, float $b): bool .[method]
--------------------------------------------

Возвращает `true`, если `$a` = `$b`.

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


isLessThan(float $a, float $b): bool .[method]
----------------------------------------------

Возвращает `true`, если `$a` < `$b`.

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


isLessThanOrEqualTo(float $a, float $b): bool .[method]
-------------------------------------------------------

Возвращает `true`, если `$a` <= `$b`.

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


isGreaterThan(float $a, float $b): bool .[method]
-------------------------------------------------

Возвращает `true`, если `$a` > `$b`.

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


isGreaterThanOrEqualTo(float $a, float $b): bool .[method]
----------------------------------------------------------

Возвращает `true`, если `$a` >= `$b`.

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


compare(float $a, float $b): int .[method]
------------------------------------------

Возвращает `-1`, если `$a` < `$b`, `0`, если они равны, и `1`, если `$a` > `$b`.

Его можно использовать, например, с функцией `usort()`.

```php
$arr = [1, 5, 2, -3.5];
usort($arr, [Floats::class, 'compare']);
// теперь $arr равен [-3.5, 1, 2, 5]
```


Вспомогательные функции
=======================


isZero(float $value): bool .[method]
------------------------------------

Возвращает `true`, если значение равно нулю.

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


isInteger(float $value): bool .[method]
---------------------------------------

Возвращает `true`, если значение является целым числом.

```php
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
```