LaTeX Lib

This package contains a class for simplifying representation of NumPy arrays using LaTeX syntax in a Jupyter notebook.

Installation

pip install -i https://test.pypi.org/simple/ latex-lib

Usage

Declaring an Array

The LatexArray class can be used to handle NumPy arrays that need to be displayed in Jupyter notebooks.

• This class subclasses the Latex class from IPython, which is what IPython uses when displaying the object in a Jupyter notebook as LaTeX.

from latex_lib import LatexArray as Array

# Declare an array of 12 integers as a row vector.
array: Array = Array(range(12))
array

$$ \begin{pmatrix} 0 & 1 & 2 & 3 & 4 & 5 & 6 & 7 & 8 & 9 & 10 & 11 \end{pmatrix} $$

String Representation

The string representation of the array is its LaTeX representation.

str(array)

'\\begin{pmatrix}\n0 & 1 & 2 & 3 & 4 & 5 & 6 & 7 & 8 & 9 & 10 & 11\n\\end{pmatrix}'

Arithemtic Operations

The class supports all arithmetic operations supported by np.ndarray (its superclass), which covers generally all operations.

# Perform some arithmetic on the original array.
(array + array) + 1 * 2 / 5

$$ \begin{pmatrix} 0.4 & 2.4 & 4.4 & 6.4 & 8.4 & 10.4 & 12.4 & 14.4 & 16.4 & 18.4 & 20.4 & 22.4 \end{pmatrix} $$

NumPy Methods

The class supports all methods supported by np.ndarray as well.

# Reshape the array into a column vector.
array.reshape((-1, 1))

$$ \begin{pmatrix} 1\\ 2\\ 3\\ 4\\ 5\\ 6\\ 7\\ 8\\ 9\\ 10\\ 11 \end{pmatrix} $$

# Reshape the array into a 6 x 2 matrix.
array.reshape(-1, 2)

$$ \begin{bmatrix} 0 & 1\\ 2 & 3\\ 4 & 5\\ 6 & 7\\ 8 & 9\\ 10 & 11 \end{bmatrix} $$

NumPy Class Methods

Numpy functions and class methods are also generally supported (although, edge cases may exist).

import numpy as np

# NumPy functions work but do not return a LatexArray object.
np.where(array % 2 == 0, "Even", "Odd")

array(['Even', 'Odd', 'Even', 'Odd', 'Even', 'Odd', 'Even', 'Odd', 'Even',
       'Odd', 'Even', 'Odd'], dtype='<U4')

# We may, however, cast them to one:
Array(np.where(array % 2 == 0, "Even", "Odd"))

$$ \begin{pmatrix} Even & Odd & Even & Odd & Even & Odd & Even & Odd & Even & Odd & Even & Odd \end{pmatrix} $$

Creating Expressions

This can be used to constructor more complex Latex expressions. The IPython.display.Latex class can be used to create more complex Latex expressions.

from IPython.display import Latex
from latex_lib import LatexArray as Array

# Declare an array of 12 integers as a row vector.
array_a: Array = Array(range(12)).reshape(-1, 2)
array_b: Array = Array(range(12)).reshape(2, -1) * 5

Latex(rf"""$$
      \begin{{align*}}
      & \text{{Given matrices A and B, where: }}\\
      & A = {array} && B = {array_b}\\
      & \text{{The dot product can be obtained as: }}\\\\
      & A \cdot B = {array_a} \cdot {array_b} \\
      & = {array_a @ array_b}
      \end{{align*}}
      $$""")

$$ \begin{align*} & \text{Given matrices A and B, where: }\\ & A = \begin{pmatrix} 0 & 1 & 2 & 3 & 4 & 5 & 6 & 7 & 8 & 9 & 10 & 11 \end{pmatrix} && B = \begin{bmatrix} 0 & 5 & 10 & 15 & 20 & 25\\ 30 & 35 & 40 & 45 & 50 & 55 \end{bmatrix}\\ & \text{The dot product can be obtained as: }\\\ & A \cdot B = \begin{bmatrix} 0 & 1\\ 2 & 3\\ 4 & 5\\ 6 & 7\\ 8 & 9\\ 10 & 11 \end{bmatrix} \cdot \begin{bmatrix} 0 & 5 & 10 & 15 & 20 & 25\\ 30 & 35 & 40 & 45 & 50 & 55 \end{bmatrix} \\ & = \begin{bmatrix} 30 & 35 & 40 & 45 & 50 & 55\\ 90 & 115 & 140 & 165 & 190 & 215\\ 150 & 195 & 240 & 285 & 330 & 375\\ 210 & 275 & 340 & 405 & 470 & 535\\ 270 & 355 & 440 & 525 & 610 & 695\\ 330 & 435 & 540 & 645 & 750 & 855 \end{bmatrix} \end{align*} $$

Contributing

If you have any questions or suggestions, please feel free to open an issue or submit a pull request.

License

This package is released under the MIT License.