rgwfuncs 0.0.50__tar.gz → 0.0.51__tar.gz

{rgwfuncs-0.0.50/src/rgwfuncs.egg-info → rgwfuncs-0.0.51}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.50
+Version: 0.0.51
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -430,35 +430,7 @@ Factors a polynomial expression written in Python syntax and converts it into a
 
 --------------------------------------------------------------------------------
 
-### 8. `cancel_polynomial_expression`
-
-Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
-
-- Parameters:
-  - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
-  - `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 to substitute.
-
-- Returns:
-  - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
-
-- Raises:
-  - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
-
-- Example:
-
-    from rgwfuncs import cancel_polynomial_expression
-
-    # Cancel common factors within a polynomial expression
-    latex_result1 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)")
-    print(latex_result1)  # Output: "x + 2"
-
-    # Cancel with substituted values
-    latex_result2 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)", {"x": 2})
-    print(latex_result2)  # Output: "Undefined result. This could be a division by zero error."
-
---------------------------------------------------------------------------------
-
-### 9. `simplify_polynomial_expression`
+### 8. `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.
 
@@ -491,6 +463,34 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 --------------------------------------------------------------------------------
 
+### 9. `cancel_polynomial_expression`
+
+Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
+
+- Parameters:
+  - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
+  - `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 to substitute.
+
+- Returns:
+  - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
+
+- Raises:
+  - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
+
+- Example:
+
+    from rgwfuncs import cancel_polynomial_expression
+
+    # Cancel common factors within a polynomial expression
+    latex_result1 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)")
+    print(latex_result1)  # Output: "x + 2"
+
+    # Cancel with substituted values
+    latex_result2 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)", {"x": 2})
+    print(latex_result2)  # Output: "Undefined result. This could be a division by zero error."
+
+--------------------------------------------------------------------------------
+
 ### 10. `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.

{rgwfuncs-0.0.50 → rgwfuncs-0.0.51}/README.md

@@ -403,35 +403,7 @@ Factors a polynomial expression written in Python syntax and converts it into a
 
 --------------------------------------------------------------------------------
 
-### 8. `cancel_polynomial_expression`
-
-Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
-
-- Parameters:
-  - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
-  - `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 to substitute.
-
-- Returns:
-  - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
-
-- Raises:
-  - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
-
-- Example:
-
-    from rgwfuncs import cancel_polynomial_expression
-
-    # Cancel common factors within a polynomial expression
-    latex_result1 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)")
-    print(latex_result1)  # Output: "x + 2"
-
-    # Cancel with substituted values
-    latex_result2 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)", {"x": 2})
-    print(latex_result2)  # Output: "Undefined result. This could be a division by zero error."
-
---------------------------------------------------------------------------------
-
-### 9. `simplify_polynomial_expression`
+### 8. `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.
 
@@ -464,6 +436,34 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 --------------------------------------------------------------------------------
 
+### 9. `cancel_polynomial_expression`
+
+Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
+
+- Parameters:
+  - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
+  - `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 to substitute.
+
+- Returns:
+  - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
+
+- Raises:
+  - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
+
+- Example:
+
+    from rgwfuncs import cancel_polynomial_expression
+
+    # Cancel common factors within a polynomial expression
+    latex_result1 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)")
+    print(latex_result1)  # Output: "x + 2"
+
+    # Cancel with substituted values
+    latex_result2 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)", {"x": 2})
+    print(latex_result2)  # Output: "Undefined result. This could be a division by zero error."
+
+--------------------------------------------------------------------------------
+
 ### 10. `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.

{rgwfuncs-0.0.50 → rgwfuncs-0.0.51}/pyproject.toml

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

{rgwfuncs-0.0.50 → rgwfuncs-0.0.51}/setup.cfg

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

{rgwfuncs-0.0.50 → rgwfuncs-0.0.51/src/rgwfuncs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.50
+Version: 0.0.51
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -430,35 +430,7 @@ Factors a polynomial expression written in Python syntax and converts it into a
 
 --------------------------------------------------------------------------------
 
-### 8. `cancel_polynomial_expression`
-
-Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
-
-- Parameters:
-  - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
-  - `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 to substitute.
-
-- Returns:
-  - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
-
-- Raises:
-  - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
-
-- Example:
-
-    from rgwfuncs import cancel_polynomial_expression
-
-    # Cancel common factors within a polynomial expression
-    latex_result1 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)")
-    print(latex_result1)  # Output: "x + 2"
-
-    # Cancel with substituted values
-    latex_result2 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)", {"x": 2})
-    print(latex_result2)  # Output: "Undefined result. This could be a division by zero error."
-
---------------------------------------------------------------------------------
-
-### 9. `simplify_polynomial_expression`
+### 8. `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.
 
@@ -491,6 +463,34 @@ Simplifies an algebraic expression in polynomial form and returns it in LaTeX fo
 
 --------------------------------------------------------------------------------
 
+### 9. `cancel_polynomial_expression`
+
+Cancels common factors within a polynomial expression written in Python syntax and converts it to a LaTeX formatted string. This function parses an algebraic expression, cancels common factors using SymPy, and translates the reduced expression into a LaTeX representation. It can also accommodate optional substitutions to be made prior to simplification.
+
+- Parameters:
+  - `expression` (str): The algebraic expression to simplify and convert to LaTeX. This string should be formatted using Python syntax.
+  - `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 to substitute.
+
+- Returns:
+  - `str`: The LaTeX formatted string of the simplified expression. If the expression involves indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
+
+- Raises:
+  - `ValueError`: If the expression cannot be parsed due to syntax errors or involves undefined operations, such as division by zero.
+
+- Example:
+
+    from rgwfuncs import cancel_polynomial_expression
+
+    # Cancel common factors within a polynomial expression
+    latex_result1 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)")
+    print(latex_result1)  # Output: "x + 2"
+
+    # Cancel with substituted values
+    latex_result2 = cancel_polynomial_expression("(x**2 - 4) / (x - 2)", {"x": 2})
+    print(latex_result2)  # Output: "Undefined result. This could be a division by zero error."
+
+--------------------------------------------------------------------------------
+
 ### 10. `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.

{rgwfuncs-0.0.50 → rgwfuncs-0.0.51}/src/rgwfuncs/algebra_lib.py

@@ -411,69 +411,6 @@ def factor_polynomial_expression(
     return latex_result
 
 
-def cancel_polynomial_expression(
-    expression: str,
-    subs: Optional[Dict[str, float]] = None
-) -> str:
-    """
-    Cancels common factors within a polynomial expression and converts it to LaTeX format.
-
-    This function parses an algebraic expression given in Python syntax, cancels any common factors,
-    and converts the resulting simplified expression into a LaTeX formatted string. The function can
-    also handle optional substitutions of variables before performing the cancellation.
-
-    Parameters:
-    expression (str): The algebraic expression to simplify and convert to LaTeX.
-                      It should be a valid expression formatted using Python syntax.
-    subs (Optional[Dict[str, float]]): An optional dictionary where the keys are variable names in the
-                                       expression, and the values are the corresponding numbers to substitute
-                                       into the expression before simplification.
-
-    Returns:
-    str: The LaTeX formatted string of the simplified expression. If the expression involves
-         indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
-
-    Raises:
-    ValueError: If the expression cannot be parsed due to syntax errors or if operations result in
-                undefined behavior, such as division by zero.
-
-    """
-    transformations = standard_transformations + (implicit_multiplication_application,)
-
-    def parse_and_cancel_expression(expr_str: str, sym_vars: Dict[str, symbols]) -> symbols:
-        try:
-            expr = parse_expr(expr_str, local_dict=sym_vars, transformations=transformations)
-            if subs:
-                if not isinstance(subs, dict):
-                    raise ValueError(f"Substitutions must be a dictionary. Received: {subs}")
-                subs_symbols = {symbols(k): v for k, v in subs.items()}
-                expr = expr.subs(subs_symbols)
-
-            canceled_expr = cancel(expr)
-
-            # Check for NaN or indeterminate forms
-            if canceled_expr.has(S.NaN) or canceled_expr.has(S.Infinity) or canceled_expr.has(S.ComplexInfinity):
-                return "Undefined result. This could be a division by zero error."
-
-            return canceled_expr
-
-        except (SyntaxError, ValueError, TypeError, AttributeError, ZeroDivisionError, SympifyError) as e:
-            return f"Error: {str(e)}"
-
-    variable_names = set(re.findall(r'\b[a-zA-Z]\w*\b', expression))
-    sym_vars = {var: symbols(var) for var in variable_names}
-
-    expr = parse_and_cancel_expression(expression, sym_vars)
-
-    # If the expression is already a string (i.e., "Undefined" or error message), return it directly
-    if isinstance(expr, str):
-        return expr
-
-    # Otherwise, convert to LaTeX as usual
-    latex_result = latex(expr)
-    return latex_result
-
-
 def simplify_polynomial_expression(
     expression: str,
     subs: Optional[Dict[str, float]] = None
@@ -649,6 +586,69 @@ def simplify_polynomial_expression(
         raise ValueError(f"Error simplifying expression: {e}")
 
 
+def cancel_polynomial_expression(
+    expression: str,
+    subs: Optional[Dict[str, float]] = None
+) -> str:
+    """
+    Cancels common factors within a polynomial expression and converts it to LaTeX format.
+
+    This function parses an algebraic expression given in Python syntax, cancels any common factors,
+    and converts the resulting simplified expression into a LaTeX formatted string. The function can
+    also handle optional substitutions of variables before performing the cancellation.
+
+    Parameters:
+    expression (str): The algebraic expression to simplify and convert to LaTeX.
+                      It should be a valid expression formatted using Python syntax.
+    subs (Optional[Dict[str, float]]): An optional dictionary where the keys are variable names in the
+                                       expression, and the values are the corresponding numbers to substitute
+                                       into the expression before simplification.
+
+    Returns:
+    str: The LaTeX formatted string of the simplified expression. If the expression involves
+         indeterminate forms due to operations like division by zero, a descriptive error message is returned instead.
+
+    Raises:
+    ValueError: If the expression cannot be parsed due to syntax errors or if operations result in
+                undefined behavior, such as division by zero.
+
+    """
+    transformations = standard_transformations + (implicit_multiplication_application,)
+
+    def parse_and_cancel_expression(expr_str: str, sym_vars: Dict[str, symbols]) -> symbols:
+        try:
+            expr = parse_expr(expr_str, local_dict=sym_vars, transformations=transformations)
+            if subs:
+                if not isinstance(subs, dict):
+                    raise ValueError(f"Substitutions must be a dictionary. Received: {subs}")
+                subs_symbols = {symbols(k): v for k, v in subs.items()}
+                expr = expr.subs(subs_symbols)
+
+            canceled_expr = cancel(expr)
+
+            # Check for NaN or indeterminate forms
+            if canceled_expr.has(S.NaN) or canceled_expr.has(S.Infinity) or canceled_expr.has(S.ComplexInfinity):
+                return "Undefined result. This could be a division by zero error."
+
+            return canceled_expr
+
+        except (SyntaxError, ValueError, TypeError, AttributeError, ZeroDivisionError, SympifyError) as e:
+            return f"Error: {str(e)}"
+
+    variable_names = set(re.findall(r'\b[a-zA-Z]\w*\b', expression))
+    sym_vars = {var: symbols(var) for var in variable_names}
+
+    expr = parse_and_cancel_expression(expression, sym_vars)
+
+    # If the expression is already a string (i.e., "Undefined" or error message), return it directly
+    if isinstance(expr, str):
+        return expr
+
+    # Otherwise, convert to LaTeX as usual
+    latex_result = latex(expr)
+    return latex_result
+
+
 def solve_homogeneous_polynomial_expression(
     expression: str,
     variable: str,