rgwfuncs 0.0.29__tar.gz → 0.0.30__tar.gz

{rgwfuncs-0.0.29/src/rgwfuncs.egg-info → rgwfuncs-0.0.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.29
+Version: 0.0.30
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -154,7 +154,47 @@ Print a list of available function names in alphabetical order. If a filter is p
 
 This section provides comprehensive functions for handling algebraic expressions, performing tasks such as computation, simplification, solving equations, and prime factorization, all outputted in LaTeX format.
 
-### 1. `compute_constant_expression`
+### 1. `python_polynomial_expression_to_latex`
+
+Converts a polynomial expression written in Python syntax to a LaTeX formatted string. This function parses algebraic expressions provided as strings using Python’s syntax and translates them into equivalent LaTeX representations, making them suitable for academic or professional documentation. The function supports inclusion of named variables, with an option to substitute specific values into the expression.
+
+• Parameters:
+  - `expression` (str): The algebraic expression to convert to LaTeX. This should be a string formatted with Python syntax acceptable by SymPy.
+  - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers with which to substitute those variables.
+
+• Returns:
+  - `str`: The LaTeX formatted string equivalent to the provided expression.
+
+• Raises:
+  - `ValueError`: If the expression cannot be parsed due to syntax errors.
+
+• Example:
+
+    from rgwfuncs import python_polynomial_expression_to_latex
+    
+    # Convert a simple polynomial expression to LaTeX format
+    latex_result1 = python_polynomial_expression_to_latex("x**2 + y**2")
+    print(latex_result1)  # Output: "x^{2} + y^{2}"
+    
+    # Convert polynomial expression with substituted values
+    latex_result2 = python_polynomial_expression_to_latex("x**2 + y**2", {"x": 3, "y": 4})
+    print(latex_result2)  # Output: "25"
+    
+    # Another example with partial substitution
+    latex_result3 = python_polynomial_expression_to_latex("x**2 + y**2", {"x": 3})
+    print(latex_result3)  # Output: "y^{2} + 9"
+    
+    # Trigonometric functions included with symbolic variables
+    latex_result4 = python_polynomial_expression_to_latex("sin(x+z**2) + cos(y)", {"x": 55})
+    print(latex_result4)  # Output: "cos y + sin \\left(z^{2} + 55\\right)"
+    
+    # Simplified trigonometric functions example with substitution
+    latex_result5 = python_polynomial_expression_to_latex("sin(x) + cos(y)", {"x": 0})
+    print(latex_result5)  # Output: "cos y"
+
+--------------------------------------------------------------------------------
+
+### 2. `compute_constant_expression`
 
 Computes the numerical result of a given expression, which can evaluate to a constant, represented as a float. Evaluates an constant expression provided as a string and returns the computed result. Supports various arithmetic operations, including addition, subtraction, multiplication, division, and modulo, as well as mathematical functions from the math module.
 
@@ -178,7 +218,7 @@ Computes the numerical result of a given expression, which can evaluate to a con
 
 --------------------------------------------------------------------------------
 
-### 2. `simplify_polynomial_expression`
+### 3. `simplify_polynomial_expression`
 
 Simplifies an algebraic expression in polynomial form and returns it in LaTeX format. Takes an algebraic expression, in polynomial form, written in Python syntax and simplifies it. The result is returned as a LaTeX formatted string, suitable for academic or professional documentation.
 
@@ -211,7 +251,7 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 --------------------------------------------------------------------------------
 
-### 3. `solve_homogeneous_polynomial_expression`
+### 4. `solve_homogeneous_polynomial_expression`
 
 Solves a homogeneous polynomial expression for a specified variable and returns solutions in LaTeX format. Assumes that the expression is homoegeneous (i.e. equal to zero), and solves for a designated variable. May optionally include substitutions for other variables in the equation. The solutions are provided as a LaTeX formatted string. The method solves equations for specified variables, with optional substitutions, returning LaTeX-formatted solutions.
 
@@ -234,7 +274,7 @@ Solves a homogeneous polynomial expression for a specified variable and returns
     
 --------------------------------------------------------------------------------
 
-### 4. `get_prime_factors_latex`
+### 5. `get_prime_factors_latex`
 
 Computes prime factors of a number and presents them in LaTeX format.
 
@@ -258,7 +298,7 @@ Computes prime factors of a number and presents them in LaTeX format.
  
 --------------------------------------------------------------------------------
 
-### 5. `compute_matrix_expression`
+### 6. `compute_matrix_expression`
 
 Computes the results of expressions containing 1D or 2D matrix operations and formats them as LaTeX strings.
 
@@ -286,7 +326,7 @@ Computes the results of expressions containing 1D or 2D matrix operations and fo
 
 --------------------------------------------------------------------------------
 
-### 6. `compute_ordered_series_expression`
+### 7. `compute_ordered_series_expression`
 
 Computes the result of expressions containing operations on ordered series expressed as 1D lists. The syntax of the expression supports the discrete difference operator via the `ddd()` method.
 

{rgwfuncs-0.0.29 → rgwfuncs-0.0.30}/README.md

@@ -128,7 +128,47 @@ Print a list of available function names in alphabetical order. If a filter is p
 
 This section provides comprehensive functions for handling algebraic expressions, performing tasks such as computation, simplification, solving equations, and prime factorization, all outputted in LaTeX format.
 
-### 1. `compute_constant_expression`
+### 1. `python_polynomial_expression_to_latex`
+
+Converts a polynomial expression written in Python syntax to a LaTeX formatted string. This function parses algebraic expressions provided as strings using Python’s syntax and translates them into equivalent LaTeX representations, making them suitable for academic or professional documentation. The function supports inclusion of named variables, with an option to substitute specific values into the expression.
+
+• Parameters:
+  - `expression` (str): The algebraic expression to convert to LaTeX. This should be a string formatted with Python syntax acceptable by SymPy.
+  - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers with which to substitute those variables.
+
+• Returns:
+  - `str`: The LaTeX formatted string equivalent to the provided expression.
+
+• Raises:
+  - `ValueError`: If the expression cannot be parsed due to syntax errors.
+
+• Example:
+
+    from rgwfuncs import python_polynomial_expression_to_latex
+    
+    # Convert a simple polynomial expression to LaTeX format
+    latex_result1 = python_polynomial_expression_to_latex("x**2 + y**2")
+    print(latex_result1)  # Output: "x^{2} + y^{2}"
+    
+    # Convert polynomial expression with substituted values
+    latex_result2 = python_polynomial_expression_to_latex("x**2 + y**2", {"x": 3, "y": 4})
+    print(latex_result2)  # Output: "25"
+    
+    # Another example with partial substitution
+    latex_result3 = python_polynomial_expression_to_latex("x**2 + y**2", {"x": 3})
+    print(latex_result3)  # Output: "y^{2} + 9"
+    
+    # Trigonometric functions included with symbolic variables
+    latex_result4 = python_polynomial_expression_to_latex("sin(x+z**2) + cos(y)", {"x": 55})
+    print(latex_result4)  # Output: "cos y + sin \\left(z^{2} + 55\\right)"
+    
+    # Simplified trigonometric functions example with substitution
+    latex_result5 = python_polynomial_expression_to_latex("sin(x) + cos(y)", {"x": 0})
+    print(latex_result5)  # Output: "cos y"
+
+--------------------------------------------------------------------------------
+
+### 2. `compute_constant_expression`
 
 Computes the numerical result of a given expression, which can evaluate to a constant, represented as a float. Evaluates an constant expression provided as a string and returns the computed result. Supports various arithmetic operations, including addition, subtraction, multiplication, division, and modulo, as well as mathematical functions from the math module.
 
@@ -152,7 +192,7 @@ Computes the numerical result of a given expression, which can evaluate to a con
 
 --------------------------------------------------------------------------------
 
-### 2. `simplify_polynomial_expression`
+### 3. `simplify_polynomial_expression`
 
 Simplifies an algebraic expression in polynomial form and returns it in LaTeX format. Takes an algebraic expression, in polynomial form, written in Python syntax and simplifies it. The result is returned as a LaTeX formatted string, suitable for academic or professional documentation.
 
@@ -185,7 +225,7 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 --------------------------------------------------------------------------------
 
-### 3. `solve_homogeneous_polynomial_expression`
+### 4. `solve_homogeneous_polynomial_expression`
 
 Solves a homogeneous polynomial expression for a specified variable and returns solutions in LaTeX format. Assumes that the expression is homoegeneous (i.e. equal to zero), and solves for a designated variable. May optionally include substitutions for other variables in the equation. The solutions are provided as a LaTeX formatted string. The method solves equations for specified variables, with optional substitutions, returning LaTeX-formatted solutions.
 
@@ -208,7 +248,7 @@ Solves a homogeneous polynomial expression for a specified variable and returns
     
 --------------------------------------------------------------------------------
 
-### 4. `get_prime_factors_latex`
+### 5. `get_prime_factors_latex`
 
 Computes prime factors of a number and presents them in LaTeX format.
 
@@ -232,7 +272,7 @@ Computes prime factors of a number and presents them in LaTeX format.
  
 --------------------------------------------------------------------------------
 
-### 5. `compute_matrix_expression`
+### 6. `compute_matrix_expression`
 
 Computes the results of expressions containing 1D or 2D matrix operations and formats them as LaTeX strings.
 
@@ -260,7 +300,7 @@ Computes the results of expressions containing 1D or 2D matrix operations and fo
 
 --------------------------------------------------------------------------------
 
-### 6. `compute_ordered_series_expression`
+### 7. `compute_ordered_series_expression`
 
 Computes the result of expressions containing operations on ordered series expressed as 1D lists. The syntax of the expression supports the discrete difference operator via the `ddd()` method.
 

{rgwfuncs-0.0.29 → rgwfuncs-0.0.30}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rgwfuncs"
-version = "0.0.29"
+version = "0.0.30"
 authors = [
   { name = "Ryan Gerard Wilson", email = "ryangerardwilson@gmail.com" },
 ]

{rgwfuncs-0.0.29 → rgwfuncs-0.0.30}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = rgwfuncs
-version = 0.0.29
+version = 0.0.30
 author = Ryan Gerard Wilson
 author_email = ryangerardwilson@gmail.com
 description = A functional programming paradigm for mathematical modelling and data science

{rgwfuncs-0.0.29 → rgwfuncs-0.0.30}/src/rgwfuncs/__init__.py

@@ -1,7 +1,7 @@
 # This file is automatically generated
 # Dynamically importing functions from modules
 
-from .algebra_lib import compute_constant_expression, compute_matrix_expression, compute_ordered_series_expression, get_prime_factors_latex, simplify_polynomial_expression, solve_homogeneous_polynomial_expression
+from .algebra_lib import compute_constant_expression, compute_matrix_expression, compute_ordered_series_expression, get_prime_factors_latex, 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 .str_lib import send_telegram_message

{rgwfuncs-0.0.29 → rgwfuncs-0.0.30}/src/rgwfuncs/algebra_lib.py

@@ -4,6 +4,9 @@ import ast
 # import numpy as np
 from sympy import symbols, latex, simplify, solve, diff, Expr
 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
 
 
@@ -37,6 +40,67 @@ def compute_constant_expression(expression: str) -> float:
         raise ValueError(f"Error computing expression: {e}")
 
 
+def python_polynomial_expression_to_latex(
+    expression: str,
+    subs: Optional[Dict[str, float]] = None
+) -> str:
+    """
+    Converts a polynomial expression written in Python syntax to LaTeX format.
+
+    This function takes an algebraic expression written in Python syntax and converts it
+    to a LaTeX formatted string. The expression is assumed to be in terms acceptable by
+    sympy, with named variables, and optionally includes substitutions for variables.
+
+    Parameters:
+    expression (str): The algebraic expression to convert to LaTeX. The expression should
+                      be written using Python syntax.
+    subs (Optional[Dict[str, float]]): An optional dictionary of substitutions for variables
+                                       in the expression.
+
+    Returns:
+    str: The expression represented as a LaTeX string.
+
+    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:
+        try:
+            # Parse with transformations to handle implicit multiplication
+            expr = parse_expr(expr_str, local_dict=sym_vars, transformations=transformations)
+            if subs:
+                subs_symbols = {symbols(k): v for k, v in subs.items()}
+                expr = expr.subs(subs_symbols)
+            return expr
+        except (SyntaxError, ValueError, TypeError) as e:
+            raise ValueError(f"Error parsing expression: {expr_str}. Error: {e}")
+
+    # Extract variable names used in the expression
+    variable_names = set(re.findall(r'\b[a-zA-Z]\w*\b', expression))
+    sym_vars = {var: symbols(var) for var in variable_names}
+
+    # Import all general function names from SymPy into local scope
+
+    # Dynamically add SymPy functions to the symbol dictionary
+    for func_name in sympy_functions:
+        try:
+            candidate = globals().get(func_name) or locals().get(func_name)
+            if callable(candidate):  # Ensure it's actually a callable
+                sym_vars[func_name] = candidate
+        except KeyError:
+            continue  # Skip any non-callable or unavailable items
+
+    # Attempt to parse the expression
+    expr = parse_and_convert_expression(expression, sym_vars)
+
+    # Convert the expression to LaTeX format
+    latex_result = latex(expr)
+    return latex_result
+
+
+
 def simplify_polynomial_expression(
     expression: str,
     subs: Optional[Dict[str, float]] = None

{rgwfuncs-0.0.29 → rgwfuncs-0.0.30/src/rgwfuncs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.29
+Version: 0.0.30
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -154,7 +154,47 @@ Print a list of available function names in alphabetical order. If a filter is p
 
 This section provides comprehensive functions for handling algebraic expressions, performing tasks such as computation, simplification, solving equations, and prime factorization, all outputted in LaTeX format.
 
-### 1. `compute_constant_expression`
+### 1. `python_polynomial_expression_to_latex`
+
+Converts a polynomial expression written in Python syntax to a LaTeX formatted string. This function parses algebraic expressions provided as strings using Python’s syntax and translates them into equivalent LaTeX representations, making them suitable for academic or professional documentation. The function supports inclusion of named variables, with an option to substitute specific values into the expression.
+
+• Parameters:
+  - `expression` (str): The algebraic expression to convert to LaTeX. This should be a string formatted with Python syntax acceptable by SymPy.
+  - `subs` (Optional[Dict[str, float]]): An optional dictionary of substitutions where the keys are variable names in the expression, and the values are the numbers with which to substitute those variables.
+
+• Returns:
+  - `str`: The LaTeX formatted string equivalent to the provided expression.
+
+• Raises:
+  - `ValueError`: If the expression cannot be parsed due to syntax errors.
+
+• Example:
+
+    from rgwfuncs import python_polynomial_expression_to_latex
+    
+    # Convert a simple polynomial expression to LaTeX format
+    latex_result1 = python_polynomial_expression_to_latex("x**2 + y**2")
+    print(latex_result1)  # Output: "x^{2} + y^{2}"
+    
+    # Convert polynomial expression with substituted values
+    latex_result2 = python_polynomial_expression_to_latex("x**2 + y**2", {"x": 3, "y": 4})
+    print(latex_result2)  # Output: "25"
+    
+    # Another example with partial substitution
+    latex_result3 = python_polynomial_expression_to_latex("x**2 + y**2", {"x": 3})
+    print(latex_result3)  # Output: "y^{2} + 9"
+    
+    # Trigonometric functions included with symbolic variables
+    latex_result4 = python_polynomial_expression_to_latex("sin(x+z**2) + cos(y)", {"x": 55})
+    print(latex_result4)  # Output: "cos y + sin \\left(z^{2} + 55\\right)"
+    
+    # Simplified trigonometric functions example with substitution
+    latex_result5 = python_polynomial_expression_to_latex("sin(x) + cos(y)", {"x": 0})
+    print(latex_result5)  # Output: "cos y"
+
+--------------------------------------------------------------------------------
+
+### 2. `compute_constant_expression`
 
 Computes the numerical result of a given expression, which can evaluate to a constant, represented as a float. Evaluates an constant expression provided as a string and returns the computed result. Supports various arithmetic operations, including addition, subtraction, multiplication, division, and modulo, as well as mathematical functions from the math module.
 
@@ -178,7 +218,7 @@ Computes the numerical result of a given expression, which can evaluate to a con
 
 --------------------------------------------------------------------------------
 
-### 2. `simplify_polynomial_expression`
+### 3. `simplify_polynomial_expression`
 
 Simplifies an algebraic expression in polynomial form and returns it in LaTeX format. Takes an algebraic expression, in polynomial form, written in Python syntax and simplifies it. The result is returned as a LaTeX formatted string, suitable for academic or professional documentation.
 
@@ -211,7 +251,7 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 --------------------------------------------------------------------------------
 
-### 3. `solve_homogeneous_polynomial_expression`
+### 4. `solve_homogeneous_polynomial_expression`
 
 Solves a homogeneous polynomial expression for a specified variable and returns solutions in LaTeX format. Assumes that the expression is homoegeneous (i.e. equal to zero), and solves for a designated variable. May optionally include substitutions for other variables in the equation. The solutions are provided as a LaTeX formatted string. The method solves equations for specified variables, with optional substitutions, returning LaTeX-formatted solutions.
 
@@ -234,7 +274,7 @@ Solves a homogeneous polynomial expression for a specified variable and returns
     
 --------------------------------------------------------------------------------
 
-### 4. `get_prime_factors_latex`
+### 5. `get_prime_factors_latex`
 
 Computes prime factors of a number and presents them in LaTeX format.
 
@@ -258,7 +298,7 @@ Computes prime factors of a number and presents them in LaTeX format.
  
 --------------------------------------------------------------------------------
 
-### 5. `compute_matrix_expression`
+### 6. `compute_matrix_expression`
 
 Computes the results of expressions containing 1D or 2D matrix operations and formats them as LaTeX strings.
 
@@ -286,7 +326,7 @@ Computes the results of expressions containing 1D or 2D matrix operations and fo
 
 --------------------------------------------------------------------------------
 
-### 6. `compute_ordered_series_expression`
+### 7. `compute_ordered_series_expression`
 
 Computes the result of expressions containing operations on ordered series expressed as 1D lists. The syntax of the expression supports the discrete difference operator via the `ddd()` method.
 

{rgwfuncs-0.0.29 → rgwfuncs-0.0.30}/tests/test_algebra_lib.py

@@ -7,6 +7,7 @@ import math
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
 from src.rgwfuncs.algebra_lib import (
+    python_polynomial_expression_to_latex,
     compute_constant_expression,
     simplify_polynomial_expression,
     solve_homogeneous_polynomial_expression,
@@ -14,6 +15,27 @@ from src.rgwfuncs.algebra_lib import (
     compute_ordered_series_expression,
     get_prime_factors_latex)
 
+def test_python_polynomial_expression_to_latex():
+    test_cases = [
+        # Without substitutions
+        ("x**2 + y**2", None, r"x^{2} + y^{2}"),
+        ("3*a + 4*b", None, r"3 a + 4 b"),
+
+        # With substitutions
+        ("x**2 + y**2", {"x": 3, "y": 4}, r"25"),  # Shows substitution but not simplification
+        ("x**2 + y**2", {"x": 3}, r"y^{2} + 9"),
+        ("a*b + b", {"b": 2}, r"2 a + 2"),
+        ("sin(x+z**2) + cos(y)", {"x": 55}, r"cos y + sin \left(z^{2} + 55\right)"),
+        ("sin(x) + cos(y)", {"x": 0}, r"cos y")
+    ]
+
+    for expression, subs, expected_output in test_cases:
+        output = python_polynomial_expression_to_latex(expression, subs)
+        assert output == expected_output, (
+            f"Test failed for expression: {expression} with substitutions: {subs}. "
+            f"Expected {expected_output}, got {output}"
+        )
+
 
 def test_compute_constant_expression():
     test_cases = [