onekit 2.1.1__tar.gz → 2.2.1__tar.gz

{onekit-2.1.1 → onekit-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: onekit
-Version: 2.1.1
+Version: 2.2.1
 Summary: All-in-One Python Kit.
 License: BSD 3-Clause
 Keywords: onekit

{onekit-2.1.1 → onekit-2.2.1}/pyproject.toml

@@ -22,7 +22,7 @@ requires-python = ">=3.11"
 dependencies = []
 
 [tool.poetry]
-version = "2.1.1"
+version = "2.2.1"
 
 [project.optional-dependencies]
 base = [

{onekit-2.1.1 → onekit-2.2.1}/src/onekit/vizkit.py

@@ -13,6 +13,9 @@ from mpl_toolkits.axes_grid1 import make_axes_locatable
 from mpl_toolkits.mplot3d.axes3d import Axes3D
 
 from onekit import numpykit as npk
+from onekit import pythonkit as pk
+
+ArrayLike = npt.ArrayLike
 
 __all__ = (
     "Config",
@@ -21,6 +24,7 @@ __all__ = (
     "create_xyz_points",
     "discrete_cmap",
     "plot_contour",
+    "plot_digitscale",
     "plot_line",
     "plot_surface",
     "plot_xy_points",
@@ -481,6 +485,71 @@ def plot_contour(
     return ax
 
 
+def plot_digitscale(
+    x: ArrayLike,
+    y: ArrayLike | None = None,
+    cmap_name: str = "YlOrBr_r",
+    kws_plot: dict[str, str] | None = None,
+    ax=None,
+) -> Axes:
+    """Plot a digit-scaled version of :math:`y` against :math:`x`.
+
+    See Also
+    --------
+    onekit.mathkit.digitscale : Python version
+
+    Examples
+    --------
+    >>> from onekit import mathkit as mk
+    >>> from onekit import vizkit as vk
+    >>> vk.plot_digitscale(tuple(mk.collatz(27)))  # doctest: +SKIP
+    """
+    ax = ax or plt.gca()
+
+    kwargs_plot = dict(marker=".", color="black")
+    kwargs_plot.update(kws_plot or dict())
+    for k in ["x", "y"]:
+        kwargs_plot.pop(k, None)
+
+    if y is None:
+        y = x
+        x = np.arange(len(y))
+
+    y_values = np.asarray(y)
+    y_scaled = npk.digitscale(y_values)
+    ax.plot(x, y_scaled, **kwargs_plot)
+    x_limits = ax.get_xlim()
+
+    y_min = int(np.floor(y_scaled.min()))
+    y_max = int(np.ceil(y_scaled.max()))
+    y_range = tuple(range(y_min, y_max))
+    colors = discrete_cmap(y_max, name=cmap_name, lower_bound=0.2, upper_bound=0.8)
+
+    for i, yi in enumerate(y_range):
+        ax.fill_between(x_limits, yi, yi + 1, color=colors[i], alpha=0.3)
+
+    ax.set_xlim(x_limits)
+    ax.set_yticks(y_range)
+
+    ax.set_xlabel("index")
+    ax.set_ylabel("num_digits(orig_value)", labelpad=6)
+
+    ax.set_title(
+        pk.concat_strings(
+            ", ",
+            f"mean={pk.num_to_str(y_values.mean())}",
+            f"median={pk.num_to_str(float(np.median(y_values)))}",
+            f"std={pk.num_to_str(y_values.std(ddof=1))}",
+            f"min={pk.num_to_str(y_values.min())}",
+            f"max={pk.num_to_str(y_values.max())}",
+        ),
+        size="medium",
+        pad=12,
+    )
+
+    return ax
+
+
 def plot_line(xy_pts: XyPoints, /, *, kws_plot=None, ax=None) -> Axes:
     """Plot :math:`y` versus :math:`x` as line.