PIP 0.7.1 Platform-Independent Primitives

Public Member Functions | List of all members
PIEvaluator Class Reference

This class provide mathematical evaluations of custom expression. More...

## Public Member Functions
| PIEvaluator ()
| Constructs an empty evaluator.
void * | data ()
| Returns custom data.
void | setData (void *_data)
| Set custom data to "_data".
bool | check (const PIString &string)
| Check mathematical expression and parse it to list of instructions.
bool | isCorrect () const
| Returns true if expression was checked succesfully.
int | setVariable (const PIString &name, complexd value=0.)
| Set variable value with name "name" to value "value". Add variable if it doesn`t exists.
void | setVariable (int index, complexd value=0.)
| Set variable value with index "index" to value "value". Don`t add variable if it doesn`t exists.
complexd | evaluate ()
| Evaluate last successfully checked with function check() expression and returns result.
void | removeVariable (const PIString &name)
| Remove variable with name "name".
void | clearCustomVariables ()
| Remove all manually added variables.
int | variableIndex (const PIString &name) const
| Returns index of variable with name "name".
const PIStringList & | unknownVariables () const
| Returns all unknown variables founded in last expression passed to check() function.
const PIString & | expression () const
| Returns processed last expression passed to check() function.
const PIString & | error () const
| Returns last error description occured in check() function.
const complexd & | lastResult () const
| Returns last result of evaluate()

## Detailed Description

This class provide mathematical evaluations of custom expression.

# Synopsis

PIEvaluator developed for stream evaluations of once set expression. It`s create internal list of instructions on function check() and executes very fast on function evaluate(). Once given expression can be evaluated any times with different variable values. Evaluator supports many common mathematic functions described below. Also it`s automatic puts unnecessarily signs and bracets. Processed expression can be obtains with function expression(). If there is an error in expression you can get it with function error(). Last evaluated result you can get with function lastResult().

# Using

First you should set your variables with function setVariable(). Next give your expression with function check() and check for error with functions isCorrect() and error(). If expression is correct you can get processed expression with function expression() and evaluate it with function evaluate(). You can change variable values without rechecking expression.

# Functions

PIEvaluator supports arithmetical operations with complex numbers, this is their list in priority order:

- ^ (power)
- * (multiply)
- / (divide)
- % (residue)
- + (add)
- - (subtract)

In addition there are compare and logical operations:

- == (equal)
- != (not equal)
- > (greater)
- < (smaller)
- >= (greater or equal)
- <= (smaller or equal)
- && (and)
- || (or)

Compare and logical functions works with real operators part and returns 0 or 1.

Mathematical functions:

- sin(x) - sine
- cos(x) - cosine
- tg(x) - tangent
- ctg(x) - cotangent
- arcsin(x) - arcsine
- arccos(x) - arccosine
- arctg(x) -arccotangent
- arcctg(x) - arctangent
- sh(x) - hyperbolical sine
- ch(x) - hyperbolical cosine
- th(x) - hyperbolical tangent
- cth(x) - hyperbolical cotangent
- sqr(x) - square
- sqrt(x) - square root
- abs(x) - absolute value
- sign(x) - sign of real part (-1 or 1)
- exp(x) - exponent
- pow(x, p) - x in power p
- ln(x) - natural logarithm
- lg(x) - decimal logarithm
- log(x, b) - logarithm of x with base b
- im(x) - imaginary part of complex number
- re(x) - real part of complex number
- arg(x) - argument of complex number
- len(x) - length of complex number
- conj(x) - length of complex number
- rad(x) - convert degrees to radians
- deg(x) - convert radians to degrees
- j0(x) - Bessel function first kind order 0
- j1(x) - Bessel function first kind order 1
- jn(x, n) - Bessel function first kind order n
- y0(x) - Bessel function second kind order 0
- y1(x) - Bessel function second kind order 1
- yn(x, n) - Bessel function second kind order n
- random(s, f) - regular random number in range [s, f]
- min(x0, x1, ...) - minimum of x0, x1, ...
- max(x0, x1, ...) - maximum of x0, x1, ...
- clamp(x, a, b) - trim x on range [a, b]
- step(x, s) - 0 if x < s, else 1
- mix(x, a, b) - interpolate between a and b linear for x (a * (1 - x) + b * x)

There are some built-in constans:

- i (imaginary 1)
- e
- pi

All trigonometric functions takes angle in radians.

# Example

PIEvaluator eval;
eval.check("e2eelge");
piCout << eval.expression() << "=" << eval.evaluate();
// e*2*e*e*lg(e) = (17.4461; 0)
eval.check("10x");
piCout << eval.error() << eval.unknownVariables();
// Unknown variables: "x" {"x"}
eval.setVariable("x", complexd(1, 2));
eval.check("10x");
piCout << eval.error() << eval.unknownVariables();
// Correct {}
piCout << eval.expression() << "=" << eval.evaluate();
// 10*x = (10; 20)
eval.setVariable("x", complexd(-2, 0));
piCout << eval.expression() << "=" << eval.evaluate();
// 10*x = (-20; 0)