Skip to main content

Module math

Module math 

Source
Expand description

Nodes allowed in math mode

Structs§

Delimiter
Convenience struct for math delimiters, as constructed from a delimiter code
MathAtom
The most central kind of node in a math list. Consisting of a nucleus with optional superscript and subscript math lists.
MathChar
Convenience struct for characters in math mode
MathFontStyle
A resolved math font style. This is the state after the math list has been constructed. Has a definite style and font.
MathGroup
A resolved math group; the result of a math list.
MathStyle
One of the 8 styles of math formatting; The TeXBook calls these D,T,S,SS,D’,T’,S’ and SS’.
ResolvedChoice
A resolved \mathchoice node. This is the state after the math list has been constructed, at which point it is only a wrapper around a list of nodes.
UnresolvedMathChoice
A \mathcoice node, not yet resolved. When the current math list is closed, one of the four choices is picked, depending on the current style.
UnresolvedMathFontStyle
Unresolved math font style. This is the state while the math list is being constructed. Carries information about the family if relevant (or 0), to be picked when the math list is resolved.

Enums§

EqNoPosition
The position of an eqno in a math list, i.e. \eqno (right) or \leqno (left).
MathClass
The 7 math classes
MathKernel
The kernel of a MathNucleus; the actual content of the nucleus.
MathNode
A math list node. Comes in two forms: an unresolved form, while the list is being constructed and the various font styles are not fixed yet (e.g. because an \atop comes later that shifts the font style), and a resolved form, where the fonts have been determined and are fixed. The parameter S:MathFontStyleT makes the distinction between the two forms. For S=MathFontStyle (the resolved form), this implements NodeTrait.
MathNodeList
An open list of unresolved math nodes. TODO: rethink this
MathNodeListType
Types of open math lists
MathNucleus
The nucleus of a MathAtom; a cohesive “unit” with optional sub/superscript.
MathStyleType
The four base math formatting styles
UnresolvedMarkers
Markers inserted by \displaystyle, \textstyle, \scriptstyle and \scriptscriptstyle. Only meaningful in unresolved mode, while the math list is open. When the list is closed, these are removed and used to determine the font style at that point.

Traits§

MathChoiceT
This trait is implemented for exactly two types that indicate whether we are in the unresolved UnresolvedMathFontStyle or resolved (MathFontStyle) state.
MathFontStyleT
This trait is implemented for exactly two types that indicate whether we are in the unresolved UnresolvedMathFontStyle or resolved (MathFontStyle) state.