JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 190
  • Score
    100M100P100Q81125F
  • License Apache-2.0

Mathematical expression solving library

Package Exports

  • bigeval

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bigeval) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

BigEval.js

Build Status npm npm npm

An alternative to JavaScript's eval() for solving mathematical expressions. It can be extended to use the Big Number libraries available to provide results with maximum precision. See Releases for compressed script (~4kb) download.

Installation

  • Node
npm install bigeval
> var BigEval = require('bigeval')
  • From browser
<script src="BigEval.js"></script>

Features

  • Full BODMAS/PEMDAS support (just like Eval).
  • Factorial (!), Power (**), Modulo (%), And (&), Xor (^), Or (|) supported.
  • Support for numbers in scientific notation
  • Support for functions. (Math library functions, User functions)
  • Support for CONSTANTS/variables in expressions.

Using

After including BigEval.js, the first step is to get a handle to the BigEval object. Then we can use the exec() method to solve a expression. See project page for a working example.

var Obj = new BigEval();
var result = Obj.exec("5! + 1e3 * (PI + E)"); // 5979.874482048837
var result2 = Obj.exec("sin(45 * deg)**2 + cos(pi / 4)**2"); // 1
var result3 = Obj.exec("0 & -7 ^ -7 - 0%1 + 6%2"); //-7
var result4 = Obj.exec("sin( acos( ceil( tan(pi/6) ) ) )"); // sin(0) i.e. 0

The exec method returns the answer as string. If an error occurs, then Obj.err is set to true and the error message is returned by exec().

Operators

The operators currently supported in order of precedence are -

Factorial (!)
Power (**)
Division (/ or \) , Multiplication (*), Modulo (%)
Addition (+), Subtraction (-)
And (&)
Xor (^)
Or (|)

Functions

BigEval supports functions like sin(), cos() ... When a function is used in an expression, BigEval first looks into its methods to see if such a function exist, then it looks into the JavaScript Math() library and in the end it looks into window's global namespace for the function. Please note that we use just sin() and not Math.sin() in expressions. Attaching a new function to BigEval is easy.

BigEval.prototype.avg = function(a, b){
    return this.div( this.add(a,b) , "2");
};

Constants

Constants are nothing but properties of the BigEval object. To use a constant such as PI in an expression, we can simply write PI. Example - sin( PI / 4 ). To add a new constant, we do Obj.CONSTANT.NAME = VALUE. The VALUE should be in string format. A constant NAME should start with an alphabet and should only use [a-z0-9_] characters. Default constants include -

PI = 3.1415...
PI_2 = PI / 2
LOG2E = log(e) / log(2)
DEG = PI / 180
E = 2.718...
INFINITY = Infinity
NaN = NaN

Extending with Big Number libraries

BigEval can be extended with any of the big number libraries for JavaScript. To extend BigEval, we only need to change its methods that are responsible for adding, subtracting and so. For an example see the extension MikeMcl-decimal.js which is based on MikeMcl's Decimal.js library. The HTML page extended.html shows how to use this extension.

To use decimaljs extension with Node, download the file and then

var BigEval = require('./MikeMcl-decimal.js');
var b = new BigEval();
console.log(b.exec('-2 + 3'));