Skip to content

math_spec.typesetting.latex

LaTeX (amsmath). The format that lands in a journal.

Verbose source and a toolchain to compile it, in exchange for being the one target a paper actually accepts. CI compiles every example with a two-package TeX, which is also a check that the preamble stays installable from a small one.

LatexFormat #

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

dash = '---' class-attribute #

notation = 'latex' class-attribute #

operators = LATEX_OPERATORS class-attribute #

suffix = '.tex' class-attribute #

apply(function, argument) #

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

cardinality(inner) #

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

document(blocks, *, standalone) #

Source code in src/math_spec/typesetting/latex.py 
134
135
136
def document(self, blocks: list[str], *, standalone: bool) -> str:
    body = '\n\n'.join(blocks) + '\n'
    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 
113
114
115
116
117
118
119
120
121
122
def equations(self, lines: list[Line], *, numbered: bool) -> str:
    environment = 'align' if numbered else 'align*'
    rows = [
        f'{self.prose(line.label) if line.label else ""} && {line.left} & {line.right} && {line.condition}'.rstrip(
            ' &'
        )
        for line in lines
    ]
    body = ' \\\\\n'.join(rows)
    return f'\\begin{{{environment}}}\n{body}\n\\end{{{environment}}}'

escape(prose) #

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

fraction(numerator, denominator) #

Source code in src/math_spec/typesetting/latex.py 
 99
100
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 
124
125
126
def glossary(self, title: str, entries: list[Entry]) -> str:
    rows = '\n'.join(rf'\item[{self.math(e.symbol)}] {e.meaning(self.dash)}' 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 
70
71
def greek(self, name: str) -> str:
    return f'\\{name}'

italic(name) #

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

joined(parts, operator) #

Source code in src/math_spec/typesetting/latex.py 
108
109
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 
82
83
def math(self, expression: str) -> str:
    return f'${expression}$'

mono(text) #

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

note(text) #

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

parenthesise(inner) #

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

prose(text) #

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

script(letter) #

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

section(title, body) #

Source code in src/math_spec/typesetting/latex.py 
128
129
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 
87
88
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 
102
103
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 
90
91
def superscript(self, base: str, tail: str) -> str:
    return f'{base}^{{{tail}}}'

upright(name) #

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