Getting started

Install

npm install pimath

PiMath is published as an ES module.

import PiMath from 'pimath'
// or, only what you need
import {Fraction, Polynom, Random} from 'pimath'

In a web page without a bundler, import the built file as a module. Every class is then available on the default export:

<script type="module">
    import PiMath from './node_modules/pimath/dist/pimath.js'

    const f = new PiMath.Fraction('2/3')
    document.body.textContent = f.display
</script>

First steps

Objects are built from a string (or from numbers) and expose their result as LaTeX with .tex.

const A = new PiMath.Fraction('2/3')
console.log(A.tex) // \frac{ 2 }{ 3 }

// Operations modify the object and return it, so they can be chained
A.add(new PiMath.Fraction('2/5'))
console.log(A.tex) // \frac{ 16 }{ 15 }
console.log(A.display) // 16/15

const P = new PiMath.Polynom('x^2-5x+6')
console.log(P.tex) // x^{ 2 }-5x+6
console.log(P.factorize().map(f => f.tex)) // [ 'x-2', 'x-3' ]

Draw an exercise

The Random generators build a new object at each call.

const equation = PiMath.Random.equation({degree: 2, solution: {count: 2, relative: true}})

console.log(equation.tex) // e.g. x^{ 2 }+3x-4=0
console.log(equation.solve().map(s => s.tex)) // e.g. [ '-4', '1' ]

Go on with displaying results and the random generators.

Mutating operations

add, subtract, multiply, divide, pow, reduce... modify the object they are called on and return it. Use clone() to keep the original.

const a = new PiMath.Polynom('x+1')
const b = a.clone().add('2')

console.log(a.display) // x+1
console.log(b.display) // x+3

If an operation throws, the object is left unchanged.

Editor support

If your exercises are written in an editor of your own, PiMath provides the autocompletion for it. The suggestions are generated from the types and the documentation of the library, so they always match the version you install.

• pimath/completions gives the data: names, static members, signatures, and the options of every Random generator.
• pimath/codemirror turns them into a source for a CodeMirror 6 editor. @codemirror/autocomplete, @codemirror/state and @codemirror/view are optional peer dependencies: install them if you use this entry.

import {javascript, javascriptLanguage} from '@codemirror/lang-javascript'
import {autocompletion} from '@codemirror/autocomplete'
import {pimathCompletion, pimathSignatureHelp} from 'pimath/codemirror'

const extensions = [
    javascript(),
    javascriptLanguage.data.of({autocomplete: pimathCompletion()}),
    autocompletion(),
    pimathSignatureHelp(),
]

It suggests the names (Fra gives Fraction), what follows a dot for Random, Numeric and the static members of a class (Line.fromPoints), and the options of the configuration object of a generator: type Random.equation({ de and it offers degree. The demo uses it. It does not know the type of a variable, so nothing is suggested after P..

To add your own names, use the extend option, which takes the same shape as the data:

pimathCompletion({
    extend: {
        globals: [{label: 'iteration', type: 'property', detail: 'number'}],
        members: {Random: [{label: 'points', type: 'function'}]},
    },
})