https://github.com/muqsit/arithmexp

A powerful mathematical expression parser and evaluator for PHP featuring variable substitution, user-defined constants, functions, deterministic functions, macros, operators, and compiler optimizations.
https://github.com/muqsit/arithmexp

calculator compiler composer-library constant-folding logic math mathematical-expression-parser optimization parser php phpstan-l9 pmmp pocketmine-mp strength-reduction virion

Last synced: 2 months ago
JSON representation

A powerful mathematical expression parser and evaluator for PHP featuring variable substitution, user-defined constants, functions, deterministic functions, macros, operators, and compiler optimizations.

• Host: GitHub
• URL: https://github.com/muqsit/arithmexp
• Owner: Muqsit
• License: gpl-3.0
• Created: 2021-08-02T04:42:16.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T18:17:15.000Z (5 months ago)
• Last Synced: 2024-09-22T15:32:03.584Z (3 months ago)
• Topics: calculator, compiler, composer-library, constant-folding, logic, math, mathematical-expression-parser, optimization, parser, php, phpstan-l9, pmmp, pocketmine-mp, strength-reduction, virion
• Language: PHP
• Homepage: https://arithmexp.pages.dev
• Size: 396 KB
• Stars: 24
• Watchers: 5
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# arithmexp

[![CI](https://github.com/Muqsit/arithmexp/actions/workflows/ci.yml/badge.svg)](https://github.com/Muqsit/arithmexp/actions/workflows/ci.yml)

[![Latest Release](https://img.shields.io/github/v/release/Muqsit/arithmexp)](https://github.com/Muqsit/arithmexp/releases/latest)

[`arithmexp`](https://github.com/Muqsit/arithmexp) is a powerful mathematical expression parser and evaluator library for PHP with support for [variable substitution](https://github.com/Muqsit/arithmexp#evaluating-a-mathematical-expression), [constant declaration](https://github.com/Muqsit/arithmexp/wiki), [deterministic and non-deterministic function registration](https://github.com/Muqsit/arithmexp/wiki), and more.

> [!TIP]

> Try out arithmexp parser on the [**demo site**](https://arithmexp.pages.dev/)!

## Installation with composer

```

composer require muqsit/arithmexp

```

## Evaluating a mathematical expression

To evaluate a mathematical expression, create a [`Parser`](https://github.com/Muqsit/arithmexp/blob/master/src/muqsit/arithmexp/Parser.php) and invoke `Parser::parse()` with an expression string to obtain a reusable [`Expression`](https://github.com/Muqsit/arithmexp/blob/master/src/muqsit/arithmexp/expression/Expression.php) object.

`Expression::evaluate()` returns the value of the expression.

```php

$parser = Parser::createDefault();

$expression = $parser->parse("2 + 3");

var_dump($expression->evaluate()); // int(5)

$expression = $parser->parse("mt_rand()");

var_dump($expression->evaluate()); // int(1370501507)

var_dump($expression->evaluate()); // int(1522981420)

```

Variables may be substituted at evaluation-time by passing an `array` value to `Expression::evaluate()`.

```php

$expression = $parser->parse("x + y");

var_dump($expression->evaluate(["x" => 2, "y" => 3])); // int(5)

var_dump($expression->evaluate(["x" => 1.5, "y" => 1.5])); // float(3)

$expression = $parser->parse("a > b or c");

var_dump($expression->evaluate(["a" => 1, "b" => 2, "c" => true])); // bool(true)

```

The return value type of the evaluation is consistent with that of PHP's—`int + int` returns an `int` value, while `float + int|float` returns a `float` value.

`bool + bool` returns an `int` value, while `int || int` returns a `bool` value.

> [!NOTE]

> Check out the [**wiki**](https://github.com/Muqsit/arithmexp/wiki) for documentation notes and further implementation details.