iamvar/math

Calculate expression, using bcmath functions.

v1.0.1 2023-06-02 22:44 UTC

This package is auto-updated.

Last update: 2024-10-03 14:48:22 UTC


README

Every developer knows: float is not the best choice for precise calculation.

php > var_dump(1.2 * 3);
float(3.5999999999999996)

We have bcmath, you say.

Yes, but calculating small expression, like ($a + $b * $c - $d) / $e becomes as heavy as

<?php

$result = bcdiv(bcsub(bcadd($a, bcmul($b, $c)), $d), $e);

That is where this tool becomes useful:

With registered helpers functions, you can just use

<?php

$result = calc("$a + $b * $c - $d");

That's it!

All calculations behind the scene use bcmath functions.

php > var_dump(calc("1.2 * 3"));
string("3.6")

php > isTrue('1 < 2 < 3'); // true

Helper Functions

To register global helper functions, just update your composer.json with

"autoload": {
    "files": [
        "vendor/iamvar/math/src/helpers.php"
    ]
},

Examples

<?php

$a = 0.1E1;
$b = 2e-7;
$c = 2;
calc("$a + $b * $c"); // 1.0000004
calc("1.69 ^ (1/2) + (0.1 - 0.25) * 2"); // 1
calc('min(09.12, abs(-10.01))'); // 9.12
calc('max(1, 1.000000000000001)'); // 1.000000000000001

isTrue('(1 + 0.2) * 3 == 3.6 + (1-9) * 0"); // true
isTrue('1 < 2 < 3'); // true
isTrue('1 < 2 > 3'); // false

bcscale

All calculations are performed with scale, taken by default from bcscale().
Do not forget to set required bcscale in your bootstrap file.

<?php

bcscale(25);

Usage

By default calc function cuts trailing zeroes,
e.g with scale = 4 calc("0.1 + 0.9") will return "1"

If you want to save scale, add second parameter as false
calc("0.1 + 0.9", false) will return "1.0000"

License

Math is licensed under the MIT License.