Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

mathjslab

Package Overview
Dependencies
Maintainers
0
Versions
86
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mathjslab

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

  • 1.5.12
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
661
increased by76.74%
Maintainers
0
Weekly downloads
 
Created
Source

logo

MathJSLab - mathjslab.com

npm version npm license npm downloads npm bundle size minzip size npm package minimized gzipped size install size GitHub Created At DOI

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

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.

Features

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';

Initialize evaluator 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 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:

Join the chat at https://matrix.to/#/#mathjslab:gitter.im

Build and Test

To build the project, you only need Node.js® and the Java Runtime Environment installed. The project dependencies are managed by npm. The build scripts download the latest version of ANTLR into the resources directory for use by the project. Before building and testing the project, 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.

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

Keywords

FAQs

Package last updated on 27 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc