EvalMath Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for EvalMath:

Public Member Functions
	__construct ()
	e (string $expr)
	evaluate (string $expr)
	vars ()
	funcs ()
	nfx ($expr)
	pfx ($tokens, $vars=[])
	trigger (string $msg)
	from_hexbin ($token)

Data Fields
bool	$suppress_errors = false
string	$last_error = null
array	$v = array('e' => 2.71,'pi' => 3.14)
array	$f = []
array	$vb = array('e', 'pi')
array	$fb

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 105 of file class.EvalMath.php.

Constructor & Destructor Documentation

__construct()

EvalMath::__construct

(

)

Definition at line 119 of file class.EvalMath.php.

    {
        // make the variables a little more accurate
        $this->v['pi'] = pi();
        $this->v['exp'] = exp(1);
        $this->v['e'] = exp(1); // different result for exp(1) and e
        $this->fb[] = 'exp'; // usage of php exp function in formula
    }

Member Function Documentation

e()

EvalMath::e

(

string

$expr

)

Definition at line 128 of file class.EvalMath.php.

    {
        return $this->evaluate($expr);
    }

References evaluate().

Here is the call graph for this function:

evaluate()

EvalMath::evaluate

(

string

$expr

)

Definition at line 133 of file class.EvalMath.php.

    {
        // convert exponential notation
        $expr = preg_replace_callback(
            "/(\\d{0,1})e([+-]{0,1}\\d+)/is",
            fn($hit): string => $hit[1] . ((strlen($hit[1])) ? '*' : '') . '10^(' . ltrim($hit[2], '+') . ')',
            $expr
        );
        // standard functionality
        $this->last_error = null;
        $expr = trim($expr);
        if (substr($expr, -1, 1) == ';') {
            $expr = substr($expr, 0, strlen($expr) - 1);
        } // strip semicolons at the end
        //===============
        // is it a variable assignment?
        if (preg_match('/^\s*([a-z]\w*)\s*=\s*(.+)$/', $expr, $matches)) {
            if (in_array($matches[1], $this->vb)) { // make sure we're not assigning to a constant
                return $this->trigger("cannot assign to constant '$matches[1]'");
            }
            if (($tmp = $this->pfx($this->nfx($matches[2]))) === false) {
                return false;
            } // get the result and make sure it's good
            $this->v[$matches[1]] = $tmp; // if so, stick it in the variable array
            return $this->v[$matches[1]]; // and return the resulting value
            //===============
            // is it a function assignment?
        } elseif (preg_match('/^\s*([a-z]\w*)\s*\‍(\s*([a-z]\w*(?:\s*,\s*[a-z]\w*)*)\s*\‍)\s*=\s*(.+)$/', $expr, $matches)) {
            $fnn = $matches[1]; // get the function name
            if (in_array($matches[1], $this->fb)) { // make sure it isn't built in
                return $this->trigger("cannot redefine built-in function '$matches[1]()'");
            }
            $args = explode(",", preg_replace("/\s+/", "", $matches[2])); // get the arguments
            if (($stack = $this->nfx($matches[3])) === false) {
                return false;
            } // see if it can be converted to postfix
            for ($i = 0; $i < count($stack); $i++) { // freeze the state of the non-argument variables
                $token = $stack[$i];
                if (preg_match('/^[a-z]\w*$/', $token) and !in_array($token, $args)) {
                    if (array_key_exists($token, $this->v)) {
                        $stack[$i] = $this->v[$token];
                    } else {
                        return $this->trigger("undefined variable '$token' in function definition");
                    }
                }
            }
            $this->f[$fnn] = array('args' => $args, 'func' => $stack);
            return true;
        } else {
            return $this->pfx($this->nfx($expr)); // straight up evaluation, woo
        }
    }

References $token, nfx(), pfx(), and trigger().

Referenced by e().

Here is the call graph for this function:

Here is the caller graph for this function:

from_hexbin()

EvalMath::from_hexbin

(

$token

)

Definition at line 443 of file class.EvalMath.php.

    {
        if (strtoupper(substr($token, -1, 1)) == 'H') {
            return hexdec($token);
        }
        if (strtoupper(substr($token, -1, 1)) == 'B') {
            return bindec($token);
        }
        return false;
    }

References $token.

Referenced by pfx().

Here is the caller graph for this function:

funcs()

EvalMath::funcs

(

)

Returns

string[]

Definition at line 197 of file class.EvalMath.php.

                           : array
    {
        $output = [];
        foreach ($this->f as $fnn => $dat) {
            $output[] = $fnn . '(' . implode(',', $dat['args']) . ')';
        }
        return $output;
    }

nfx()

EvalMath::nfx

(

$expr

)

Definition at line 206 of file class.EvalMath.php.

    {
        $index = 0;
        $stack = new EvalMathStack();
        $output = []; // postfix form of expression, to be passed to pfx()
        $expr = trim(strtolower($expr));
 
        $ops = array('+', '-', '*', '/', '^', '_');
        $ops_r = array('+' => 0,'-' => 0,'*' => 0,'/' => 0,'^' => 1); // right-associative operator?
        $ops_p = array('+' => 0,'-' => 0,'*' => 1,'/' => 1,'_' => 1,'^' => 2); // operator precedence
 
        $expecting_op = false; // we use this in syntax-checking the expression
        // and determining when a - is a negation
 
        if (preg_match("/[^\w\s+*^\/()\.,-]/", $expr, $matches)) { // make sure the characters are all good
            return $this->trigger("illegal character '{$matches[0]}'");
        }
 
        while (1) { // 1 Infinite Loop ;)
            $op = substr($expr, $index, 1); // get the first character at the current index
            // find out if we're currently at the beginning of a number/variable/function/parenthesis/operand
            $ex = preg_match('/^([01]+[bB]|[\da-fA-F]+[hH]|[a-z]\w*\‍(?|\d+(?:\.\d*)?|\.\d+|\‍()/', substr($expr, $index), $match);
            //===============
            if ($op == '-' and !$expecting_op) { // is it a negation instead of a minus?
                $stack->push('_'); // put a negation on the stack
                $index++;
            } elseif ($op == '_') { // we have to explicitly deny this, because it's legal on the stack
                return $this->trigger("illegal character '_'"); // but not in the input expression
                //===============
            } elseif ((in_array($op, $ops) or $ex) and $expecting_op) { // are we putting an operator on the stack?
                if ($ex) { // are we expecting an operator but have a number/variable/function/opening parethesis?
                    $op = '*';
                    $index--; // it's an implicit multiplication
                }
                // heart of the algorithm:
                while ($stack->count > 0 and ($o2 = $stack->last()) and in_array($o2, $ops) and ($ops_r[$op] ? $ops_p[$op] < $ops_p[$o2] : $ops_p[$op] <= $ops_p[$o2])) {
                    $output[] = $stack->pop(); // pop stuff off the stack into the output
                }
                // many thanks: http://en.wikipedia.org/wiki/Reverse_Polish_notation#The_algorithm_in_detail
                $stack->push($op); // finally put OUR operator onto the stack
                $index++;
                $expecting_op = false;
                //===============
            } elseif ($op == ')' and $expecting_op) { // ready to close a parenthesis?
                while (($o2 = $stack->pop()) != '(') { // pop off the stack back to the last (
                    if (is_null($o2)) {
                        return $this->trigger("unexpected ')'");
                    } else {
                        $output[] = $o2;
                    }
                }
                if (preg_match("/^([a-z]\w*)\‍($/", (string) $stack->last(2), $matches)) { // did we just close a function?
                    $fnn = $matches[1]; // get the function name
                    $arg_count = $stack->pop(); // see how many arguments there were (cleverly stored on the stack, thank you)
                    $output[] = $stack->pop(); // pop the function and push onto the output
                    if (in_array($fnn, $this->fb)) { // check the argument count
                        if ($arg_count > 1) {
                            return $this->trigger("too many arguments ($arg_count given, 1 expected)");
                        }
                    } elseif (array_key_exists($fnn, $this->f)) {
                        if ($arg_count != count($this->f[$fnn]['args'])) {
                            return $this->trigger("wrong number of arguments ($arg_count given, " . count($this->f[$fnn]['args']) . " expected)");
                        }
                    } else { // did we somehow push a non-function on the stack? this should never happen
                        return $this->trigger("internal error");
                    }
                }
                $index++;
                //===============
            } elseif ($op == ',' and $expecting_op) { // did we just finish a function argument?
                while (($o2 = $stack->pop()) != '(') {
                    if (is_null($o2)) {
                        return $this->trigger("unexpected ','");
                    } // oops, never had a (
                    else {
                        $output[] = $o2;
                    } // pop the argument expression stuff and push onto the output
                }
                // make sure there was a function
                if (!preg_match("/^([a-z]\w*)\‍($/", $stack->last(2), $matches)) {
                    return $this->trigger("unexpected ','");
                }
                $stack->push($stack->pop() + 1); // increment the argument count
                $stack->push('('); // put the ( back on, we'll need to pop back to it again
                $index++;
                $expecting_op = false;
                //===============
            } elseif ($op == '(' and !$expecting_op) {
                $stack->push('('); // that was easy
                $index++;
                $allow_neg = true;
                //===============
            } elseif ($ex and !$expecting_op) { // do we now have a function/variable/number?
                $expecting_op = true;
                $val = $match[1];
                if (preg_match("/^([a-z]\w*)\‍($/", $val, $matches)) { // may be func, or variable w/ implicit multiplication against parentheses...
                    if (in_array($matches[1], $this->fb) or array_key_exists($matches[1], $this->f)) { // it's a func
                        $stack->push($val);
                        $stack->push(1);
                        $stack->push('(');
                        $expecting_op = false;
                    } else { // it's a var w/ implicit multiplication
                        $val = $matches[1];
                        $output[] = $val;
                    }
                } else { // it's a plain old var or num
                    $output[] = $val;
                }
                $index += strlen($val);
                //===============
            } elseif ($op == ')') { // miscellaneous error checking
                return $this->trigger("unexpected ')'");
            } elseif (in_array($op, $ops) and !$expecting_op) {
                return $this->trigger("unexpected operator '$op'");
            } else { // I don't even want to know what you did to get here
                return $this->trigger("an unexpected error occured");
            }
            if ($index == strlen($expr)) {
                if (in_array($op, $ops)) { // did we end with an operator? bad.
                    return $this->trigger("operator '$op' lacks operand");
                } else {
                    break;
                }
            }
            while (substr($expr, $index, 1) == ' ') { // step the index past whitespace (pretty much turns whitespace
                $index++;                             // into implicit multiplication if no operator is there)
            }
        }
        while (!is_null($op = $stack->pop())) { // pop everything off the stack and push onto output
            if ($op == '(') {
                return $this->trigger("expecting ')'");
            } // if there are (s on the stack, ()s were unbalanced
            $output[] = $op;
        }
        return $output;
    }

References trigger().

Referenced by evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

pfx()

EvalMath::pfx	(		$tokens,
			$vars = []
	)

Definition at line 344 of file class.EvalMath.php.

    {
        if ($tokens == false) {
            return false;
        }
 
        $stack = new EvalMathStack();
 
        foreach ($tokens as $token) { // nice and easy
            // if the token is a binary operator, pop two values off the stack, do the operation, and push the result back on
            if (in_array($token, array('+', '-', '*', '/', '^'))) {
                if (is_null($op2 = $stack->pop())) {
                    return $this->trigger("internal error");
                }
                if (is_null($op1 = $stack->pop())) {
                    return $this->trigger("internal error");
                }
                switch ($token) {
                    case '+':
                        $stack->push(ilMath::_add($op1, $op2));
                        break;
                    case '-':
                        $stack->push(ilMath::_sub($op1, $op2));
                        break;
                    case '*':
                        $stack->push(ilMath::_mul($op1, $op2));
                        break;
                    case '/':
                        if ($op2 == 0) {
                            return $this->trigger("division by zero");
                        }
                        $stack->push(ilMath::_div($op1, $op2));
                        break;
                    case '^':
                        $stack->push(ilMath::_pow($op1, $op2));
                        break;
                }
                // if the token is a unary operator, pop one value off the stack, do the operation, and push it back on
            } elseif ($token == "_") {
                $stack->push(-1 * $stack->pop());
                // if the token is a function, pop arguments off the stack, hand them to the function, and push the result back on
            } elseif (preg_match("/^([a-z]\w*)\‍($/", $token, $matches)) { // it's a function!
                $fnn = $matches[1];
                if (in_array($fnn, $this->fb)) { // built-in function:
                    if (is_null($op1 = $stack->pop())) {
                        return $this->trigger("internal error");
                    }
                    $fnn = preg_replace("/^arc/", "a", $fnn); // for the 'arc' trig synonyms
                    if ($fnn == 'log') {
                        $fnn = 'log10';
                    } elseif ($fnn == 'ln') {
                        $fnn = 'log';
                    }
 
                    $stack->push($fnn($op1)); // 'eval()' can be easily avoided here
                } elseif (array_key_exists($fnn, $this->f)) { // user function
                    // get args
                    $args = [];
                    for ($i = count($this->f[$fnn]['args']) - 1; $i >= 0; $i--) {
                        if (is_null($args[$this->f[$fnn]['args'][$i]] = $stack->pop())) {
                            return $this->trigger("internal error");
                        }
                    }
                    $stack->push($this->pfx($this->f[$fnn]['func'], $args)); // yay... recursion!!!!
                }
                // if the token is a number or variable, push it on the stack
            } else {
                if (is_numeric($token)) {
                    $stack->push($token);
                } elseif (($hex = $this->from_hexbin($token)) !== false) {
                    $stack->push($hex);
                } elseif (array_key_exists($token, $this->v)) {
                    $stack->push($this->v[$token]);
                } elseif (array_key_exists($token, $vars)) {
                    $stack->push($vars[$token]);
                } else {
                    return $this->trigger("undefined variable '$token'");
                }
            }
        }
        // when we're out of tokens, the stack should have a single element, the final result
        if ($stack->count != 1) {
            return $this->trigger("internal error");
        }
        return $stack->pop();
    }

References $token, ilMath\_add(), ilMath\_div(), ilMath\_mul(), ilMath\_pow(), ilMath\_sub(), from_hexbin(), pfx(), and trigger().

Referenced by evaluate(), and pfx().

Here is the call graph for this function:

Here is the caller graph for this function:

trigger()

EvalMath::trigger

(

string

$msg

)

Definition at line 432 of file class.EvalMath.php.

                                        : bool
    {
        $this->last_error = $msg;
        if (!$this->suppress_errors) {
            trigger_error($msg, E_USER_WARNING);
        }
        return false;
    }

Referenced by evaluate(), nfx(), and pfx().

Here is the caller graph for this function:

vars()

EvalMath::vars

(

)

Definition at line 186 of file class.EvalMath.php.

                          : array
    {
        $output = $this->v;
        unset($output['pi']);
        unset($output['e']);
        return $output;
    }

References $v.

Field Documentation

$f

array EvalMath::$f = []

Definition at line 111 of file class.EvalMath.php.

$fb

array EvalMath::$fb

Initial value:

= array(  
        'sin','sinh','arcsin','asin','arcsinh','asinh',
        'cos','cosh','arccos','acos','arccosh','acosh',
        'tan','tanh','arctan','atan','arctanh','atanh',
        'sqrt','abs','ln','log')

Definition at line 113 of file class.EvalMath.php.

$last_error

string EvalMath::$last_error = null

Definition at line 108 of file class.EvalMath.php.

$suppress_errors

bool EvalMath::$suppress_errors = false

Definition at line 107 of file class.EvalMath.php.

$v

array EvalMath::$v = array('e' => 2.71,'pi' => 3.14)

Definition at line 110 of file class.EvalMath.php.

Referenced by vars().

$vb

array EvalMath::$vb = array('e', 'pi')

Definition at line 112 of file class.EvalMath.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Math/classes/class.EvalMath.php