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.
- Is compatible with JavaScript’s built-in Math library.
- Contains a flexible expression parser.
- Supports chained operations.
- Comes with a large set of built-in functions and constants.
- Has no dependencies. Runs on any JavaScript engine.
- Is easily extensible.
Install
Math.js can be installed using npm:
npm install mathjs
Or using bower:
bower install mathjs
Or by downloading the latest version from
mathjs.org:
Load
Node.js
Load math.js in node.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>
Require.js
Load math.js in the browser using require.js:
require.config({
paths: {
mathjs: 'path/to/mathjs',
}
});
require(['mathjs'], function (math) {
math.sqrt(-4);
});
Use
Math.js can be used similar to JavaScript's built-in Math library. Besides that,
math.js can evaluate expressions (see Expressions) and supports
chained operations (see Chained operations).
The example code below shows how to use math.js. More examples can be found in the
examples directory.
var math = require('mathjs');
math.round(math.e, 3);
math.atan2(3, -3) / math.pi;
math.log(1000, 10);
math.sqrt(-4);
math.pow([[-1, 2], [3, 1]], 2);
math.eval('1.2 / (2.3 + 0.7)');
math.eval('5.08 cm in inch');
math.eval('sin(45 deg) ^ 2');
math.eval('9 / 3 + 2i');
math.eval('det([-1, 2; 3, 1])');
math.select(3)
.add(4)
.multiply(2)
.done();
Expressions
Math.js contains a flexible and easy to use expression parser.
The parser supports all data types, methods and constants available in math.js.
Expressions can be evaluated in two ways:
- Using the function
math.eval
, which uses a read-only parser. - Using a more flexible parser.
Eval
Math.js comes with a function math.eval
to evaluate expressions.
The function eval
does support all functions, variables, and data types
available in math.js. Internally, the function eval
uses a read-only parser.
The following code demonstrates how to evaluate expressions.
var math = require('mathjs');
var a = math.eval('sqrt(3^2 + 4^2)');
var b = math.eval('sqrt(-4)');
var c = math.eval('2 inch in cm');
var d = math.eval('cos(45 deg)');
Parser
The parser of math.js supports all functions, variables, and data types
available in math.js. Additionally, it supports variable and function
assignments. A parser can be created by:
var parser = math.parser();
The parser contains the following methods:
eval(expr)
Evaluate an expression.get(name)
Retrieve a variable or function from the parsers scope.set(name, value)
Set a variable or function in the parsers scope.parse(expr)
Parse an expression into a node tree.
A node can be evaluated as node.eval()
.
The following 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();
Chained operations
Math.js supports chaining operations by wrapping a value into a Selector
.
A selector can be created with the function math.select(value)
.
All methods available in the math namespace can be executed via the selector.
The methods will be executed with the selectors value as first argument,
followed by extra arguments provided by the function call itself.
math.select(3)
.add(4)
.subtract(2)
.done();
math.select( [[1, 2], [3, 4]] )
.set([1, 1], 8)
.multiply(3)
.done();
The Selector has a number of special functions:
done()
Finalize the chained operation and return the selectors value.valueOf()
The same as done()
, returns the selectors value.toString()
Executes math.format(value)
onto the selectors value, returning
a string representation of the value.get(index)
Get a subselection of the selectors value. Only applicable when
the value has a function get, for example when value is a Matrix
or Array.set(index, replacement)
Replace a subselection of the selectors value. Only applicable
when the value has a function get, for example when value is a
Matrix or Array.
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. Most methods can be executed with complex
numbers as arguments.
var a = math.complex(2, 3);
a.re;
a.im;
var b = math.complex('4 - 2i');
math.add(a, b);
math.sqrt(-4);
Unit
Math.js supports units. Basic operations add
, subtract
, multiply
,
and divide
can be performed on units.
Trigonometric methods like sin
support units with an angle as argument.
Units can be converted from one to another using method in
,
an the value of a unit can be retrieved using toNumber
.
var a = math.unit(55, 'cm');
var b = math.unit('0.1m');
math.add(a, b);
b.in('cm');
b.toNumber('cm');
var parser = math.parser();
parser.eval('2 inch in cm');
parser.eval('cos(45 deg)');
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.gcd(a, b, c, ...)
- math.larger(x, y)
- math.largereq(x, y)
- math.lcm(a, b, c, ...)
- 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)
- math.xgcd(a, b)
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.eval(expr)
- math.format([template, ] values)
- math.import(filename | object, override)
- math.select([x])
- 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
- Before version 1.0.0:
- More on matrices
- Examples and documentation
- Extensive testing
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.