Skip to content

math_spec.typesetting.latex

LaTeX (amsmath). The preamble must stay installable from a two-package TeX, which is what CI compiles with.

LatexFormat #

See :class:math_spec.typesetting.format.Format.

cases_row = ' \\\\ ' class-attribute #

dash = '---' class-attribute #

notation = 'latex' class-attribute #

operators = {name: latex for name, (latex, _) in OPERATOR_SPELLINGS.items()} class-attribute #

apply(function, argument) #

Source code in src/math_spec/typesetting/latex.py 
108
109
def apply(self, function: str, argument: str) -> str:
    return f'{function}({argument})'

cardinality(inner) #

Source code in src/math_spec/typesetting/latex.py 
95
96
def cardinality(self, inner: str) -> str:
    return rf'\lvert {inner} \rvert'

cases(arms) #

Source code in src/math_spec/typesetting/latex.py 
101
102
103
def cases(self, arms: list[tuple[str, str]]) -> str:
    rows = self.cases_row.join(f'{value} & {condition}' for value, condition in arms)
    return rf'\begin{{cases}} {rows} \end{{cases}}'

document(blocks, *, standalone) #

Source code in src/math_spec/typesetting/latex.py 
131
132
133
def document(self, blocks: list[str], *, standalone: bool) -> str:
    body = paragraphs(blocks)
    return f'{_PREAMBLE}\n{body}\n\\end{{document}}\n' if standalone else body

equations(lines, *, numbered) #

Source code in src/math_spec/typesetting/latex.py 
116
117
118
119
def equations(self, lines: list[Line], *, numbered: bool) -> str:
    environment = 'align' if numbered else 'align*'
    body = ' \\\\\n'.join(aligned_rows(lines, self, gap=' && '))
    return f'\\begin{{{environment}}}\n{body}\n\\end{{{environment}}}'

escape(prose) #

Source code in src/math_spec/typesetting/latex.py 
78
79
def escape(self, prose: str) -> str:
    return _escape(prose)

fraction(numerator, denominator) #

Source code in src/math_spec/typesetting/latex.py 
98
99
def fraction(self, numerator: str, denominator: str) -> str:
    return rf'\frac{{{numerator}}}{{{denominator}}}'

glossary(title, entries) #

Source code in src/math_spec/typesetting/latex.py 
121
122
123
def glossary(self, title: str, entries: list[Entry]) -> str:
    rows = '\n'.join(rf'\item[{{{self.math(e.symbol)}}}] {e.meaning}' for e in entries)
    return f'\\paragraph{{{title}}}\n\\begin{{description}}\n{rows}\n\\end{{description}}'

greek(name) #

Source code in src/math_spec/typesetting/latex.py 
65
66
def greek(self, name: str) -> str:
    return f'\\{name}'

italic(name) #

Source code in src/math_spec/typesetting/latex.py 
56
57
def italic(self, name: str) -> str:
    return rf'\mathit{{{_escape(name)}}}'

joined(parts, operator) #

Source code in src/math_spec/typesetting/latex.py 
111
112
def joined(self, parts: list[str], operator: str) -> str:
    return f' {operator} '.join(parts) if operator else r',\ '.join(parts)

math(expression) #

Source code in src/math_spec/typesetting/latex.py 
81
82
def math(self, expression: str) -> str:
    return f'${expression}$'

mono(text) #

Source code in src/math_spec/typesetting/latex.py 
75
76
def mono(self, text: str) -> str:
    return rf'\texttt{{{_escape(text)}}}'

note(text) #

Source code in src/math_spec/typesetting/latex.py 
128
129
def note(self, text: str) -> str:
    return f'\\noindent {text}'

parenthesise(inner) #

Source code in src/math_spec/typesetting/latex.py 
92
93
def parenthesise(self, inner: str) -> str:
    return rf'\left( {inner} \right)'

prose(text) #

Source code in src/math_spec/typesetting/latex.py 
68
69
def prose(self, text: str) -> str:
    return rf'\text{{{_escape(text)}}}'

quoted(label) #

The quotes in text mode and the label upright in math mode, since MathJax renders \_ inside \text literally.

Source code in src/math_spec/typesetting/latex.py 
71
72
73
def quoted(self, label: str) -> str:
    r"""The quotes in text mode and the label upright in math mode, since MathJax renders ``\_`` inside ``\text`` literally."""
    return rf"\text{{'}}{self.upright(label)}\text{{'}}"

script(letter) #

Source code in src/math_spec/typesetting/latex.py 
62
63
def script(self, letter: str) -> str:
    return rf'\mathcal{{{letter}}}'

section(title, body) #

Source code in src/math_spec/typesetting/latex.py 
125
126
def section(self, title: str, body: str) -> str:
    return f'\\paragraph{{{title}}}\n{body}'

subscript(base, indices) #

Source code in src/math_spec/typesetting/latex.py 
86
87
def subscript(self, base: str, indices: list[str]) -> str:
    return f'{base}_{{{",".join(indices)}}}' if indices else base

summation(domain, body) #

Source code in src/math_spec/typesetting/latex.py 
105
106
def summation(self, domain: str, body: str) -> str:
    return rf'\sum_{{{domain}}} {body}'

superscript(base, tail) #

Source code in src/math_spec/typesetting/latex.py 
89
90
def superscript(self, base: str, tail: str) -> str:
    return f'{base}^{{{tail}}}'

upright(name) #

Source code in src/math_spec/typesetting/latex.py 
59
60
def upright(self, name: str) -> str:
    return rf'\mathrm{{{_escape(name)}}}'