Struct MathGroup 

pub struct MathGroup<ET: EngineTypes> {
    pub display: Option<(Skip<ET::Dim>, Skip<ET::Dim>)>,
    pub children: Box<[MathNode<ET, MathFontStyle<ET>>]>,
    pub start: SourceRef<ET>,
    pub end: SourceRef<ET>,
    pub eqno: Option<(EqNoPosition, Box<[MathNode<ET, MathFontStyle<ET>>]>)>,
    pub computed_width: OnceCell<ET::Dim>,
    pub computed_height: OnceCell<ET::Dim>,
    pub computed_depth: OnceCell<ET::Dim>,
}

A resolved math group; the result of a math list.

Fields

display: Option<(Skip<ET::Dim>, Skip<ET::Dim>)>

If this is a display math group, the \abovedisplayskip and \belowdisplayskip values.

children: Box<[MathNode<ET, MathFontStyle<ET>>]>

The nodes in this group

start: SourceRef<ET>

The source reference of the $ or $$ that started this group.

end: SourceRef<ET>

The source reference of the $ or $$ that ended this group.

eqno: Option<(EqNoPosition, Box<[MathNode<ET, MathFontStyle<ET>>]>)>

If the mathgroup contained an \eqno or \leqno, the nodes following that command

computed_width: OnceCell<ET::Dim>

The computed width of this group - i.e. the sum of the widths of the children.

computed_height: OnceCell<ET::Dim>

The computed height of this group - i.e. the maximum of the heights of the children.

computed_depth: OnceCell<ET::Dim>

The computed depth of this group - i.e. the maximum of the depths of the children.

Implementations

impl<ET: EngineTypes> MathGroup<ET>

pub fn close( state: &ET::State, display: Option<(Skip<ET::Dim>, Skip<ET::Dim>)>, start: SourceRef<ET>, end: SourceRef<ET>, children: Vec<MathNode<ET, UnresolvedMathFontStyle<ET>>>, eqno: Option<(EqNoPosition, Vec<MathNode<ET, UnresolvedMathFontStyle<ET>>>)>, ) -> Self

Create a new math group by closing a list of unresolved math nodes, iterating over it and resolving each node by determining the appropriate MathFontStyle for it. If display is Some, this is a display math group, and the two skips are the \abovedisplayskip and \belowdisplayskip values.

Trait Implementations

impl<ET: Clone + EngineTypes> Clone for MathGroup<ET>

where ET::Dim: Clone,

fn clone(&self) -> MathGroup<ET>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<ET: Debug + EngineTypes> Debug for MathGroup<ET>

where ET::Dim: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<ET: EngineTypes> NodeTrait<ET> for MathGroup<ET>

fn display_fmt(&self, indent: usize, f: &mut Formatter<'_>) -> Result

Produces a human-readable string; since nodes are deeply nested, takes an additional indent value to indent the string

fn height(&self) -> ET::Dim

Returns the height of the node.

fn width(&self) -> ET::Dim

Returns the width of the node.

fn depth(&self) -> ET::Dim

Returns the depth of the node.

fn nodetype(&self) -> NodeType

Returns the type of the node, as returned by \lastnodetype.

fn sourceref(&self) -> Option<(&SourceRef<ET>, &SourceRef<ET>)>

fn display(&self) -> DisplayNode<'_, ET, Self>

Returns a helper struct that implements Display and uses Self::display_fmt to yield a human-readable string.

fn opaque(&self) -> bool

Whether this node is “opaque”; meaning: When considering a list of nodes (e.g. in \unskip or \lastbox, this node should not be considered. Useful for annotation/marker nodes some engine wants to insert, without impacting algorithms that inspect e.g. the last node of the current list.