version 0.3.2: new transpose argument for wrap

Author: matomatical

CHANGELOG.md

@@ -24,6 +24,13 @@ Fix:
 
 * Missing title parameter from border.
 
+Version 0.3.2
+-------------
+
+New:
+
+* Transpose parameter for wrap.
+
 Version 0.3.1
 -------------
 

DOCS.md

@@ -65,21 +65,21 @@ import numpy as np
 
 xs = np.linspace(-2*np.pi, +2*np.pi, 156)
 
-plot = mp.border(
+plot = mp.axes(
     mp.scatter(
         (xs, 1.0 * np.cos(xs), "red"),
         (xs, 0.9 * np.cos(xs - 0.33 * np.pi), "magenta"),
         (xs, 0.8 * np.cos(xs - 0.66 * np.pi), "blue"),
         (xs, 0.7 * np.cos(xs - 1.00 * np.pi), "cyan"),
         (xs, 0.8 * np.cos(xs - 1.33 * np.pi), "green"),
         (xs, 0.9 * np.cos(xs - 1.66 * np.pi), "yellow"),
-        mp.xaxis(-2*np.pi, +2*np.pi, 156),
-        mp.yaxis(-1, 1, 40),
-        width=78,
+        width=75,
         height=10,
         yrange=(-1,1),
-    )
-    / mp.center(mp.text(f"cos(x + 2 pi k / 6)"), width=78)
+    ),
+    title=" y = cos(x + 2πk/6) ",
+    xlabel="x",
+    ylabel="y",
 )
 ```
 
@@ -1184,16 +1184,20 @@ Inputs:
     The number of columns in the grid. If not provided, it is automatically
     determined based on the terminal width and the width of the largest
     plot.
+* transpose: optional bool (default False).
+    If False (default), the plots are arranged in reading order, from left
+    to right and then from top to bottom. If True, the plots are arranged
+    in column order, from top to bottom and then from left to right.
 
 ### method wrap.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1552))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1563))
 
 ---
 
 ### class center
 
-**center(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1559))
+**center(plot):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1570))
 
 Pad a plot with blank space to center it within a larger area.
 
@@ -1214,13 +1218,13 @@ Inputs:
 
 ### method center.\_\_repr\_\_
 
-**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1611))
+**\_\_repr\_\_():** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1622))
 
 ---
 
 ### function save\_animation
 
-**save\_animation(plots: Sequence[plot], filename: str, upscale: int, downscale: int, bgcolor: ColorLike | None, fps: int, repeat: bool):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1622))
+**save\_animation(plots: Sequence[plot], filename: str, upscale: int, downscale: int, bgcolor: ColorLike | None, fps: int, repeat: bool):** ([source](https://github.com/matomatical/matthewplotlib/blob/main/matthewplotlib/plots.py#L1633))
 
 Supply a list of plots and a filename and this method will create an
 animated gif.

matthewplotlib/__init__.py

@@ -4,7 +4,7 @@
 """
 
 
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 
 
 from matthewplotlib.plots import (

matthewplotlib/plots.py

@@ -1508,13 +1508,18 @@ class wrap(plot):
         The number of columns in the grid. If not provided, it is automatically
         determined based on the terminal width and the width of the largest
         plot.
+    * transpose: optional bool (default False).
+        If False (default), the plots are arranged in reading order, from left
+        to right and then from top to bottom. If True, the plots are arranged
+        in column order, from top to bottom and then from left to right.
     """
     def __init__(
         self,
         *plots: plot,
         cols: int | None = None,
+        transpose: bool = False,
     ):
-        # match size
+        # determine and standardise cell size
         cell_height = max(p.height for p in plots)
         cell_width = max(p.width for p in plots)
         padded_chars = [
@@ -1523,28 +1528,34 @@ def __init__(
                 right=cell_width - p.width,
             ) for p in plots
         ]
+        blank_cell = CharArray.from_size(
+            height=cell_height,
+            width=cell_width,
+        )
 
-        # wrap list
+        # determine grid size and initialise grid
         if cols is None:
             cols = max(1, os.get_terminal_size()[0] // cell_width)
         n = len(padded_chars)
-        wrapped_chars = [padded_chars[i:i+cols] for i in range(0, n, cols)]
-
-        # correct final row
-        if len(wrapped_chars) > 1 and len(wrapped_chars[-1]) < cols:
-            buffer = CharArray.from_size(
-                height=cell_height,
-                width=cell_width * (cols - len(wrapped_chars[-1])),
-            )
-            wrapped_chars[-1].append(buffer)
+        full_rows, spare = divmod(n, cols)
+        rows = full_rows + bool(spare)
+        grid = [[blank_cell for _ in range(cols)] for _ in range(rows)]
+
+        # populate grid
+        for i, p in enumerate(padded_chars):
+            if transpose:
+                c, r = divmod(i, rows)
+            else:
+                r, c = divmod(i, cols)
+            grid[r][c] = p
 
         # combine into new char array
         blocked_chars = CharArray(
-            codes=np.block([[c.codes for c in row] for row in wrapped_chars]),
-            fg=np.block([[c.fg for c in row] for row in wrapped_chars]),
-            fg_rgb=np.block([[[c.fg_rgb] for c in row] for row in wrapped_chars]),
-            bg=np.block([[c.bg for c in row] for row in wrapped_chars]),
-            bg_rgb=np.block([[[c.bg_rgb] for c in row] for row in wrapped_chars]),
+            codes=np.block([[c.codes for c in row] for row in grid]),
+            fg=np.block([[c.fg for c in row] for row in grid]),
+            fg_rgb=np.block([[[c.fg_rgb] for c in row] for row in grid]),
+            bg=np.block([[c.bg for c in row] for row in grid]),
+            bg_rgb=np.block([[[c.bg_rgb] for c in row] for row in grid]),
         )
         super().__init__(blocked_chars)
         self.plots = plots

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "matthewplotlib"
-version = "0.3.1"
+version = "0.3.2"
 authors = [
     { name="Matthew Farrugia-Roberts", email="[email protected]" },
 ]