mathjslab

v1.5.7

Published

3 months ago

MathJSLab - An interpreter with language syntax like MATLAB®/Octave. ISBN 978-65-00-82338-7

Downloads

258

0High
0Medium
0Low

sergiolindau

mathematics math educational MATLAB Octave MathML interpreter lexer parser grammar ANTLR

MathJSLab

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.

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.

A functional demo use of this package in a Web application can be found here.

Features

Runs on any JavaScript engine.
Comes with a large set of built-in functions and constants.
Is easily extensible through configuration parameters passed to Evaluator constructor.
Open source with fully documented code.
Test suites.
Improved demo Web application.

Browser support

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

Installation

Install the mathjslab package:

npm install mathjslab

Usage

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

Import MathJSLab API:

import { Evaluator, TEvaluatorConfig } from 'mathjslab';

Initialize evaluator with:

let evaluator = new Evaluator(EvaluatorConfiguration);

Examples:

Parsing

let tree = evaluator.Parse('x=sqrt(1+2*3)');

Evaluation

let result = evaluator.Evaluate(tree);

MathML generation

let mathmlInput = evaluator.UnparseMathML(tree);
let mathmlResult = evaluator.UnparseMathML(result);

Using UNPKG CDN

You can optimize your application, reducing the size of your bundle, loading MathJSLab via the UNPKG CDN.

<head>
    ...
    <script defer type="module" src="https://www.unpkg.com/mathjslab"></script>
    ...
</head>

The 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:

Test and Build

Run the mathjslab tests:

npm run test

Build mathjslab:

npm run build

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 language. 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, 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.