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.

Important Notice: This software, the **MathJSLab,
is not affiliated, sponsored, or endorsed by
The MathWorks, Inc.**
MATLAB® is a registered
trademark of The MathWorks, Inc. For more
information about MATLAB,
visit www.mathworks.com.

The MathJSLab can run in the browser environment and
implements arbitrary precision arithmetic using the
decimal.js package in addition to
the native number type.

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.

The MathJSLab engine is being
architected similarly to
MATLAB®/Octave:
based on the BLAS (Basic Linear Algebra
Subprograms) and LAPACK (Linear Algebra
PACKage) routines.

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. It's 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. All mathjslab code was written synchronously. Asynchronous
functions were used only at build time.
- Improved demo
Web application at project
page: mathjslab.com
(repository). The demo
Web application was coded as
a
Progressive Web App (PWA),
with the most modern web programming features, such as:
- Reusable
Web Components
to structure the user interface.
- Responsive
HTML elements and
components.
- Styles defined by
SASS templates, with definitions in a more
rationalized and modular manner.
- Nunjucks templates processed by
Eleventy to dynamically configure values at
build time.
- Comes with a large set of built-in operations, functions and commands well
documented in the demo
Web application in
english,
portuguese
and spanish.
- Includes test suite using Jest
framework (most tests not
yet implemented).
- Is easily extensible through configuration parameters passed to
Evaluator constructor.
- Open source software with fully documented code:
MIT License.
- 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.

Supported environments

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

There are 6 different bundles:

- For Node.js environment,
CommonJS,
ES2015 target
(mathjslab.node.cjs2015.js).
- For Node.js environment,
CommonJS,
ES2022 target
(mathjslab.node.cjs2022.js).
- For Node.js environment,
ES Module,
ES2022 target
(mathjslab.node.esm2022.js).
- For browser environment, UMD,
ES2015 target
(mathjslab.web.umd2015.js).
- For browser environment, UMD,
ES2022 target
(mathjslab.web.umd2022.js).
- For browser environment, ES Module,
ES2022 target
(mathjslab.web.esm2022.js>)).

Installation

Install the mathjslab package:

``bash
npm install mathjslab
`

Usage

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

Import **MathJSLab
API**:

`typescript
import { Evaluator, TEvaluatorConfig } from "mathjslab";
`

Instantiate the Evaluator class with:

`typescript
let evaluator: Evaluator = new Evaluator(EvaluatorConfiguration);
`

$3

- Parsing:

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

- Evaluation:

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

- MathML generation:

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

You can try some basic examples on
CodePen.

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

$3

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

`html

`

$3


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

`html

`

$3

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

`typescript
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.

$3

The following build scripts are defined:

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

`bash
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.

2. Run the mathjslab tests:

`bash
npm run test
`

3. Format and lint mathjslab code:

`bash
npm run format:lint
`

4. Build mathjslab package:

`bash
npm run build
`

5. To cleanup all build files in workspace use:

`bash
npm run clean
`

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

`bash
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.

Trademark Notes

- MATLAB® is a registered
trademark of The MathWorks, Inc.
- MathJSLab is not affiliated, sponsored, or endorsed
by The MathWorks, Inc.

License

> MIT License
>
> Copyright © 2016-2026 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.