summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/namedtensor/README.md
blob: f4443242a9d4b40b51c779c9c8a641f377b6346e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Named tensor notation in LaTeX

This style file provides macros for named tensor notation. Please see
the paper [Named Tensor Notation](https://arxiv.org/abs/2102.13196)
for background on this notation.

To use the style file, put

    \usepackage{namedtensor}

into the preamble of your LaTeX source file (after
`\documentclass{article}` but before `\begin{document}`).

We write axis names in sans-serif font. To make this easier,
`\name{axis}` prints the axis name "axis", and `\ndef{\ax}{axis}`
defines a macro `\ax` that prints the axis name "axis".

Binary operators

- Use `A \ndot{\ax} B` for contractions. You can use `\\` to stack up
  several names.

- You can use `\nbin` to make new binary operators. For example, `A
  \nbin{\ax}{\star} B` gives you a star operator with "axis" written
  under it.

Functions

- Use `\nsum{\ax} A` for summation over a named axis.

- You can use `\nfun` to make new functions. For example,
  `\nfun{\ax}{qux} A` defines a function "qux" with "axis" written
  under it.

## Credits

- David Chiang, University of Notre Dame, dchiang@nd.edu
- Alexander M. Rush, Cornell University, arush@cornell.edu
- Boaz Barak, Harvard University, b@boazbarak.org

## License

This software is licensed under the MIT License. Please see LICENSE.md
for copyright notice.