Trabajar con floats
*******************

.[perex]
[api:Nette\Utils\Floats] es una clase estática con funciones útiles para comparar números en coma flotante.


Instalación:

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

Todos los ejemplos suponen que está definido el siguiente alias de clase:

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


Motivación
==========

¿Se pregunta por qué necesitamos una clase para comparar floats? Al fin y al cabo, basta con usar los operadores `<`, `>`, `===` y listo, ¿no? Pues no del todo. ¿Qué cree que imprimirá este código?

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

Si ejecuta el código, a algunos les sorprenderá que el programa imprima `not same`.

Las operaciones matemáticas con números en coma flotante pueden provocar errores de precisión por la conversión entre la representación decimal y la binaria. Por ejemplo, `0.1 + 0.2` da algo así como `0.300000000000000044…`. Por eso, al comparar floats tenemos que tolerar una pequeña diferencia, un épsilon.

Y eso es justo lo que hace la clase `Floats`. La siguiente comparación funcionará ahora como cabe esperar:

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

Intentar comparar `NAN` lanza una `\LogicException`.

.[tip]
La clase `Floats` compara con una precisión relativa de aproximadamente `1e-10`. Si necesita trabajar con mayor precisión, valore usar la biblioteca BCMath.


Comparación de floats
=====================


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

Devuelve `true` si `$a` = `$b`.

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


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

Devuelve `true` si `$a` < `$b`.

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


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

Devuelve `true` si `$a` <= `$b`.

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


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

Devuelve `true` si `$a` > `$b`.

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


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

Devuelve `true` si `$a` >= `$b`.

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


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

Devuelve `-1` si `$a` < `$b`, `0` si son iguales y `1` si `$a` > `$b`.

Se puede usar, por ejemplo, con la función `usort()`.

```php
$arr = [1, 5, 2, -3.5];
usort($arr, [Floats::class, 'compare']);
// $arr es ahora [-3.5, 1, 2, 5]
```


Funciones auxiliares
====================


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

Devuelve `true` si el valor es cero.

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


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

Devuelve `true` si el valor es un número entero.

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