rgwfuncs 0.0.56__py3-none-any.whl → 0.0.57__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, plot_polynomial_functions, 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, plot_x_points_of_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

@@ -744,11 +744,11 @@ def plot_polynomial_functions(
     show_legend : bool
         Whether to add a legend to the plot (defaults to True).
     open_file : bool
-        If saving to path is not desirable, opens the SVG as a temp file;  
-        otherwise opens the file from the actual location using the system's  
+        If saving to path is not desirable, opens the SVG as a temp file;
+        otherwise opens the file from the actual location using the system's
         default viewer (defaults to False).
     save_path : Optional[str]
-        If specified, saves the output string as a .svg at the indicated path  
+        If specified, saves the output string as a .svg at the indicated path
         (defaults to None).
 
     Returns
@@ -899,3 +899,166 @@ def plot_polynomial_functions(
 
     return svg_string
 
+
+def plot_x_points_of_polynomial_functions(
+    functions: List[Dict[str, Dict[str, Any]]],
+    zoom: float = 10.0,
+    show_legend: bool = True,
+    open_file: bool = False,
+    save_path: Optional[str] = None,
+) -> str:
+    """
+    Plots one or more expressions described by a list of dictionaries. For each
+    item in the list, the function evaluates the given Python/NumPy expression
+    at the specified x-values (converted to NumPy arrays if they are Python lists)
+    and plots the resulting points on a single figure.
+
+    Parameters
+    ----------
+    functions : List[Dict[str, Dict[str, Any]]] A list of one or more items,
+    each of which has exactly one key-value pair:
+        - Key (`str`): A valid Python/NumPy expression (e.g., `x**2`,
+          `np.sin(x)`, `x - a`).
+        - Value (`Dict[str, Any]`): Must assign `x` a value
+    zoom : float, optional
+        Determines the numeric axis range from -zoom..+zoom in both x and y
+        (default is 10.0).
+    show_legend : bool, optional
+        Whether to include a legend in the plot (default is True).
+    open_file : bool, optional
+        If saving to path is not desirable, opens the SVG as a temp file;
+        otherwise opens the file from the indicated path using the system's
+        default viewer (defaults to False).
+    save_path : Optional[str], optional
+        If specified, saves the output SVG at the given path (defaults to None).
+
+    Returns
+    -------
+    str
+        The raw SVG markup of the resulting scatter 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.", "")
+
+        # Attempt to convert basic Pythonic polynomial expressions into LaTeX
+        try:
+            from python_latex_helpers import python_polynomial_expression_to_latex
+            latex_expr = python_polynomial_expression_to_latex(expr_tmp)
+            return latex_expr
+        except Exception:
+            # Fallback: naive ** -> ^
+            return expr_tmp.replace("**", "^")
+
+    def handle_open_and_save(svg_string: str, open_it: bool, path: Optional[str]) -> None:
+        # Save the SVG to a file if a path is provided
+        if path:
+            try:
+                with open(path, 'w', encoding='utf-8') as file:
+                    file.write(svg_string)
+                print(f"[INFO] SVG saved to: {path}")
+            except IOError as e:
+                print(f"[ERROR] Failed to save SVG to {path}. IOError: {e}")
+
+        # Handle opening the file if requested
+        if open_it and path:
+            result = subprocess.run(["xdg-open", path], stderr=subprocess.DEVNULL)
+            if result.returncode != 0:
+                print("[ERROR] Failed to open the SVG file with the default viewer.")
+        elif open_it:
+            with tempfile.NamedTemporaryFile(delete=False, suffix=".svg") as tmpfile:
+                temp_svg_path = tmpfile.name
+                tmpfile.write(svg_string.encode('utf-8'))
+            result = subprocess.run(["xdg-open", temp_svg_path], stderr=subprocess.DEVNULL)
+            if result.returncode != 0:
+                print("[ERROR] Failed to open the SVG file with the default viewer.")
+
+    # Set up a buffer for the SVG output
+    buffer = BytesIO()
+    fig, ax = plt.subplots()
+
+    # Iterate over each expression-substitution dictionary
+    for item in functions:
+        # Each entry in 'functions' must have exactly one key-value pair
+        if len(item) != 1:
+            print("[WARNING] Skipping invalid item. It must have exactly 1 expression->substitutions pair.")
+            continue
+
+        expression, sub_dict = next(iter(item.items()))
+
+        # Ensure 'x' is present
+        if "x" not in sub_dict:
+            print(f"[WARNING] Skipping '{expression}' because there is no 'x' key.")
+            continue
+
+        x_vals = sub_dict["x"]
+        # Convert to numpy array if needed
+        if not isinstance(x_vals, np.ndarray):
+            x_vals = np.array(x_vals)
+
+        # Evaluate expression with the given variables
+        try:
+            eval_context = {"np": np}
+            eval_context.update(sub_dict)  # put all user-provided variables in the context
+            y_vals = eval(expression, {"np": np}, eval_context)
+        except Exception as e:
+            print(f"[ERROR] Could not evaluate expression '{expression}': {e}")
+            continue
+
+        # Convert y-values to a numpy array if needed
+        if not isinstance(y_vals, np.ndarray):
+            y_vals = np.array(y_vals)
+
+        # Prepare label (LaTeXified)
+        label_expr = latexify_expression(expression)
+
+        # Scatter plot
+        ax.scatter(x_vals, y_vals, label=rf"${label_expr}$")
+
+    # Configure axes
+    ax.set_xlim(-zoom, zoom)
+    ax.set_ylim(-zoom, zoom)
+
+    # Place spines at center (optional styling preference)
+    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.xaxis.set_ticks_position('bottom')
+    ax.yaxis.set_ticks_position('left')
+    ax.set_aspect('equal', 'box')
+    ax.grid(True)
+
+    # If requested, show the 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])
+    else:
+        plt.savefig(buffer, format='svg', bbox_inches='tight')
+
+    plt.close(fig)
+    svg_string = buffer.getvalue().decode('utf-8')
+
+    # Optionally open/save the file
+    handle_open_and_save(svg_string, open_file, save_path)
+
+    return svg_string

{rgwfuncs-0.0.56.dist-info → rgwfuncs-0.0.57.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.56
+Version: 0.0.57
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -541,19 +541,60 @@ This function plots polynomial functions described by a list of expressions and
             {"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
+        zoom=2,
+        open_file=True,
+        save_path="plot_polynomial_functions_example_1.svg"
     )
 
-    # 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)
 
 --------------------------------------------------------------------------------
 
+media/plot_x_points_of_polynomial_functions_example_5.svg
+
+### 12. `plot_x_points_of_polynomial_functions`
+
+This function plots one or more expressions described by a list of dictionaries. For each item in the list, the function evaluates the given Python/NumPy expression at the specified x-values (converted to NumPy arrays if they are Python lists) and plots the resulting points on a single figure.
+
+• Parameters:  
+- `functions` (`List[Dict[str, Dict[str, Any]]]`): A list of one or more items, each of which has exactly one key-value pair:  
+  - Key (`str`): A valid Python/NumPy expression (e.g., `x**2`, `np.sin(x)`, `x - a`).  
+  - Value (`Dict[str, Any]`): Must assign `x` a value
+- `zoom` (`float`):  Numeric range from -zoom to +zoom on both x and y axes (default 10.0).  
+- `show_legend` (`bool`): If True, includes a legend (default True).  
+- `open_file` (bool):
+  - If True and `save_path` is given, opens that file with the system viewer.  
+  - If True and `save_path` is None, writes to a temporary file and opens it (default False).  
+- `save_path` (`Optional[str]`): If specified, writes the resulting SVG to this path (default None).  
+
+• Returns:  
+- `str`: The raw SVG markup of the resulting scatter plot.
+
+• Example:
+
+    from rgwfuncs import plot_x_points_of_polynomial_functions
+    import numpy as np
+
+    svg_output = plot_x_points_of_polynomial_functions(
+        functions=[
+            {"x**2": {"x": np.array([-2, -1, 0, 1, 2])}},
+            {"np.sin(x)": {"x": np.linspace(0, 2*np.pi, 5)}},
+            {"x - 3": {"x": np.array([-2, 0, 2, 4, 6])}}
+        ],
+        zoom=6,
+        show_legend=True,
+        open_file=True,
+        save_path="plot_x_points_of_polynomial_functions_example_5.svg"
+    )
+
+• Displaying the SVG:
+
+![Plot](./media/plot_x_points_of_polynomial_functions_example_5.svg)
+
+--------------------------------------------------------------------------------
+
 ## String Based Functions
 
 ### 1. send_telegram_message

rgwfuncs-0.0.57.dist-info/RECORD

@@ -0,0 +1,12 @@
+rgwfuncs/__init__.py,sha256=-rcdj4_9zq82h0Tl00S9GvEqDYh7yhPCNhnhBs3mZCg,1676
+rgwfuncs/algebra_lib.py,sha256=rKFITfpWfgdBswnbMUuS41XgndEt-jUVz2ObO_ik7eM,42234
+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.57.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
+rgwfuncs-0.0.57.dist-info/METADATA,sha256=DaC1s1J3mT_4GEnxmmCq6CA418CbkuAT0myFCDNpbik,59010
+rgwfuncs-0.0.57.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+rgwfuncs-0.0.57.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
+rgwfuncs-0.0.57.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
+rgwfuncs-0.0.57.dist-info/RECORD,,

rgwfuncs-0.0.56.dist-info/RECORD

@@ -1,12 +0,0 @@
-rgwfuncs/__init__.py,sha256=JjkuVeRV_Bkw8vnqSbJsRcYQRm4iCI3futR86cf3tRI,1637
-rgwfuncs/algebra_lib.py,sha256=b6I553GoY9n6oXinvNzY6P6CvI6za_Bc69PbkaYEqpo,35955
-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.56.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-rgwfuncs-0.0.56.dist-info/METADATA,sha256=mAxOqfOPI-cMo-FpTnKHUC_Hi-yoPDb2xHjQdpKN41U,57136
-rgwfuncs-0.0.56.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-rgwfuncs-0.0.56.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
-rgwfuncs-0.0.56.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
-rgwfuncs-0.0.56.dist-info/RECORD,,