rgwfuncs 0.0.51__py3-none-any.whl → 0.0.52__py3-none-any.whl

rgwfuncs/__init__.py

@@ -1,7 +1,7 @@
 # This file is automatically generated
 # Dynamically importing functions from modules
 
-from .algebra_lib import cancel_polynomial_expression, compute_constant_expression, compute_constant_expression_involving_matrices, compute_constant_expression_involving_ordered_series, compute_prime_factors, expand_polynomial_expression, factor_polynomial_expression, python_polynomial_expression_to_latex, simplify_polynomial_expression, solve_homogeneous_polynomial_expression
+from .algebra_lib import cancel_polynomial_expression, compute_constant_expression, compute_constant_expression_involving_matrices, compute_constant_expression_involving_ordered_series, compute_prime_factors, expand_polynomial_expression, factor_polynomial_expression, plot_polynomial_functions, python_polynomial_expression_to_latex, simplify_polynomial_expression, solve_homogeneous_polynomial_expression
 from .df_lib import append_columns, append_percentile_classification_column, append_ranged_classification_column, append_ranged_date_classification_column, append_rows, append_xgb_labels, append_xgb_logistic_regression_predictions, append_xgb_regression_predictions, bag_union_join, bottom_n_unique_values, cascade_sort, delete_rows, drop_duplicates, drop_duplicates_retain_first, drop_duplicates_retain_last, filter_dataframe, filter_indian_mobiles, first_n_rows, from_raw_data, insert_dataframe_in_sqlite_database, last_n_rows, left_join, limit_dataframe, load_data_from_path, load_data_from_query, load_data_from_sqlite_path, mask_against_dataframe, mask_against_dataframe_converse, numeric_clean, order_columns, print_correlation, print_dataframe, print_memory_usage, print_n_frequency_cascading, print_n_frequency_linear, rename_columns, retain_columns, right_join, send_data_to_email, send_data_to_slack, send_dataframe_via_telegram, sync_dataframe_to_sqlite_database, top_n_unique_values, union_join, update_rows
 from .docs_lib import docs
 from .interactive_shell_lib import interactive_shell

rgwfuncs/algebra_lib.py

@@ -8,7 +8,12 @@ from sympy.parsing.sympy_parser import parse_expr
 from sympy import __all__ as sympy_functions
 from sympy.parsing.sympy_parser import (standard_transformations, implicit_multiplication_application)
 
-from typing import Tuple, List, Dict, Optional
+from typing import Tuple, List, Dict, Optional, Any
+
+
+import numpy as np
+import matplotlib.pyplot as plt
+from io import BytesIO
 
 
 def compute_prime_factors(n: int) -> str:
@@ -285,7 +290,6 @@ def python_polynomial_expression_to_latex(
     Raises:
     ValueError: If the expression cannot be parsed due to syntax errors.
     """
-
     transformations = standard_transformations + (implicit_multiplication_application,)
 
     def parse_and_convert_expression(expr_str: str, sym_vars: Dict[str, Expr]) -> Expr:
@@ -701,3 +705,145 @@ def solve_homogeneous_polynomial_expression(
 
     except Exception as e:
         raise ValueError(f"Error solving the expression: {e}")
+
+
+def plot_polynomial_functions(
+    functions: List[Dict[str, Dict[str, Any]]],
+    zoom: float = 10.0,
+    show_legend: bool = True
+) -> str:
+    """
+    Plots expressions described by a list of dictionaries of the form:
+        [
+          { "expression_string": { "x": "*", "a":..., "b":... } },
+          { "expression_string": { "x": np.linspace(...), "a":..., ... } },
+          ...
+        ]
+
+    In each top-level dictionary, there is exactly one key (a string
+    representing a Python/NumPy expression) and one value (a dictionary of
+    substitutions). This substitutions dictionary must have an "x" key:
+      • "x": "*"  -> Use a default domain from -zoom..+zoom.
+      • "x": np.array(...)  -> Use that array as the domain.
+    Other variables (like "a", "b", etc.) may also appear in the same dict.
+
+    Additionally, we use latexify_expression(...) to transform the expression
+    into a nice LaTeX form for the legend, including a special Δ notation for np.diff(...).
+
+    Parameters
+    ----------
+    functions : List[Dict[str, Dict[str, Any]]]
+        A list of items. Each item is a dictionary:
+          key   = expression string (e.g., "x**2", "np.diff(x,2)", etc.)
+          value = a dictionary of substitutions. Must contain "x",
+                  either as "*" or a NumPy array. May contain additional
+                  parameters like "a", "b", etc.
+    zoom : float
+        Sets the numeric axis range from -zoom..+zoom in both x and y.
+    show_legend : bool
+        Whether to add a legend to the plot (defaults to True).
+
+    Returns
+    -------
+    str
+        The raw SVG markup of the resulting plot.
+    """
+
+    def latexify_expression(expr_str: str) -> str:
+        # Regex to locate np.diff(...) with an optional second argument
+        DIFF_PATTERN = r"np\.diff\s*\(\s*([^,\)]+)(?:,\s*(\d+))?\)"
+
+        def diff_replacer(match: re.Match) -> str:
+            inside = match.group(1).strip()
+            exponent = match.group(2)
+            inside_no_np = inside.replace("np.", "")
+            if exponent:
+                return rf"\Delta^{exponent}\left({inside_no_np}\right)"
+            else:
+                return rf"\Delta\left({inside_no_np}\right)"
+
+        expr_tmp = re.sub(DIFF_PATTERN, diff_replacer, expr_str)
+        expr_tmp = expr_tmp.replace("np.", "")
+        try:
+            latex_expr = python_polynomial_expression_to_latex(expr_tmp)
+            return latex_expr
+        except Exception:
+            # Fallback: just do naive **
+            return expr_tmp.replace("**", "^")
+
+    buffer = BytesIO()
+    fig, ax = plt.subplots()
+
+    for entry in functions:
+        if len(entry) != 1:
+            print("Skipping invalid item. Must have exactly 1 expression->substitutions pair.")
+            continue
+
+        expression, sub_dict = list(entry.items())[0]
+        if "x" not in sub_dict:
+            print(f"Skipping '{expression}' because sub-dict lacks 'x' key.")
+            continue
+
+        # If "x" is "*", create a default domain
+        x_val = sub_dict["x"]
+        if isinstance(x_val, str) and x_val == "*":
+            x_values = np.linspace(-zoom, zoom, 1201)
+            sub_dict["x"] = x_values
+        elif isinstance(x_val, np.ndarray):
+            x_values = x_val
+        else:
+            print(f"Skipping '{expression}' because 'x' is neither '*' nor a NumPy array.")
+            continue
+
+        # Evaluate the expression
+        try:
+            eval_context = {"np": np}
+            eval_context.update(sub_dict)
+            y_values = eval(expression, {"np": np}, eval_context)
+        except Exception as e:
+            print(f"Error evaluating expression '{expression}': {e}")
+            continue
+
+        if not isinstance(y_values, np.ndarray):
+            print(f"Skipping '{expression}' because it did not produce a NumPy array.")
+            continue
+
+        # If y_values is shorter than x_values (like np.diff), truncate x
+        if len(y_values) < len(x_values):
+            x_values = x_values[:len(y_values)]
+
+        # Convert expression to a nice LaTeX string
+        label_expr = latexify_expression(expression)
+        ax.plot(x_values, y_values, label=rf"${label_expr}$")
+
+    # Configure axes
+    ax.set_xlim(-zoom, zoom)
+    ax.set_ylim(-zoom, zoom)
+    ax.spines['left'].set_position('zero')
+    ax.spines['bottom'].set_position('zero')
+    ax.spines['right'].set_color('none')
+    ax.spines['top'].set_color('none')
+    ax.set_aspect('equal', 'box')
+    ax.xaxis.set_ticks_position('bottom')
+    ax.yaxis.set_ticks_position('left')
+    ax.grid(True)
+
+    # Show legend
+    if show_legend:
+        leg = ax.legend(
+            loc='upper center',
+            bbox_to_anchor=(0.5, -0.03),
+            fancybox=True,
+            shadow=True,
+            ncol=1
+        )
+        plt.savefig(
+            buffer,
+            format='svg',
+            bbox_inches='tight',
+            bbox_extra_artists=[leg]  # ensures the legend is fully captured
+        )
+    else:
+        plt.savefig(buffer, format='svg', bbox_inches='tight')
+    plt.close(fig)
+    return buffer.getvalue().decode('utf-8')

{rgwfuncs-0.0.51.dist-info → rgwfuncs-0.0.52.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.51
+Version: 0.0.52
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -514,6 +514,45 @@ Solves a homogeneous polynomial expression for a specified variable and returns
     
 --------------------------------------------------------------------------------
 
+### 11. `plot_polynomial_functions`
+
+This function plots polynomial functions described by a list of expressions and their corresponding substitution dictionaries. It generates SVG markup of the plots, with options for specifying the domain, axis zoom, and legend display.
+
+• Parameters:
+- `functions` (`List[Dict[str, Dict[str, Any]]]`): A list of dictionaries, each containing:
+  - A key which is a string representing a Python/NumPy expression (e.g., `"x**2"`, `"np.diff(x,2)"`).
+  - A value which is a dictionary containing substitutions for the expression. Must include an `"x"` key, either as `"*"` for default domain or a NumPy array.
+- `zoom` (`float`): Determines the numeric axis range from `-zoom` to `+zoom` for both x and y axes (default is `10.0`).
+- `show_legend` (`bool`): Specifies whether to include a legend in the plot (default is `True`).
+
+• Returns:
+- `str`: The raw SVG markup of the resulting plot.
+
+• Example:
+
+    import subprocess
+    from rgwfuncs import plot_polynomial_functions
+
+    # Generate the SVG
+    plot_svg_string = plot_polynomial_functions(
+        functions=[
+            {"x**2": {"x": "*"}},  # Single expression, "*" means plot all discernable points
+            {"x**2/(2 + a) + a": {"x": np.linspace(-3, 4, 101), "a": 1.23}},
+            {"np.diff(x**3, 2)": {"x": np.linspace(-2, 2, 10)}}
+        ],
+        zoom=2
+    )
+
+    # Write the SVG to an actual file
+    with open("plot.svg", "w", encoding="utf-8") as file:
+        file.write(plot_svg_string)
+
+• Displaying the SVG:
+
+![Plot](./media/plot_polynomial_functions_example_1.svg)
+
+--------------------------------------------------------------------------------
+
 ## String Based Functions
 
 ### 1. send_telegram_message

rgwfuncs-0.0.52.dist-info/RECORD

@@ -0,0 +1,12 @@
+rgwfuncs/__init__.py,sha256=JjkuVeRV_Bkw8vnqSbJsRcYQRm4iCI3futR86cf3tRI,1637
+rgwfuncs/algebra_lib.py,sha256=-Q2W63EtRLhwOvGGFuf8KUKVuoLA72ONt-wPhcX6R94,33408
+rgwfuncs/df_lib.py,sha256=qqRQdakheLy8wMZRBfHwKyIp8DmdZIWfAiLKWgq03QU,68977
+rgwfuncs/docs_lib.py,sha256=y3wSAOPO3qsA4HZ7xAtW8HimM8w-c8hjcEzMRLJ96ao,1960
+rgwfuncs/interactive_shell_lib.py,sha256=A7EWsYxAfDev_N0-2GjRvAtp0bAwBPHIczXb8Gu9fzI,1107
+rgwfuncs/str_lib.py,sha256=rtAdRlnSJIu3JhI-tA_A0wCiPK2m-zn5RoGpBxv_g-4,2228
+rgwfuncs-0.0.52.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
+rgwfuncs-0.0.52.dist-info/METADATA,sha256=ByUIjumG8zZCcuKbS0d9Ipq5VH0rBfAAumeRHQ5SR90,56826
+rgwfuncs-0.0.52.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+rgwfuncs-0.0.52.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
+rgwfuncs-0.0.52.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
+rgwfuncs-0.0.52.dist-info/RECORD,,

rgwfuncs-0.0.51.dist-info/RECORD

@@ -1,12 +0,0 @@
-rgwfuncs/__init__.py,sha256=vs8xv3IVx7KGpPxEXrIePD3gb_QI1XTXpD_n9817foA,1610
-rgwfuncs/algebra_lib.py,sha256=sLQUxXG4mNNO55XclTgIrwVrg5LbwELOFsiSAm_9G20,28212
-rgwfuncs/df_lib.py,sha256=qqRQdakheLy8wMZRBfHwKyIp8DmdZIWfAiLKWgq03QU,68977
-rgwfuncs/docs_lib.py,sha256=y3wSAOPO3qsA4HZ7xAtW8HimM8w-c8hjcEzMRLJ96ao,1960
-rgwfuncs/interactive_shell_lib.py,sha256=A7EWsYxAfDev_N0-2GjRvAtp0bAwBPHIczXb8Gu9fzI,1107
-rgwfuncs/str_lib.py,sha256=rtAdRlnSJIu3JhI-tA_A0wCiPK2m-zn5RoGpBxv_g-4,2228
-rgwfuncs-0.0.51.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-rgwfuncs-0.0.51.dist-info/METADATA,sha256=Q-t10jPxJYG_orABThvIy6q1-WQvwOYwe_3TNLuLYRw,55152
-rgwfuncs-0.0.51.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-rgwfuncs-0.0.51.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
-rgwfuncs-0.0.51.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
-rgwfuncs-0.0.51.dist-info/RECORD,,