2017 © Pedro Peláez
 

library ace-calculator

Flexible universal calculator with custom operators, functions and variables

image

avadim/ace-calculator

Flexible universal calculator with custom operators, functions and variables

  • Friday, May 11, 2018
  • by avadim
  • Repository
  • 1 Watchers
  • 0 Stars
  • 455 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 4 Versions
  • 462 % Grown

The README.md

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, (*1)

Based on NeonXP/MathExecutor (https://github.com/NeonXP/MathExecutor), but advanced and improved., (*2)

Install via Composer

|$ composer require avadim/ace-claculator, (*3)

All instructions to install here: https://packagist.org/packages/avadim/ace-claculator, (*4)

Sample usage

require 'vendor/autoload.php';
// create the calculator
$calculator = new \avadim\AceClaculator\AceClaculator();

// calculate expression
print $calculator->execute('1 + 2 * (2 - (4+10))^2 + sin(10)');

// cascade execution - you can calculate a series of expressions 
// variable $_ has result of previous calculation
print $calculator
        ->calc('4+10')
        ->calc('1 + 2 * (2 - $_)^2') // the variable $_ contains the result of the last calculation
        ->calc('$_ + sin(10)')
        ->getResult();

Default operators and functions

Default operators: + - * / ^, (*5)

Default functions: * min() * max() * avg() * sqrt() * sin() * cos() * tn() * asin() * acos() * atn() * degrees() * radians(), (*6)

Variables

Default variables:, (*7)

$pi = 3.14159265359
$e = 2.71828182846

You can add own variable to executor:, (*8)

$calculator->setVars([
    'var1' => 0.15,
    'var2' => 0.22
]);

$calculator->execute('$var1 + $var2');

Extra operators and functions

You can load extensions with extra operators and functions by method loadExtension():, (*9)

// load extension 'Bool'
$calculator->loadExtension('Bool');

This extension load boolean operators: < <= > >= == !=, (*10)

You can use boolean operators with extra function if(), (*11)

print $calculator->execute('if(100+20+3 > 111, 23, 34)');

Custom functions

Add custom function to executor:, (*12)

$calculator->addFunction('hypotenuse', function($a, $b) {
    return sqrt($a^2 + $b^2);
}, 2);

print $calculator->execute('hypotenuse(3,4)');

Custom operators

Create the class of custom operator:, (*13)

<?php
use avadim\AceCalculator\Generic\AbstractToken;
use avadim\AceCalculator\Generic\AbstractTokenOperator;
use avadim\AceCalculator\Token\TokenScalarNumber;

class TokenOperatorModulus extends AbstractTokenOperator
{
    protected static $pattern = 'mod';

    /**
     * Priority of this operator (1 equals "+" or "-", 2 equals "*" or "/", 3 equals "^")
     * @return int
     */
    public function getPriority()
    {
        return 3;
    }

    /**
     * Association of this operator (self::LEFT_ASSOC or self::RIGHT_ASSOC)
     * @return string
     */
    public function getAssociation()
    {
        return self::LEFT_ASSOC;
    }

    /**
     * Execution of this operator
     * @param AbstractToken[] $stack Stack of tokens
     *
     * @return TokenScalarNumber
     */
    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:, (*14)

$calculator = new avadim\AceClaculator\AceClaculator();
$calculator->addOperator('mod', '\TokenOperatorModulus');
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, (*15)

$calculator->setIdentifiers([
    'ONE' => 1,
    'YEAR' => function($variables, $identifiers) { return date('Y'); },
]);

$calculator->execute('YEAR + ONE');

Non-numeric values

Non-numeric values will cause warnings in arithmetic operations. But you can set a special option to avoid this., (*16)

$calculator = new avadim\AceCalculator\AceCalculator();

// calc expression with variable
$calculator->setVar('x', null);
// There will be a warning in the next line
$calculator->execute('$x * 12');

$calculator->setOption('non_numeric', true);
// And now there will be no warning
$calculator->execute('$x * 12');

Support AceCalculator

if you find this package useful you can support and donate to me https://www.paypal.me/VShemarov, (*17)

The Versions

11/05 2018

dev-master

9999999-dev https://github.com/aVadim483/ace-calculator

Flexible universal calculator with custom operators, functions and variables

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Vadim Shemarov aka aVadim

parser math lexer expression calculator

11/05 2018

v2.1.4

2.1.4.0 https://github.com/aVadim483/ace-calculator

Flexible universal calculator with custom operators, functions and variables

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Vadim Shemarov aka aVadim

parser math lexer expression calculator

10/02 2018

v2.1.3

2.1.3.0 https://github.com/aVadim483/ace-calculator

Flexible universal calculator with custom operators, functions and variables

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Vadim Shemarov aka aVadim

parser math lexer expression calculator

10/02 2018

v2.1.2

2.1.2.0 https://github.com/aVadim483/ace-calculator

Flexible universal calculator with custom operators, functions and variables

  Sources   Download

MIT

The Requires

  • php >=5.6

 

The Development Requires

by Vadim Shemarov aka aVadim

parser math lexer expression calculator