latex_util

AdjustBox

Bases: Environment

A class to adjust the size of boxes.

This class is intentionally not @traceable.

Source code in fastestimator/fastestimator/util/latex_util.py

class AdjustBox(Environment):
    """A class to adjust the size of boxes.

    This class is intentionally not @traceable.
    """
    packages = [Package('adjustbox')]

Center

Bases: Environment

A class to center content in a page.

This class is intentionally not @traceable.

Source code in fastestimator/fastestimator/util/latex_util.py

class Center(Environment):
    """A class to center content in a page.

    This class is intentionally not @traceable.
    """
    pass

ContainerList

Bases: Container

A class to expedite combining pieces of latex together.

This class is intentionally not @traceable.

Source code in fastestimator/fastestimator/util/latex_util.py

class ContainerList(Container):
    """A class to expedite combining pieces of latex together.

    This class is intentionally not @traceable.
    """
    def dumps(self) -> str:
        """Get a string representation of this container.

        Returns:
            A string representation of itself.
        """
        return self.dumps_content()

dumps

Get a string representation of this container.

Returns:

Type	Description
str	A string representation of itself.

Source code in fastestimator/fastestimator/util/latex_util.py

def dumps(self) -> str:
    """Get a string representation of this container.

    Returns:
        A string representation of itself.
    """
    return self.dumps_content()

Form

Bases: Environment

A class to allow Form elements.

This class is intentionally not @traceable. Only one Form is allowed per document.

Source code in fastestimator/fastestimator/util/latex_util.py

class Form(Environment):
    """A class to allow Form elements.

    This class is intentionally not @traceable. Only one Form is allowed per document.
    """
    _latex_name = 'Form'
    packages = [Package('hyperref', options='hidelinks')]

HrefFEID

Bases: ContainerList

A class to represent a colored and underlined hyperref based on a given fe_id.

This class is intentionally not @traceable.

Parameters:

Name	Type	Description	Default
fe_id	FEID	The id used to link this hyperref.	required
name	str	A string suffix to be printed as part of the link text.	required
link_prefix	str	The prefix for the hyperlink.	'tbl'
id_in_name	bool	Whether to include the id in front of the name text.	True
bold_name	bool	Whether to bold the name.	False

Source code in fastestimator/fastestimator/util/latex_util.py

class HrefFEID(ContainerList):
    """A class to represent a colored and underlined hyperref based on a given fe_id.

    This class is intentionally not @traceable.

    Args:
        fe_id: The id used to link this hyperref.
        name: A string suffix to be printed as part of the link text.
        link_prefix: The prefix for the hyperlink.
        id_in_name: Whether to include the id in front of the name text.
        bold_name: Whether to bold the name.
    """
    def __init__(self,
                 fe_id: FEID,
                 name: str,
                 link_prefix: str = 'tbl',
                 id_in_name: bool = True,
                 bold_name: bool = False,
                 color: str = 'blue'):
        self.content_separator = ''
        self.packages.add(Package('hyperref', options='hidelinks'))
        self.packages.add(Package('ulem'))
        self.packages.add(Package('xcolor', options='table'))
        self.fe_id = fe_id
        self.name = name
        data = [
            NoEscape(r'\hyperref['),
            escape_latex(f"{link_prefix}:"), fe_id,
            NoEscape(r']{\textcolor{' + color + r'}{\uline{')
        ]
        if id_in_name:
            data.append(fe_id)
            if name:
                data.append(": ")
        if name:
            data.append(bold(escape_latex(name)) if bold_name else escape_latex(name))
        data.append(NoEscape("}}}"))
        super().__init__(data=data)

IterJoin

Bases: Container

A class to convert an iterable to a latex representation.

Parameters:

Name	Type	Description	Default
data	Iterable	Data of the cell.	required
token	str	String to serve as separator among items of data.	required

Source code in fastestimator/fastestimator/util/latex_util.py

class IterJoin(Container):
    """A class to convert an iterable to a latex representation.

    Args:
        data: Data of the cell.
        token: String to serve as separator among items of `data`.
    """
    def __init__(self, data: Iterable, token: str):
        super().__init__(data=data)
        self.token = token

    def dumps(self) -> str:
        """Get a string representation of this cell.

        Returns:
            A string representation of itself.
        """
        return dumps_list(self, token=self.token)

dumps

Get a string representation of this cell.

Returns:

Type	Description
str	A string representation of itself.

Source code in fastestimator/fastestimator/util/latex_util.py

def dumps(self) -> str:
    """Get a string representation of this cell.

    Returns:
        A string representation of itself.
    """
    return dumps_list(self, token=self.token)

PyContainer

Bases: ContainerList

A class to convert python containers to a LaTeX representation.

This class is intentionally not @traceable.

Parameters:

Name	Type	Description	Default
data	Union[list, tuple, set, dict]	The python object to be converted to LaTeX.	required
truncate	Optional[int]	How many values to display before truncating with an ellipsis. This should be a positive integer or None to disable truncation.	None

Source code in fastestimator/fastestimator/util/latex_util.py

class PyContainer(ContainerList):
    """A class to convert python containers to a LaTeX representation.

    This class is intentionally not @traceable.

    Args:
        data: The python object to be converted to LaTeX.
        truncate: How many values to display before truncating with an ellipsis. This should be a positive integer or
            None to disable truncation.
    """
    def __init__(self, data: Union[list, tuple, set, dict], truncate: Optional[int] = None):
        self.packages.add(Package('enumitem', options='inline'))
        assert isinstance(data, (list, tuple, set, dict)), f"Unacceptable data type for PyContainer: {type(data)}"
        open_char = '[' if isinstance(data, list) else '(' if isinstance(data, tuple) else r'\{'
        close_char = ']' if isinstance(data, list) else ')' if isinstance(data, tuple) else r'\}'
        ltx = Enumerate(options=Options(NoEscape('label={}'), NoEscape('itemjoin={,}')))
        ltx._star_latex_name = True  # Converts this to an inline list
        self.raw_input = data
        if isinstance(data, dict):
            for key, val in list(data.items())[:truncate]:
                ltx.add_item(ContainerList(data=[key, ": ", val]))
        else:
            for val in list(data)[:truncate]:
                ltx.add_item(val)
        if truncate and len(data) > truncate:
            ltx.add_item(NoEscape(r'\ldots'))
        super().__init__(data=[NoEscape(open_char), ltx, NoEscape(close_char)])

TextField

Bases: ContainerCommand

A class to create editable text fields.

This class is intentionally not @traceable. It can only be used inside of a Form.

Source code in fastestimator/fastestimator/util/latex_util.py

class TextField(ContainerCommand):
    """A class to create editable text fields.

    This class is intentionally not @traceable. It can only be used inside of a Form.
    """
    _latex_name = "TextField"

TextFieldBox

Bases: ContainerList

A class to wrap TextFields into padded boxes for use in nesting within tables.

Parameters:

Name	Type	Description	Default
name	str	The name to assign to this TextField. It should be unique within the document since changes to one box will impact all boxes with the same name.	required
height	str	How tall should the TextField box be? Note that it will be wrapped by 10pt space on the top and bottom.	'2.5cm'

Source code in fastestimator/fastestimator/util/latex_util.py

class TextFieldBox(ContainerList):
    """A class to wrap TextFields into padded boxes for use in nesting within tables.

    Args:
        name: The name to assign to this TextField. It should be unique within the document since changes to one box
            will impact all boxes with the same name.
        height: How tall should the TextField box be? Note that it will be wrapped by 10pt space on the top and bottom.
    """
    packages = [Package('xcolor', options='table')]

    def __init__(self, name: str, height: str = '2.5cm'):
        data = [
            NoEscape(r"\begin{minipage}{\linewidth}"),
            NoEscape(r"\vspace{3pt}"),
            TextField(options=[
                NoEscape(r'width=\linewidth'),
                NoEscape(f'height={height}'),
                NoEscape('backgroundcolor={0.97 0.97 0.97}'),
                'bordercolor=white',
                'multiline=true',
                f'name={name}'
            ]),
            NoEscape(r"\vspace{3pt}"),
            NoEscape(r"\end{minipage}")
        ]
        super().__init__(data=data)

Verbatim

Bases: Environment

A class to put a string inside the latex verbatim environment.

This class is intentionally not @traceable.

Parameters:

Name	Type	Description	Default
data	str	The string to be wrapped.	required

Source code in fastestimator/fastestimator/util/latex_util.py

class Verbatim(Environment):
    """A class to put a string inside the latex verbatim environment.

    This class is intentionally not @traceable.

    Args:
        data: The string to be wrapped.
    """
    def __init__(self, data: str):
        super().__init__(options=None, arguments=None, start_arguments=None, data=NoEscape(data))
        self.content_separator = '\n'

WrapText

Bases: LatexObject

A class to convert strings or numbers to wrappable latex representation.

This class will first convert the data to string, and then to a wrappable latex representation if its length is too long. This fixes an issue which prevents the first element placed into a latex X column from wrapping correctly.

Parameters:

Name	Type	Description	Default
data	Union[str, int, float]	Input data to be converted.	required
threshold	int	When the length of data is greater than threshold, the resulting string will be made wrappable.	required

Raises:

Type	Description
AssertionError	If data is not a string, int, or float.

Source code in fastestimator/fastestimator/util/latex_util.py

class WrapText(LatexObject):
    """A class to convert strings or numbers to wrappable latex representation.

    This class will first convert the data to string, and then to a wrappable latex representation if its length is too
    long. This fixes an issue which prevents the first element placed into a latex X column from wrapping correctly.

    Args:
        data: Input data to be converted.
        threshold: When the length of `data` is greater than `threshold`, the resulting string will be made wrappable.

    Raises:
        AssertionError: If `data` is not a string, int, or float.
    """
    def __init__(self, data: Union[str, int, float], threshold: int):
        assert isinstance(data, (str, int, float)), "the self.data type needs to be str, int, float"
        self.threshold = threshold
        self.data = str(data)
        super().__init__()

    def dumps(self) -> str:
        """Get a string representation of this cell.

        Returns:
            A string representation of itself.
        """
        if len(self.data) > self.threshold:
            return NoEscape(r'\seqsplit{' + escape_latex(self.data) + '}')
        else:
            return escape_latex(self.data)

dumps

Get a string representation of this cell.

Returns:

Type	Description
str	A string representation of itself.

Source code in fastestimator/fastestimator/util/latex_util.py

def dumps(self) -> str:
    """Get a string representation of this cell.

    Returns:
        A string representation of itself.
    """
    if len(self.data) > self.threshold:
        return NoEscape(r'\seqsplit{' + escape_latex(self.data) + '}')
    else:
        return escape_latex(self.data)