AceCalculator - flexible universal calculator in PHP
You can calculate classical mathematical expressions with variables,
or you can specify your own calculation rules, operators or custom functions
Forked from NeonXP/MathExecutor (https://github.com/NeonXP/MathExecutor), but advanced and improved.
Jump To:
Installation
|$ composer require avadim/ace-claculator
All instructions to install here: https://packagist.org/packages/avadim/ace-claculator
Sample Usage
require 'vendor/autoload.php';
$calculator = new \avadim\AceClaculator\AceClaculator();
print $calculator->execute('1 + 2 * (2 - (4+10))^2 + sin(10)');
print $calculator
->calc('4+10')
->calc('1 + 2 * (2 - $_)^2')
->calc('$_ + sin(10)')
->result();
Default operators, functions and constants
Default operators: + - * / ^
Arithmetic functions
- abs()
- avg()
- ceil()
- exp()
- expm1()
- floor()
- fmod()
- hypot()
- intdiv()
- log()
- log10()
- log1p()
- max()
- min()
- sqrt()
- round()
Trigonometric functions
- acos()
- acosh()
- asin()
- asinh()
- atan()
- atan2()
- atanh()
- atn() (alias of atan)
- cos()
- cosh()
- deg2rad()
- degrees() (alias of rad2deg)
- rad2deg()
- radians() (alias of deg2rad)
- sin()
- sinh()
- tan()
- tanh()
- tn() (alias of tan)
Default constants
PI = 3.14159265358979323846
E = 2.7182818284590452354
Also you can use any standard math constants from PHP - M_LOG2E, M_PI_2 etc
$calculator->execute('cos(PI)');
$calculator->execute('cos(M_PI)');
Variables
You can add own variables to executor and use their in expressions
$calculator->setVars([
'var1' => 0.15,
'var2' => 0.22
]);
$calculator->execute('$var1 + $var2');
$calculator->execute('$var1 + $var2', '$var3');
$calculator
->calc('$var3 = ($var1 + $var2)')
->calc('$var3 * 20')
->result();
Multiple expressions
You can execute multiple expressions in one by separating them with a semicolon
$result1 = $calculator
->setVar('$var1', 0.15)
->setVar('$var2', 0.22)
->calc('$var3 = $var1 + $var2')
->calc('$var3 * 20')
->result()
;
$result2 = $calculator->execute('$var1=0.15; $var2=0.22; $var3 = $var1 + $var2; $var3 * 20');
Extra operators and functions
You can load extensions with extra operators and functions by method loadExtension():
$calculator->loadExtension('Bool');
This extension load boolean operators: < <= > >= == != && ||
You can use boolean operators with extra function if()
print $calculator->execute('if(100+20+3 > 111, 23, 34)');
Custom functions
Add custom function to executor:
$calculator->addFunction('dummy', function($a) {
return $result;
});
print $calculator->execute('dummy(123)');
$calculator->addFunction('hypotenuse', function($a, $b) {
return sqrt($a^2 + $b^2);
}, 2);
$calculator->addFunction('nround', function($a, $b = 0) {
return round($a, $b);
}, 1, true);
print $calculator->execute('nround(hypotenuse(3,4), 2)');
Custom operators
A simple way to add an operator
use avadim\AceCalculator\Token\Operator\TokenOperator;
$func = function (array &$stack)
{
$op2 = array_pop($stack);
$op1 = array_pop($stack);
return $op1->getValue() % $op2->getValue();
};
$calculator->addOperator('mod', [TokenOperator::MATH_PRIORITY_DIVIDE, $func]);
echo $calculator->execute('286 mod 100');
Alternative way to add operator using specified class. Create the class of custom operator
<?php
use avadim\AceCalculator\Generic\AbstractToken;
use avadim\AceCalculator\Generic\AbstractTokenOperator;
use avadim\AceCalculator\Token\TokenScalarNumber;
class TokenOperatorModulus extends AbstractTokenOperator
{
protected static $pattern = 'mod';
public function getPriority()
{
return 3;
}
public function getAssociation()
{
return self::LEFT_ASSOC;
}
public function execute(&$stack)
{
$op2 = array_pop($stack);
$op1 = array_pop($stack);
$result = $op1->getValue() % $op2->getValue();
return new TokenScalarNumber($result);
}
}
And add the class to executor:
$calculator = new avadim\AceClaculator\AceClaculator();
$calculator->addOperator('mod', \TokenOperatorModulus::class);
echo $calculator->execute('286 mod 100');
Interpreting of identifiers
Identifiers - start with a letter and consist of a sequence of letters and numbers. You can specify rules how to interpret them in calculations
$calculator->setIdentifiers([
'ONE' => 1,
'YEAR' => function($identifier) { return date('Y'); },
]);
$calculator->execute('YEAR + ONE');
Non-numeric values
Non-numeric values will cause warnings in arithmetic operations. However, you can set a special option to avoid this.
$calculator = new avadim\AceCalculator\AceCalculator();
$calculator->setVar('$x', null);
$calculator->execute('$x * 12');
$calculator->setOption('non_numeric', true);
$calculator->execute('$x * 12');
Error Handlers
Division by zero
Usually division by zero throws a DivisionByZeroException. But you can redefine this behavior
$s = '10/0';
$calculator->setDivisionByZeroHandler(static function($a, $b) {
return 0;
});
echo $calculator->execute($s);
Unknown Identifier
Usually unknown identifier throws a UnknownIdentifier. But you can redefine this behavior
$calculator->setIdentifiers([
'ONE' => 1,
'TWO' => 2,
]);
echo $calculator->execute('THREE');
$calculator->setUnknownIdentifierHandler(static function($identifier) {
return $identifier;
});
echo $calculator->execute('THREE');
$calculator->setUnknownIdentifierHandler(static function($identifier) use ($calculator) {
return $calculator->execute('ONE + TWO');
});
echo $calculator->execute('THREE');
Unknown Variable
Usually unknown identifier throws a UnknownIdentifier. But you can redefine this behavior
$calculator = new avadim\AceCalculator\AceCalculator();
$calculator->execute('$a * 4');
$calculator->setUnknownVariableHandler(static function($variable) {
return 0;
});
$calculator->execute('$a * 4');
Support AceCalculator
if you find this package useful you just give me star on Github :)