@totemstan/mathjx v1.5.0
MATHJX
Extends MathJS to provide Matlab-js-blended programming with the following control-blocks:
if TEST
DO
elseif TEST
DO
:
else
DO
end
switch TEST
case TEST
DO
:
default TEST
DO
end
try
DO
catch
DO
end
for INDEX
DO
end
while TEST
DO
end
until TEST
DO
end
when EVENT
DO
end
def f=(x,y,...)
DO
end
Inline functions are supported using fat-arrows:
(x,y,...) => {
DO
}
MathJS emulates the Matlab syntax while protecting against lax Matlab expressions. Thus
for term-wise cos([0,1,2])
use Cos([0,1,2])
or map([0,1,2], cos)
. Transposes are likewise
strict so [1,2,3]'
, [[1,2,3]]'
, and [1;2;3]'
produce [1,2,3]
, [1;2;3]
, and [1,2,3]
, respectively.
Import a file using <FILE
, inspect or get help on a KEY variable or function with ?KEY
, code multiple DOs on same
line with DO \ DO \ ...
. Otherwise, follow MathJS rules.
Usage
Acquire and optionally configure MATHJX as follows:
const $ = require("@totemstan/mathjx").config({
key: value, // set key
"key.key": value, // indexed set
"key.key.": value // indexed append
});
where configuration keys follow ENUMS deep copy conventions.
Manage
npm install @totemstan/mathjx # Install
npm run start [ ? | $ | ...] # Unit test
npm run verminor # Roll minor version
npm run vermajor # Roll major version
npm run redoc # Regen documentation
Program Reference
MATHJX
Extends MathJS with program control-blocks. This module documented in accordance with jsdoc.
Requires: module:mathjs, module:enums, module:cp
Author: ACMESDS
MATHJX~imports
Hash of functions to import into MathJX.
Kind: inner property of MATHJX
MATHJX~config(opts)
Configure MathJX with supplied options hash.
Kind: inner method of MATHJX
Param | Type | Description |
---|---|---|
opts | Object | Options hash with keys following the deep-copy conventions |
Contacting, Contributing, Following
Feel free to
- submit and status TOTEM issues
- contribute to TOTEM notebooks
- revise TOTEM requirements
- browse TOTEM holdings
- or follow TOTEM milestones
License
© 2012 ACMESDS