mathjs README

The project's README from github.com/josdejong/mathjs. As one markdown file: README.md.

math.js

https://mathjs.org

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.

Version Downloads Build Status Maintenance License FOSSA Status Codecov Github Sponsor

Features

Usage

Math.js can be used in both node.js and in the browser.

Install math.js using npm:

npm install 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.

Browser support

Math.js works on any ES2020 compatible JavaScript engine, including node.js, Chrome, Firefox, Safari, and Edge.

Documentation

Build

First clone the project from github:

git clone [email protected]: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.

Develop

When developing new features for mathjs, it is good to be aware of the following background information.

Code

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.

Architecture

What mathjs tries to achieve is to offer an environment where you can do calculations with mixed data types, like multiplying a regular number with a Complex number or a BigNumber, and work with all of those in matrices. Mathjs also allows to add a new data type with little effort.

The solution that mathjs uses has two main ingredients:

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.

Implementing a new function

A common case is to implement a new function. This involves the following steps:

Build scripts

The build script currently generates two types of output:

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).

Test

To execute tests for the library, install the project dependencies once:

npm install

Then, the tests can be executed:

npm test

To test the type definitions:

npm run test:types

Additionally, the tests can be run on FireFox using headless mode:

npm run test:browser

To run the tests remotely on LambdaTest, first set the environment variables LT_USERNAME and LT_ACCESS_KEY with your username and access key and then execute:

npm run test:lambdatest

You can separately run the code linter, though it is also executed with npm test:

npm run lint

To automatically fix linting issue, run:

npm run format

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 testing

Continuous integration tests are run on GitHub Actions and TestMu AI (formerly LambdaTest) every time a commit is pushed to GitHub. GitHub Actions runs the tests for different versions of node.js, and TestMu AI runs the tests on all major browsers.

TestMu AI

Thanks, GitHub Actions and TestMu AI for the generous free hosting of this open source project!

License

mathjs is published under the Apache 2.0 license:

Copyright (C) 2013-2026 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.

mathjs contains a JavaScript port of the CSparse library, published under the LGPL-2.1+ license:

CSparse: a Concise Sparse matrix package.
Copyright (c) 2006, Timothy A. Davis.
http://www.suitesparse.com

--------------------------------------------------------------------------------

CSparse is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

CSparse is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this Module; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

mathjs (josdejong/mathjs)

Searching Database…

15.1K ·GitHub
这是什么?一个功能丰富的 JavaScript 和 Node.js 数学库:自带灵活的表达式解析器,支持符号计算,内置大量函数和常量,并支持普通数字、大数、复数、分数、单位和矩阵。
它是我导入到代码里用的库,还是单独运行的程序?它是一个在 node.js 或浏览器里使用的库——也可以作为命令行工具单独运行。
怎么把它加到我的项目里?运行 npm install mathjs,或者从下载页面列出的某个 CDN 获取。服务器端需要 Node.js 18 或更高版本。
它在浏览器里也能运行吗,还是只能配合 Node 使用?它可以在任何兼容 ES2020 的 JavaScript 引擎上运行——包括 node.js、Chrome、Firefox、Safari 和 Edge。
我在商业项目里可以免费使用吗?可以——它是 Apache 2.0 开源协议。有一点要注意:它内置了 CSparse 库的一个 JavaScript 移植版,那部分采用 LGPL-2.1+ 协议。
在同一次计算里,我可以把普通数字和 Complex、BigNumber 混着用吗?可以——这正是它明确的设计目标之一。函数会自动对输入做类型转换,所以你可以把普通数字和 Complex 或 BigNumber 相乘,也可以在矩阵里同时使用这些类型。
我可以添加自己的函数或数据类型吗?可以,它的扩展性很好。math.import 可以添加表达式解析器能使用的新函数;而且由于这些函数建立在 typed-function 之上,给 multiply 扩展你自己的类型后,prod 这类依赖它的函数也会自动支持该类型。
如果我只需要普通数字的数学运算,有没有更轻量的选择?有。构建产物会生成 'any'(完整版)和 'number'(仅普通数字)两个入口,你还可以只加载某个函数及其依赖,例如 math.create(addDependencies),而不必打包整个库。
它提供 TypeScript 类型定义吗?提供——TypeScript 类型定义在 types/index.d.ts 里,并且通过 npm run test:types 有独立的类型测试。
Creator
josdejong
Size
99.8 MB
Stars
15.1K
Updated
CommitAug 10
Age
13y
Commits · 90 Days