1 | ![math.js](https://raw.github.com/josdejong/mathjs/master/misc/img/mathjs.png)
|
2 |
|
3 | [https://mathjs.org](https://mathjs.org)
|
4 |
|
5 | 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.
|
6 |
|
7 | [![Version](https://img.shields.io/npm/v/mathjs.svg)](https://www.npmjs.com/package/mathjs)
|
8 | [![Downloads](https://img.shields.io/npm/dm/mathjs.svg)](https://www.npmjs.com/package/mathjs)
|
9 | [![Build Status](https://github.com/josdejong/mathjs/workflows/Node.js%20CI/badge.svg)](https://github.com/josdejong/mathjs/actions)
|
10 | [![Maintenance](https://img.shields.io/maintenance/yes/2021.svg)](https://github.com/josdejong/mathjs/graphs/commit-activity)
|
11 | [![License](https://img.shields.io/github/license/josdejong/mathjs.svg)](https://github.com/josdejong/mathjs/blob/master/LICENSE)
|
12 | [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjosdejong%2Fmathjs.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjosdejong%2Fmathjs?ref=badge_shield)
|
13 | [![Slack](https://slack.bri.im/badge.svg)](https://slack.bri.im)
|
14 |
|
15 | ## Features
|
16 |
|
17 | - Supports numbers, big numbers, complex numbers, fractions, units, strings, arrays, and matrices.
|
18 | - Is compatible with JavaScript's built-in Math library.
|
19 | - Contains a flexible expression parser.
|
20 | - Does symbolic computation.
|
21 | - Comes with a large set of built-in functions and constants.
|
22 | - Can be used as a command line application as well.
|
23 | - Runs on any JavaScript engine.
|
24 | - Is easily extensible.
|
25 | - Open source.
|
26 |
|
27 | ## Usage
|
28 |
|
29 | Math.js can be used in both node.js and in the browser.
|
30 |
|
31 | Install math.js using [npm](https://www.npmjs.com/package/mathjs):
|
32 |
|
33 | npm install mathjs
|
34 |
|
35 | > Note that when using mathjs in a TypeScript project, you will have to install type definition files too: `npm install @types/mathjs`.
|
36 |
|
37 | Or download mathjs via one of the CDN's listed on the downloads page:
|
38 |
|
39 | [https://mathjs.org/download.html](https://mathjs.org/download.html#download)
|
40 |
|
41 | Math.js can be used similar to JavaScript's built-in Math library. Besides that,
|
42 | math.js can evaluate
|
43 | [expressions](https://mathjs.org/docs/expressions/index.html)
|
44 | and supports
|
45 | [chained operations](https://mathjs.org/docs/core/chaining.html).
|
46 |
|
47 | ```js
|
48 | import {
|
49 | atan2, chain, derivative, e, evaluate, log, pi, pow, round, sqrt
|
50 | } from 'mathjs'
|
51 |
|
52 | // functions and constants
|
53 | round(e, 3) // 2.718
|
54 | atan2(3, -3) / pi // 0.75
|
55 | log(10000, 10) // 4
|
56 | sqrt(-4) // 2i
|
57 | pow([[-1, 2], [3, 1]], 2) // [[7, 0], [0, 7]]
|
58 | derivative('x^2 + x', 'x') // 2 * x + 1
|
59 |
|
60 | // expressions
|
61 | evaluate('12 / (2.3 + 0.7)') // 4
|
62 | evaluate('12.7 cm to inch') // 5 inch
|
63 | evaluate('sin(45 deg) ^ 2') // 0.5
|
64 | evaluate('9 / 3 + 2i') // 3 + 2i
|
65 | evaluate('det([-1, 2; 3, 1])') // -7
|
66 |
|
67 | // chaining
|
68 | chain(3)
|
69 | .add(4)
|
70 | .multiply(2)
|
71 | .done() // 14
|
72 | ```
|
73 |
|
74 | See the [Getting Started](https://mathjs.org/docs/getting_started.html) for a more detailed tutorial.
|
75 |
|
76 |
|
77 | ## Browser support
|
78 |
|
79 | Math.js works on any ES5 compatible JavaScript engine: node.js, Chrome, Firefox, Safari, Edge, and IE11.
|
80 |
|
81 |
|
82 | ## Documentation
|
83 |
|
84 | - [Getting Started](https://mathjs.org/docs/getting_started.html)
|
85 | - [Examples](https://mathjs.org/examples/index.html)
|
86 | - [Overview](https://mathjs.org/docs/index.html)
|
87 | - [History](https://mathjs.org/history.html)
|
88 |
|
89 |
|
90 | ## Build
|
91 |
|
92 | First clone the project from github:
|
93 |
|
94 | git clone git://github.com/josdejong/mathjs.git
|
95 | cd mathjs
|
96 |
|
97 | Install the project dependencies:
|
98 |
|
99 | npm install
|
100 |
|
101 | Then, the project can be build by executing the build script via npm:
|
102 |
|
103 | npm run build
|
104 |
|
105 | This will build ESM output, CommonJS output, and the bundle math.js
|
106 | from the source files and put them in the folder lib.
|
107 |
|
108 |
|
109 | ## Develop
|
110 |
|
111 | When developing new features for mathjs, it is good to be aware of the following background information.
|
112 |
|
113 | ### Code
|
114 |
|
115 | The code of `mathjs` is written in ES modules, and requires all files to have a real, relative path, meaning the files must have a `*.js` extension. Please configure adding file extensions on auto import in your IDE.
|
116 |
|
117 | ### Architecture
|
118 |
|
119 | What mathjs tries to achieve is to offer an environment where you can do calculations with mixed data types,
|
120 | like multiplying a regular `number` with a `Complex` number or a `BigNumber`, and work with all of those in matrices.
|
121 | Mathjs also allows to add a new data type, like say `BigInt`, with little effort.
|
122 |
|
123 | The solution that mathjs uses has two main ingredients:
|
124 |
|
125 | - **Typed functions**. All functions are created using [`typed-function`](https://github.com/josdejong/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 `number`s, you can extend it with support for multiplying two `BigInts`. If you define a conversion from `BigInt` to `number`, the typed-function will automatically allow you to multiply a `BigInt` with a `number`.
|
126 |
|
127 | - **Dependency injection**. When we have a function `multiply` with support for `BigInt`, thanks to the dependency injection, other functions using `multiply` under the hood, like `prod`, will automatically support `BigInt` too. 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 `multiply` just for numbers, and inject that in `prod` and other functions.
|
128 |
|
129 | 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.import` to allow extending the instance with new functions, which can then be used in the expression parser.
|
130 |
|
131 | ### Build scripts
|
132 |
|
133 | The build script currently generates two types of output:
|
134 |
|
135 | - **any**, generate entry points to create full versions of all functions
|
136 | - **number**: generating and entry points to create lightweight functions just supporting `number`
|
137 |
|
138 | 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 `add` you can do `math.create(addDependencies)`.
|
139 |
|
140 |
|
141 | ## Test
|
142 |
|
143 | To execute tests for the library, install the project dependencies once:
|
144 |
|
145 | npm install
|
146 |
|
147 | Then, the tests can be executed:
|
148 |
|
149 | npm test
|
150 |
|
151 | Additionally, the tests can be run on FireFox using [headless mode](https://developer.mozilla.org/en-US/Firefox/Headless_mode):
|
152 |
|
153 | npm run test:browser
|
154 |
|
155 | To run the tests remotely on BrowserStack, first set the environment variables `BROWSER_STACK_USERNAME` and `BROWSER_STACK_ACCESS_KEY` with your username and access key and then execute:
|
156 |
|
157 | npm run test:browserstack
|
158 |
|
159 | To test code coverage of the tests:
|
160 |
|
161 | npm run coverage
|
162 |
|
163 | To see the coverage results, open the generated report in your browser:
|
164 |
|
165 | ./coverage/lcov-report/index.html
|
166 |
|
167 |
|
168 | ### Continuous integration testing
|
169 |
|
170 | Continuous integration tests are run on [Github Actions](https://github.com/josdejong/mathjs/actions) and [BrowserStack](https://www.browserstack.com) 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.
|
171 |
|
172 | [![BrowserStack](https://raw.github.com/josdejong/mathjs/master/misc/browserstack.png)](https://www.browserstack.com)
|
173 |
|
174 | Thanks Github Actions and BrowserStack for the generous free hosting of this open source project!
|
175 |
|
176 | ## License
|
177 |
|
178 | Copyright (C) 2013-2021 Jos de Jong <wjosdejong@gmail.com>
|
179 |
|
180 | Licensed under the Apache License, Version 2.0 (the "License");
|
181 | you may not use this file except in compliance with the License.
|
182 | You may obtain a copy of the License at
|
183 |
|
184 | https://www.apache.org/licenses/LICENSE-2.0
|
185 |
|
186 | Unless required by applicable law or agreed to in writing, software
|
187 | distributed under the License is distributed on an "AS IS" BASIS,
|
188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
189 | See the License for the specific language governing permissions and
|
190 | limitations under the License.
|