mathjslab

MathJSLab - mathjslab.com

An interpreter with language syntax like MATLAB®/Octave written in Typescript.

ISBN 978-65-00-82338-7

This package emulates a parser and evaluator for a subset of MATLAB®/Octave language. It is written completely in Typescript.

The project page with a functional demo use of this package in a Web application can be found at mathjslab.com. The repository is in the MathJSLab Organization on GitHub.

It can run in browser environment and implements an arbitrary precision arithmetics using decimal.js package.

It uses the ANTLR parser generator to generate a parser that create an AST (Abstract Syntax Tree) of input.

Other components besides the parser are the evaluator, which computes the inputs, and the MathML unparser, that generates mathematical representations of the inputs and results.

This software is intended for educational purposes, to provide teachers and students with a computer aided calculation tool that is capable of running in a browser environment. So it can be easily adapted to be used on different devices and environments.

All MathJSLab interpreter operations, functions and commands are documented in the demo Web application's command help NAME. Its in english, portuguese and spanish. It can also be accessed directly from the demo Web application repository. Additional documentation, beyond the operations, functions and commands, is available in the demo Web application doc directory.

Features

• Runs on any JavaScript engine.
• Improved demo Web application at project page: mathjslab.com (repository).
• Comes with a large set of built-in operations, functions and commands well documented in the demo Web application in english, portuguese and spanish.
• Is easily extensible through configuration parameters passed to Evaluator constructor.
• Open source software with fully documented code: MIT License.
• Includes test suite using Jest framework.
• Software with assigned ISBN and DOI, so that it can be used in academic work and research, being referenced appropriately. Any inclusion of authors will result in an update of the ISBN records.

Browser support

MathJSLab works on any ES2015 compatible JavaScript engine, including Node.js®, Chrome, Firefox, Safari, Opera, and Edge.

Installation

Install the mathjslab package:

npm install mathjslab

Usage

The basic API is an instantiation of Evaluator class with optional configuration.

Import MathJSLab API:

import { Evaluator, TEvaluatorConfig } from 'mathjslab';

Instantiate the Evaluator class with:

let evaluator: Evaluator = new Evaluator(EvaluatorConfiguration);

Examples

• Parsing:

let input: AST.NodeInput = evaluator.Parse('x=sqrt(1+2*3)');

• Evaluation:

let result: AST.NodeInput = evaluator.Evaluate(input);

• MathML generation:

let mathmlInput: string = evaluator.UnparseMathML(input);
let mathmlResult: string = evaluator.UnparseMathML(result);

Using a CDN

You can optimize your application by reducing the size of your bundle by loading MathJSLab package through a CDN.

You can use UNPKG, jsDelivr, or any other CDN that delivers content from the npm repository.

Using UNPKG

To load MathJSLab package through UNPKG CDN copy the following HTML code:

<script src="https://www.unpkg.com/mathjslab"></script>

Using jsDelivr

To load MathJSLab package through jsDelivr CDN copy the following HTML code:

<script src="https://cdn.jsdelivr.net/npm/mathjslab/lib/mathjslab.min.js"></script>

MathJSLab module use

The UMD module will be loaded with mathjslab name. You can instantiate Evaluator with:

let evaluator = new mathjslab.Evaluator(EvaluatorConfiguration);

Contributing

To contribute to this project see our contributing guidelines.

Join the community chat:

Project build and test

To build the project, you only need Node.js® and the Java Runtime Environment installed. The project build and dependencies are managed by npm through scripts in the package.json file. The build scripts download the latest version of ANTLR into the resources directory for use by the project. The test suite uses the Jest framework.

Build scripts

The following build scripts are defined:

1. Before building and testing mathjslab, to initialize the project workspace, run:

npm run update

This will update the dependencies, install all of them, and download the latest version of ANTLR, preparing any resources needed to build the project.

1. Run the mathjslab tests:

npm run test

1. Format and lint mathjslab code:

npm run format:lint

1. Build mathjslab package:

npm run build

1. To cleanup all build files in workspace use:

npm run clean

1. To delete resources and dependencies, the package-lock.json file and node_modules directory too, use:

npm run clean:all

After run this command you will need to do workspace setup running npm run update again.

Language subset

Currently only the mathematical expressions of the language are implemented. The control and loop structures are not yet implemented.

There are some differences from the original MATLAB®/Octave. The main difference is that there are only one a complex numeric type. Other implemented types is boolean, character string, structure and function handle.

Common arrays (not only cell arrays) can hold any type of element.

License

MIT License

Copyright © 2016-2024 Sergio Lindau, mathjslab.com, ISBN 978-65-00-82338-7.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

1.6.1

• All dependencies have been updated.
• Optimizations in the file 'mathjslab-logo.svg'
• Changes in the 'webpack.config.ts': path.resolve changed to path.join when possible. More rational path specifications. JavaScript files selection removed from regular expression test (configuration.module.rules[0].test and configuration.module.rules[0].exclude). JavaScript files selection removed from regular expressions in the file 'jest.config.js' too.
• The demo Web application of MathJSLab package has been renamed to 'mathjslab-demo', with its repository also being renamed. All references to its name and repository have been updated.
• Added information to the 'README.md' file stating that the MathJSLab package documentation is in three languages, in the demo web application repository.