josdejong / mathjs

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. Features • Supports numbers, bignumbers, bigints, complex numbers, fractions, units, strings, arrays, and matrices. • Is compatible with JavaScript's built-in Math library. • Contains a flexible expression parser. • Does symbolic computation. • Comes with a large set of built-in functions and constants. • Can be used as a command line application as well. • Runs on any JavaScript engine. • Is easily extensible. • Open source. 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. 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 • Getting Started • Examples • Overview • History Build 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. Develop When developing new features for mathjs, it is good to be aware of the following background information. Code The code of is written in ES modules, and requires all files to have a real, relative path, meaning the files must have a 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 with a number or a , 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: • **Typed functions**. All functions are created using . 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 s, you can extend it with support for multiplying your own data type, say . If you define a conversion from to , the typed-function will automatically allow you to multiply a with a . • **Dependency injection**. When we have a function with support for , thanks to the dependency injection, other functions using under the hood, like , will automatically support too. This also works the other way around: if you don't need the heavyweight (which supports BigNumbers, matrices, etc), and you just need a plain and simple number support, you can use a lightweight implementation of just for numbers, and inject that in and other functions. At the lowest level, mathjs has immutable factory functions which create immutable functions. The core function 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 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: • Implement the function in the right category, for example , where you can replace with the proper category, and with the name of the new function. Add the new function to the index files and possibly . • Write documentation on the function in the source code comment of . This documentation is used to auto generate documentation on the website. It should include a History section with one line, indicating the upcoming version number in which the function will be created. • Write embedded documentation for the new function in . Add the new documentation to the index file . • Write unit tests for the function in . • Write the necessary TypeScript definitions for the new function in , and write tests for it in . This is described in ./types/EXPLANATION.md -- make sure to read that page, as Typescript definitions must be added in _multiple_ places in the code. • Ensure the code style is ok by running (run to fix the code style automatically). Build scripts The build script currently generates two types of output: • **any**, generate entry points to create full versions of all functions • **number**: generating and entry points to create lightweight functions just supporting 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 you can do . 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 and 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 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 res…