An extensive math library for JavaScript and Node.js
Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types like numbers, big numbers, complex numbers, fractions, units, and matrices. Powerful and easy to use.
Math.js can be used in both node.js and in the browser.
Install math.js using npm:
npm install mathjs
Note that when using mathjs in a TypeScript project, you will have to install type definition files too:
npm install @types/mathjs.
Or download mathjs via one of the CDN's listed on the downloads page:
https://mathjs.org/download.html
Math.js can be used similar to JavaScript's built-in Math library. Besides that, math.js can evaluate expressions and supports chained operations.
import { atan2, chain, derivative, e, evaluate, log, pi, pow, round, sqrt } from 'mathjs'// functions and constants round(e, 3) // 2.718 atan2(3, -3) / pi // 0.75 log(10000, 10) // 4 sqrt(-4) // 2i pow([[-1, 2], [3, 1]], 2) // [[7, 0], [0, 7]] derivative('x^2 + x', 'x') // 2 * x + 1
// expressions evaluate('12 / (2.3 + 0.7)') // 4 evaluate('12.7 cm to inch') // 5 inch evaluate('sin(45 deg) ^ 2') // 0.5 evaluate('9 / 3 + 2i') // 3 + 2i evaluate('det([-1, 2; 3, 1])') // -7
// chaining chain(3) .add(4) .multiply(2) .done() // 14
See the Getting Started for a more detailed tutorial.
Math.js works on any ES5 compatible JavaScript engine: node.js, Chrome, Firefox, Safari, Edge, and IE11.
First clone the project from github:
git clone git://github.com/josdejong/mathjs.git cd mathjs
Install the project dependencies:
npm install
Then, the project can be build by executing the build script via npm:
npm run build
This will build ESM output, CommonJS output, and the bundle math.js from the source files and put them in the folder lib.
When developing new features for mathjs, it is good to be aware of the following background information.
The code of
mathjsis written in ES modules, and requires all files to have a real, relative path, meaning the files must have a
*.jsextension. Please configure adding file extensions on auto import in your IDE.
What mathjs tries to achieve is to offer an environment where you can do calculations with mixed data types, like multiplying a regular
numberwith a
Complexnumber or a
BigNumber, and work with all of those in matrices. Mathjs also allows to add a new data type, like say
BigInt, with little effort.
The solution that mathjs uses has two main ingredients:
Typed functions. All functions are created using
typed-function. This makes it easier to (dynamically) create and extend a single function with new data types, automatically do type conversions on function inputs, etc. So, if you create function multiply for two
numbers, you can extend it with support for multiplying two
BigInts. If you define a conversion from
BigIntto
number, the typed-function will automatically allow you to multiply a
BigIntwith a
number.
Dependency injection. When we have a function
multiplywith support for
BigInt, thanks to the dependency injection, other functions using
multiplyunder the hood, like
prod, will automatically support
BigInttoo. This also works the other way around: if you don't need the heavyweight
multiply(which supports BigNumbers, matrices, etc), and you just need a plain and simple number support, you can use a lightweight implementation of
multiplyjust for numbers, and inject that in
prodand other functions.
At the lowest level, mathjs has immutable factory functions which create immutable functions. The core function
math.create(...)creates a new instance having functions created from all passed factory functions. A mathjs instance is a collection of created functions. It contains a function like
math.importto allow extending the instance with new functions, which can then be used in the expression parser.
The build script currently generates two types of output:
number
For each function, an object is generated containing the factory functions of all dependencies of the function. This allows to just load a specific set of functions, and not load or bundle any other functionality. So for example, to just create function
addyou can do
math.create(addDependencies).
To execute tests for the library, install the project dependencies once:
npm install
Then, the tests can be executed:
npm test
Additionally, the tests can be run on FireFox using headless mode:
npm run test:browser
To run the tests remotely on BrowserStack, first set the environment variables
BROWSER_STACK_USERNAMEand
BROWSER_STACK_ACCESS_KEYwith your username and access key and then execute:
npm run test:browserstack
To test code coverage of the tests:
npm run coverage
To see the coverage results, open the generated report in your browser:
./coverage/lcov-report/index.html
Continuous integration tests are run on Github Actions and BrowserStack every time a commit is pushed to github. Github Actions runs the tests for different versions of node.js, and BrowserStack runs the tests are run on all major browsers.
Thanks Github Actions and BrowserStack for the generous free hosting of this open source project!
Copyright (C) 2013-2021 Jos de Jong [email protected]
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
https://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.