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/2023.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 | [![Codecov](https://codecov.io/gh/josdejong/mathjs/branch/develop/graph/badge.svg)](https://codecov.io/gh/josdejong/mathjs)
|
14 | [![Foresight](https://api-public.service.runforesight.com/api/v1/badge/test?repoId=13cb22bf-6cd5-4c4b-a9de-46081ac63ffb)](https://mathjs.app.runforesight.com/)
|
15 | [![Github Sponsor](https://camo.githubusercontent.com/7d9333b097b2f54a8957d126ab82937811489c9b75c3850f609985cf94cd29fe/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2532302d53706f6e736f722532306d652532306f6e2532304769744875622d6f72616e6765)](https://github.com/sponsors/josdejong)
|
16 |
|
17 | ## Sponsors
|
18 |
|
19 | <table width="100%">
|
20 | <tr>
|
21 | <td>
|
22 | <img width="1000" height="0">
|
23 | <a href="https://www.runforesight.com/?utm_source=mathjs&utm_medium=sponsorship">
|
24 | <img src="https://www.thundra.io/hubfs/RunForesight/GitHub%20Sponsorship%20banners/power-up-github.png"
|
25 | alt="Foresight" width="260" align="right">
|
26 | </a>
|
27 |
|
28 | <h3>Foresight: Increase CI/CD Health & Test Performance</h3>
|
29 |
|
30 | <p>
|
31 | Foresight provides full visibility and deep insights into the health
|
32 | and performance of your tests and CI pipelines. Assess the risk of
|
33 | changes, resolve bottlenecks, reduce build times, and deliver
|
34 | high-quality software at speed with Foresight.
|
35 | </p>
|
36 |
|
37 | [Sign up now!](https://runforesight.com/?utm_source=mathjs&utm_medium=sponsorship)
|
38 | </td>
|
39 | </tr>
|
40 | </table>
|
41 |
|
42 | ## Features
|
43 |
|
44 | - Supports numbers, big numbers, complex numbers, fractions, units, strings, arrays, and matrices.
|
45 | - Is compatible with JavaScript's built-in Math library.
|
46 | - Contains a flexible expression parser.
|
47 | - Does symbolic computation.
|
48 | - Comes with a large set of built-in functions and constants.
|
49 | - Can be used as a command line application as well.
|
50 | - Runs on any JavaScript engine.
|
51 | - Is easily extensible.
|
52 | - Open source.
|
53 |
|
54 | ## Usage
|
55 |
|
56 | Math.js can be used in both node.js and in the browser.
|
57 |
|
58 | Install math.js using [npm](https://www.npmjs.com/package/mathjs):
|
59 |
|
60 | npm install mathjs
|
61 |
|
62 | Or download mathjs via one of the CDN's listed on the downloads page:
|
63 |
|
64 | [https://mathjs.org/download.html](https://mathjs.org/download.html#download)
|
65 |
|
66 | Math.js can be used similar to JavaScript's built-in Math library. Besides that,
|
67 | math.js can evaluate
|
68 | [expressions](https://mathjs.org/docs/expressions/index.html)
|
69 | and supports
|
70 | [chained operations](https://mathjs.org/docs/core/chaining.html).
|
71 |
|
72 | ```js
|
73 | import {
|
74 | atan2, chain, derivative, e, evaluate, log, pi, pow, round, sqrt
|
75 | } from 'mathjs'
|
76 |
|
77 | // functions and constants
|
78 | round(e, 3) // 2.718
|
79 | atan2(3, -3) / pi // 0.75
|
80 | log(10000, 10) // 4
|
81 | sqrt(-4) // 2i
|
82 | pow([[-1, 2], [3, 1]], 2) // [[7, 0], [0, 7]]
|
83 | derivative('x^2 + x', 'x') // 2 * x + 1
|
84 |
|
85 | // expressions
|
86 | evaluate('12 / (2.3 + 0.7)') // 4
|
87 | evaluate('12.7 cm to inch') // 5 inch
|
88 | evaluate('sin(45 deg) ^ 2') // 0.5
|
89 | evaluate('9 / 3 + 2i') // 3 + 2i
|
90 | evaluate('det([-1, 2; 3, 1])') // -7
|
91 |
|
92 | // chaining
|
93 | chain(3)
|
94 | .add(4)
|
95 | .multiply(2)
|
96 | .done() // 14
|
97 | ```
|
98 |
|
99 | See the [Getting Started](https://mathjs.org/docs/getting_started.html) for a more detailed tutorial.
|
100 |
|
101 |
|
102 | ## Browser support
|
103 |
|
104 | Math.js works on any ES6 compatible JavaScript engine, including node.js, Chrome, Firefox, Safari, and Edge.
|
105 |
|
106 |
|
107 | ## Documentation
|
108 |
|
109 | - [Getting Started](https://mathjs.org/docs/getting_started.html)
|
110 | - [Examples](https://mathjs.org/examples/index.html)
|
111 | - [Overview](https://mathjs.org/docs/index.html)
|
112 | - [History](https://mathjs.org/history.html)
|
113 |
|
114 |
|
115 | ## Build
|
116 |
|
117 | First clone the project from github:
|
118 |
|
119 | git clone git@github.com:josdejong/mathjs.git
|
120 | cd mathjs
|
121 |
|
122 | Install the project dependencies:
|
123 |
|
124 | npm install
|
125 |
|
126 | Then, the project can be build by executing the build script via npm:
|
127 |
|
128 | npm run build
|
129 |
|
130 | This will build ESM output, CommonJS output, and the bundle math.js
|
131 | from the source files and put them in the folder lib.
|
132 |
|
133 |
|
134 | ## Develop
|
135 |
|
136 | When developing new features for mathjs, it is good to be aware of the following background information.
|
137 |
|
138 | ### Code
|
139 |
|
140 | 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.
|
141 |
|
142 | ### Architecture
|
143 |
|
144 | What mathjs tries to achieve is to offer an environment where you can do calculations with mixed data types,
|
145 | like multiplying a regular `number` with a `Complex` number or a `BigNumber`, and work with all of those in matrices.
|
146 | Mathjs also allows to add a new data type, like say `BigInt`, with little effort.
|
147 |
|
148 | The solution that mathjs uses has two main ingredients:
|
149 |
|
150 | - **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`.
|
151 |
|
152 | - **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.
|
153 |
|
154 | 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.
|
155 |
|
156 | ### Implementing a new function
|
157 |
|
158 | A common case is to implement a new function. This involves the following steps:
|
159 |
|
160 | - Implement the function in the right category, for example `./src/function/arithmetic/myNewFunction.js`, where you can replace `arithmetic` with the proper category, and `myNewFunction` with the name of the new function. Add the new function to the index files `./src/factoriesAny.js` and possibly `./src/factoriesNumber.js`.
|
161 | - Write documentation on the function in the source code comment of `myNewFunction.js`. This documentation is used to auto generate documentation on the website.
|
162 | - Write embedded documentation for the new function in `./src/expression/embeddedDocs/function/arithmetic/myNewFunction.js`. Add the new documentation to the index file `./src/expression/embeddedDocs/embeddedDocs.js`.
|
163 | - Write unit tests for the function in `./test/unit-tests/function/arithmetic/myNewFunction.test.js`.
|
164 | - Write a TypeScript definition for the new function in `./types/index.d.ts`, and write tests for it in `./types/index.ts`. Normally, two definitions need to be added: one for the static function `math.myNewFunction(...)` and one for the chained API `math.chain(...).myNewFunction(...)`.
|
165 | - Ensure the code style is ok by running `npm run lint` (run `npm run format` to fix the code style automatically).
|
166 |
|
167 |
|
168 | ### Build scripts
|
169 |
|
170 | The build script currently generates two types of output:
|
171 |
|
172 | - **any**, generate entry points to create full versions of all functions
|
173 | - **number**: generating and entry points to create lightweight functions just supporting `number`
|
174 |
|
175 | 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)`.
|
176 |
|
177 |
|
178 | ## Test
|
179 |
|
180 | To execute tests for the library, install the project dependencies once:
|
181 |
|
182 | npm install
|
183 |
|
184 | Then, the tests can be executed:
|
185 |
|
186 | npm test
|
187 |
|
188 | Additionally, the tests can be run on FireFox using [headless mode](https://developer.mozilla.org/en-US/Firefox/Headless_mode):
|
189 |
|
190 | npm run test:browser
|
191 |
|
192 | 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:
|
193 |
|
194 | npm run test:browserstack
|
195 |
|
196 | You can separately run the code linter, though it is also executed with `npm test`:
|
197 |
|
198 | npm run lint
|
199 |
|
200 | To automatically fix linting issue, run:
|
201 |
|
202 | npm run format
|
203 |
|
204 | To test code coverage of the tests:
|
205 |
|
206 | npm run coverage
|
207 |
|
208 | To see the coverage results, open the generated report in your browser:
|
209 |
|
210 | ./coverage/lcov-report/index.html
|
211 |
|
212 |
|
213 | ### Continuous integration testing
|
214 |
|
215 | 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 on all major browsers.
|
216 |
|
217 | [![BrowserStack](https://raw.github.com/josdejong/mathjs/master/misc/browserstack.png)](https://www.browserstack.com)
|
218 |
|
219 | Thanks Github Actions and BrowserStack for the generous free hosting of this open source project!
|
220 |
|
221 | ## License
|
222 |
|
223 | Copyright (C) 2013-2023 Jos de Jong <wjosdejong@gmail.com>
|
224 |
|
225 | Licensed under the Apache License, Version 2.0 (the "License");
|
226 | you may not use this file except in compliance with the License.
|
227 | You may obtain a copy of the License at
|
228 |
|
229 | https://www.apache.org/licenses/LICENSE-2.0
|
230 |
|
231 | Unless required by applicable law or agreed to in writing, software
|
232 | distributed under the License is distributed on an "AS IS" BASIS,
|
233 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
234 | See the License for the specific language governing permissions and
|
235 | limitations under the License.
|