mathjslab

MathJSLab

[![NPM version][npm-image]][npm-url] [![npm download][download-image]][download-url]

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

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

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

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

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

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.
• Open source with fully documented code.
• Test suites.
• Improved demo web application.

Browser support

MathJSLab works on any ES6 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. Initialize evaluator with:

let evaluator = Evaluator.initialize(EvaluatorConfiguration);

Examples:

• Parsing

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

• Evaluation

let result = evaluator.Evaluate(tree);

• MathML generation

let mathml = evaluator.UnparseML(tree);

You can use the latest version of this module directly from unpkg using:

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

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.

Some differences from the original MATLAB®/Octave language are

• Defining functions is done simply using: function_name(argument, argument, ...) =
• Parsing is executed line-by-line.

References

• Decimal.js documentation
• Wolfram MathWorld
• WolframAlpha
• MATLAB® Documentation
  • Get Started with MATLAB®
  • Language Fundamentals
• GNU Octave manual
• Octave Online
• Octave scripts source
• GNU Octave at Wikipedia
• Octave Forge - Extra packages for GNU Octave
  • Octave Forge Function List
• GNU Octave at Free Software Foundation
• GNU Octave (version 6.4.0) Online Manual
  • 18.2 Basic Matrix Functions
• Octave lexer
• Octave parser
• MATLAB® parser by Tegala Sravani
• The Design and Implementation of a Parser and Scanner for the MATLAB® Language in the MATCH Compiler
• MATLAB® grammar from Grammar Zoo

License

MIT License

Copyright © 2016-2023 Sergio Lindau

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.