A simple converter from ASCIIMath to LaTeX
Project description
ASCIIMATH
AsciiMath is an easy-to-write markup language for mathematics: for more information check out the main website at ASCIIMath.
The parser utility takes an ASCIIMath string in input and returns the corresponding LaTeX translation, via a syntactic and semantic transformation.
Usage
Right now it's only suppported as python module, so:
from parser.const import asciimath_grammar
from parser.parser import ASCIIMath2Tex
if __name__ == "__main__":
parser = ASCIIMath2Tex(
asciimath_grammar,
inplace=False,
parser="lalr",
lexer="contextual",
)
asciimath = "sum_(i=1)^n i^3=((n(n+1))/2)^2"
latex = parser.asciimath2tex(asciimath, pprint=True)
print(latex)
results in:
\sum_{i = 1}^{n} i^{3} = \left(\frac{\left(n \left(n + 1\right)\right)}{2}\right)^{2}
Grammar
The grammar used to parse the input is:
start: i start* -> exp
i: s -> exp_interm
| s "/" s -> exp_frac
| s "_" s -> exp_under
| s "^" s -> exp_super
| s "_" s "^" s -> exp_under_super
s: l start? r -> exp_par
| u s -> exp_unary
| b s s -> exp_binary
| latex -> symbol
| c -> const
| QS -> q_str
c: /d[A-Za-z]/ // derivatives
| NUMBER
| LETTER
l: {} // left parenthesis
r: {} // right parenthesis
b: {} // binary functions
u: {} // unary functions
latex: {}
QS: "\"" /(?<=").+(?=")/ "\"" // Quoted String
For the complete list of symbols, please refer to http://asciimath.org/#syntax. The only symbol that I've added is dstyle
, that stands for displaystyle
as a unary function.
Rendering (semantics)
A parsed ASCIIMath string is rendered as follows:
latex
,u
andc
symbols are converted to their LaTeX equivalenttext
andul
correspond to the\textrm
and\underline
functionsbb
,bbb
,cc
,tt
,fr
andsf
correspond to the\boldsymbol
,\mathbb
,\mathcal
,\texttt
,\mathfrak
and\textsf
functionsfrac
is rendered as a fraction,root n x
as the n-th root of x andstackrel x y
displays x upon y- Any text placed between a pair of
"
is rendered in the same font as normal text. /
stands for a fraction. The_
and^
tokens have the same behaviour as in LaTeX but the subscript must be placed before the superscript if they are both present
Delimiters
Left and right delimiters are preceded by the \left
and \right
commands to be well-sized. (:
and :)
are chevrons (angle parenthesis). {:
and :}
are invisible delimiters like LaTeX's {. |:
is converted to \lvert
, while ||:
is converted to \lVert
. The other delimiters are rendered as expected.
Useless delimiters are automatically removed in expressions like:
(...)/(...)
(...)_(...)
,(...)^(...)
and the combination of sub and superscriptu (...)
,b (...) (...)
where u and b are unary and binary operators
If you want them to be rendered, you have to double them, for example: ((x+y))/2
or {: (x+y) :}/2
.
Matrices and systems of equations
For a text to be rendered as a matrix must have a structure like
L '[' ... (, ...)* ']', '[' ... (, ...)* ']' (, '[' ... (, ...)* ']' )* R
or
L '(' ... (, ...)* ')', '(' ... (, ...)* ')' (, '(' ... (, ...)* ')' )* R
that is:
- It must be delimited by a left (
L
) and right (R
) parenthesis - Every row can be separated by
[]
XOR()
(if one starts with[]
, every row will be recognized with the same parenthesis, same for()
), followed by,
and possibly another row - Every matrix must contain at least two rows
- Every rows contains zero or more columns, where
...
can be any ASCIIMath expression - Every row must contain the same number of columns
Since L
and R
can be any left or right parenthesis, and every matrices must have the same number of columns, to render a system of equation one can write something like {[(root n x)/(x) <= 4], [x^2=e^x]:}
.
On the other hand a matrix can be somenthing like [[(root n x)/(x) <= 4, int x dx], [x^2=e^x, lim_(x to infty) 1 / (x^2)]]
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file py_asciimath-0.0.1-py2.py3-none-any.whl
.
File metadata
- Download URL: py_asciimath-0.0.1-py2.py3-none-any.whl
- Upload date:
- Size: 14.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43e10d16cf4384667995748feaf5343b0e383d7506b54c1214d99e1d6472273f |
|
MD5 | e689fad71d55c36991c1f1f93a11be81 |
|
BLAKE2b-256 | 14a0c02952cddf1b14c5cf1639b02e64b011b732ce1892f05c740c9ab90ad674 |