http://mathjs.org
Math.js is an extensive math library for JavaScript and Node.js.
It features real and complex numbers, units, matrices, a large set of
mathematical functions, and a flexible expression parser.
Powerful and easy to use.
Features
- Supports numbers, complex numbers, units, strings, arrays, and matrices.
- Contains a large set of built-in functions and constants.
- Contains a flexible expression parser.
- Compatible with JavaScript’s built-in Math library.
- No dependencies. Runs on any JavaScript engine.
- Easily extensible.
Install
Math.js can be installed using npm:
npm install mathjs
Or the latest version of math.js can be downloaded from
mathjs.org:
Load
Node.js
Math.js can be loaded in node.js using require
, and similarly in the browser
using require.js.
var math = require('mathjs');
math.sqrt(-4);
Browser
Math.js can be loaded as a regular javascript file in the browser:
<!DOCTYPE HTML>
<html>
<head>
<script src="math.js" type="text/javascript"></script>
</head>
<body>
<script type="text/javascript">
math.sqrt(-4);
</script>
</body>
</html>
Use
Math.js can be used similar to Javascript's built-in Math library.
var math = require('mathjs');
var a = math.sin(math.pi / 4);
var b = math.pow(a, 2);
var c = math.complex(3, -4);
math.sqrt(c);
math.sqrt(-4);
var f = math.unit(60, 'deg');
var g = math.cos(f);
Parser
Math.js contains a flexible and easy to use expression parser.
The parser supports all data types, methods and constants available in math.js.
It has a method eval
to evaluate expressions,
and parse
to parse expressions and build a node tree from it.
The parser supports variable and function definitions.
Variables and functions can be manipulated using the methods get
and set
.
The following example code shows how to create and use a parser.
var math = require('mathjs');
var parser = math.parser();
var a = parser.eval('sqrt(3^2 + 4^2)');
var b = parser.eval('sqrt(-4)');
var c = parser.eval('2 inch in cm');
var d = parser.eval('cos(45 deg)');
parser.eval('x = 7 / 2');
parser.eval('x + 3');
parser.eval('function f(x, y) = x^y');
parser.eval('f(2, 3)');
var x = parser.get('x');
var f = parser.get('f');
var g = f(3, 3);
parser.set('h', 500);
parser.eval('h / 2');
parser.set('hello', function (name) {
return 'hello, ' + name + '!';
});
parser.eval('hello("user")');
parser.clear();
Available methods:
var result = parser.eval(expr); // evaluate an expression
var value = parser.get(name); // retrieve a variable from the parser
parser.set(name, value); // set a variable in the parser
var node = parser.parse(expr); // parse an expression into a node tree
var result = node.eval(); // evaluate a node
Workspace
Math.js features a workspace, which manages a set of expressions.
Expressions can be added, replace, deleted, and inserted in the workspace.
The workspace keeps track on the dependencies between the expressions,
and automatically updates results of depending expressions when variables
or function definitions are changed in the workspace.
var math = require('mathjs');
var workspace = math.workspace();
var id0 = workspace.append('a = 3/4');
var id1 = workspace.append('a + 2');
workspace.getResult(id1);
workspace.replace('a=5/2', id0);
workspace.getResult(id1);
Available methods:
var id = workspace.append(expr);
var id = workspace.insertBefore(expr, beforeId);
var id = workspace.insertAfter(expr, afterId);
workspace.replace(expr, id);
workspace.remove(id);
workspace.clear();
var expr = workspace.getExpr(id);
var result = workspace.getResult(id);
var deps = workspace.getDependencies(id);
var changes = workspace.getChanges(updateSeq);
Data types
Math.js supports both native data types like Number, String, and Array,
as well as advanced data types like Complex and Unit.
Number
The built-in type Number can be used in all methods.
math.subtract(7.1, 2.3);
math.round(math.pi, 3);
math.sqrt(new Number(4.41e2));
String
The built-in type String can be used in applicable methods.
math.add('hello ', 'world');
math.max('A', 'D', 'C');
Complex
Math.js supports complex numbers.
var a = math.complex(2, 3);
var b = math.complex('4 - 2i');
math.add(a, b);
math.sqrt(-4);
Unit
Math.js supports units.
var a = math.unit(55, 'cm');
var b = math.unit('0.1m');
math.add(a, b);
var parser = math.parser();
parser.eval('2 inch in cm');
Array and Matrix
Math.js supports n-dimensional arrays and matrices. Both regular JavaScript
Array
and the math.js Matrix
can be used interchangeably in all math.js
functions.
A Matrix
is an object wrapped around a regular JavaScript Array, providing
utility methods for easy matrix manipulation such as get
, set
, size
,
resize
, clone
, and more.
var matrix = math.matrix([1, 4, 9, 16, 25]);
math.sqrt(matrix);
var array = [1, 2, 3, 4, 5];
math.factorial(array);
var a = [[1, 2], [3, 4]];
var b = math.matrix([[5, 6], [1, 1]]);
b.set([2, [1, 2]], [[7, 8]]);
var c = math.multiply(a, b);
var d = c.get([2, 1]);
Matrices are supported by the parser:
parser = math.parser();
parser.eval('a = [1, 2; 3, 4]');
parser.eval('b = [5, 6; 7, 8]');
parser.eval('b(2, 1:2) = [7, 8]');
parser.eval('c = a * b');
parser.eval('d = c(2, 1)');
Range
A Range
creates a range with a start, end, and optionally a step.
A Range
can be used to create indexes to get or set submatrices.
var math = require('math.js'),
parser = math.parser();
math.factorial(math.range(1,5));
var a = math.matrix();
a.set([math.range('2:5')], [7, 2, 1, 5]);
var b = math.range(2, -1, -2);
var c = b.valueOf();
var d = parser.eval('3:7');
Constants
Math.js has the following built-in constants.
- math.E, math.e
- math.I, math.i
- math.LN2
- math.LN10
- math.LOG2E
- math.LOG10E
- math.PI, math.pi
- math.SQRT1_2
- math.SQRT2
Methods
Math.js contains the following methods. The methods support all available data
types (Number, Complex, Unit, String, and Array) where applicable.
Arithmetic
- math.abs(x)
- math.add(x, y)
- math.ceil(x)
- math.cube(x)
- math.divide(x, y)
- math.equal(x)
- math.exp(x)
- math.fix(x)
- math.floor(x)
- math.larger(x, y)
- math.largereq(x, y)
- math.log(x [, base])
- math.log10(x)
- math.mod(x, y)
- math.multiply(x, y)
- math.pow(x, y)
- math.round(x [, n])
- math.sign()
- math.smaller(x, y)
- math.smallereq(x, y)
- math.subtract(x, y)
- math.sqrt(x)
- math.square(x)
- math.unaryminus(x)
- math.unequal(x)
Complex
- math.re(x)
- math.im(x)
- math.arg(x)
- math.conj(x)
Matrix
- math.concat(a, b, c, ... [, dim])
- math.det(x)
- math.diag(x)
- math.eye(m, n, p, ...)
- math.inv(x)
- math.ones(m, n, p, ...)
- math.size(x)
- math.squeeze(x)
- math.transpose(x)
- math.zeros(m, n, p, ...)
Probability
- math.factorial(x)
- math.random()
Statistics
- math.max(a, b, c, ...)
- math.min(a, b, c, ...)
Trigonometry
- math.acos(x)
- math.asin(x)
- math.atan(x)
- math.atan2(y, x)
- math.cos(x)
- math.cot(x)
- math.csc(x)
- math.sec(x)
- math.sin(x)
- math.tan(x)
Units
Utils
- math.clone(x)
- math.format([template, ] values)
- math.help(fn)
- math.import(filename | object, override)
- math.typeof(x)
Extend
The library can easily be extended with functions and variables using the
import
method. The method import
accepts a filename or an object with
functions and variables.
var math = require('mathjs');
math.import({
myvalue: 42,
hello: function (name) {
return 'hello, ' + name + '!';
});
});
math.myvalue * 2;
math.hello('user');
var parser = math.parser();
parser.eval('myvalue + 10');
parser.eval('hello("user")');
To import functions from a math library like
numbers.js,
the library must be installed using npm:
npm install numbers
And next, the library can be imported into math.js:
var math = require('mathjs'),
parser = math.parser();
math.import('numbers');
math.fibonacci(7);
parser.eval('fibonacci(7)');
Build
First clone the project from github:
git clone git://github.com/josdejong/mathjs.git
The project uses jake as build tool.
To be able to run jake from the command line, jake must be installed globally:
sudo npm install -g jake
Then, the project can be build by executing jake in the root of the project:
cd mathjs
jake
This will build the library math.js and math.min.js from the source files and
execute tests.
Alternatively, when jake is not installed on your system, the project can be
build by running npm install
in the root of the project. npm will then
use a local installation of jake to build the project.
Test
To execute tests for the library, run:
npm test
Roadmap
- Version 0.1.0 (2013-02-18)
- Implement all methods and constants available in the built-in Math library
- Implement data types Complex and Unit
- Version 0.2.0 (2013-02-25)
- Implement Parser, Scope, Node tree
- Implement more methods
- Version 0.3.0 (2013-03-09)
- Implement Workspace
- Implement more methods
- Build a website (2013-03-11)
- Version 0.4.0 (2013-03-16)
- Version 0.5.0 (2013-04-06)
- Implement Matrix and Range
- Version 0.6.0
- Version 1.0.0
- Extensive testing
- Examples and documentation
License
Copyright (C) 2013 Jos de Jong wjosdejong@gmail.com
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.