executable-engineering 0.1.33__py3-none-any.whl → 0.1.34__py3-none-any.whl

executable_engineering/__init__.py

@@ -5,11 +5,15 @@ from .closedoptimization_module import OptimizerClosed
 from .openoptimization_module import OptimizerOpen
 from .gradientoptimization_module import OptimizerGrad
 from .numerical_error_module import python_internal_binary, decimal_to_binary
-from .linearsystems_module import visual_solve_2d, visualize_conditioning
+from .linearsystems_module import visual_solve_2d, visualize_conditioning, visualize_matrix_norms, jacobi_step, gauss_seidel_step, sor_step, visualize_convergence_2d, create_diagonally_dominant_matrix, iter_solve, steepest_descent, conjugate_gradient, IterationTracker
 
 __all__ = [
   "visual_solve_2d",
   "visualize_conditioning",
+  "visualize_matrix_norms",
+  "jacobi_step",
+  "gauss_seidel_step",
+  "sor_step, visualize_convergence_2d, create_diagonally_dominant_matrix, iter_solve, steepest_descent, conjugate_gradient, IterationTracker",
   "init_weights",
   "tanh",
   "tanh_derivative",

executable_engineering/linearsystems_module.py

@@ -167,3 +167,276 @@ def visualize_conditioning(A):
     )
     
     return fig
+
+
+def visualize_matrix_norms(A):
+    """
+    Visualizes matrix norms by plotting the transformation of a unit circle
+    and overlaying bounding circles based on different matrix norms.
+    
+    Args:
+        A: (2, 2) array-like matrix
+    """
+    import numpy as np
+    import plotly.graph_objects as go
+    
+    A = np.array(A, dtype=float)
+    if A.shape != (2, 2):
+        raise ValueError("visualize_matrix_norms requires a 2x2 matrix.")
+        
+    # 1. Calculate the norms
+    norm_2 = np.linalg.norm(A, ord=2)
+    norm_F = np.linalg.norm(A, ord='fro')
+    norm_inf = np.linalg.norm(A, ord=np.inf)
+    
+    # 2. Transform the unit circle
+    theta = np.linspace(0, 2*np.pi, 200)
+    circle = np.array([np.cos(theta), np.sin(theta)])
+    ellipse = A @ circle
+    
+    # 3. Create circles for the norms
+    circle_2 = norm_2 * circle
+    circle_F = norm_F * circle
+    circle_inf = norm_inf * circle
+    
+    # 4. Plot!
+    fig = go.Figure()
+    
+    # Plot the transformed ellipse
+    fig.add_trace(go.Scatter(x=ellipse[0], y=ellipse[1], mode='lines', name='A * Unit Circle (Ellipse)', line=dict(color='blue', width=3)))
+    
+    # Plot the norm bounding circles
+    fig.add_trace(go.Scatter(x=circle_2[0], y=circle_2[1], mode='lines', name=f'2-Norm (Radius {norm_2:.2f})', line=dict(color='green', dash='dash')))
+    fig.add_trace(go.Scatter(x=circle_F[0], y=circle_F[1], mode='lines', name=f'Frobenius Norm (Radius {norm_F:.2f})', line=dict(color='orange', dash='dash')))
+    fig.add_trace(go.Scatter(x=circle_inf[0], y=circle_inf[1], mode='lines', name=f'Infinity Norm (Radius {norm_inf:.2f})', line=dict(color='red', dash='dash')))
+    
+    # Setup axes
+    max_val = norm_inf * 1.1
+    fig.update_xaxes(range=[-max_val, max_val])
+    fig.update_yaxes(range=[-max_val, max_val], scaleanchor="x", scaleratio=1)
+    fig.update_layout(title="Matrix Norms as Bounds on Geometric Distortion", width=700, height=700)
+    
+    return fig
+
+def jacobi_step(A, b, x):
+    """Performs a single Jacobi iteration step."""
+    n = len(x)
+    x_new = np.zeros_like(x)
+    for i in range(n):
+        x_new[i] = (b[i] - np.dot(A[i, :i], x[:i]) - np.dot(A[i, i + 1:], x[i + 1:])) / A[i, i]
+    return x_new
+
+def gauss_seidel_step(A, b, x, omega = 1):
+    """Performs a single Gauss-Seidel iteration step."""
+    n = len(x)
+    for i in range(n):
+        x[i] = (b[i] - np.dot(A[i, :i], x[:i]) - np.dot(A[i, i + 1:], x[i + 1:])) / A[i, i]
+    return x
+
+def sor_step(A, b, x, omega=1.05):
+    """Performs a single SOR iteration step."""
+    n = len(x)
+    for i in range(n):
+        x[i] = (1 - omega) * x[i] + (omega / A[i, i]) * (b[i] - np.dot(A[i, :i], x[:i]) - np.dot(A[i, i + 1:], x[i + 1:]))
+    return x
+
+def visualize_convergence_2d(A, b, iterations, surface_type='residual'):
+    """
+    Visualizes the convergence path of an iterative solver over a 2D contour surface.
+    
+    Args:
+        A: (2, 2) coefficient matrix.
+        b: (2,) right-hand side vector.
+        iterations: List or array of (2,) vectors representing the guess at each step.
+        surface_type: 'residual' plots ||Ax - b||. 'quadratic' plots 0.5 x^T A x - b^T x.
+    """
+    import numpy as np
+    import plotly.graph_objects as go
+    
+    A = np.array(A, dtype=float)
+    b = np.array(b, dtype=float).flatten()
+    iterations = np.array(iterations)
+    
+    if A.shape != (2, 2):
+        raise ValueError("visualize_convergence_2d only supports 2D systems.")
+        
+    try:
+        x_true = np.linalg.solve(A, b)
+    except np.linalg.LinAlgError:
+        x_true = np.zeros(2)
+        
+    # Determine bounds
+    all_points = np.vstack([iterations, x_true])
+    min_x, max_x = np.min(all_points[:, 0]), np.max(all_points[:, 0])
+    min_y, max_y = np.min(all_points[:, 1]), np.max(all_points[:, 1])
+    
+    # Add padding
+    pad_x = max((max_x - min_x) * 0.3, 0.5)
+    pad_y = max((max_y - min_y) * 0.3, 0.5)
+    
+    x_range = np.linspace(min_x - pad_x, max_x + pad_x, 100)
+    y_range = np.linspace(min_y - pad_y, max_y + pad_y, 100)
+    X, Y = np.meshgrid(x_range, y_range)
+    
+    if surface_type == 'residual':
+        # ||Ax - b||
+        Z = np.sqrt((A[0,0]*X + A[0,1]*Y - b[0])**2 + (A[1,0]*X + A[1,1]*Y - b[1])**2)
+        title = "Convergence Path over Residual Surface ||Ax - b||"
+    elif surface_type == 'quadratic':
+        # 0.5 x^T A x - b^T x
+        Z = 0.5 * (A[0,0]*X**2 + (A[0,1] + A[1,0])*X*Y + A[1,1]*Y**2) - (b[0]*X + b[1]*Y)
+        title = "Convergence Path over Quadratic Surface f(x)"
+    else:
+        raise ValueError("surface_type must be 'residual' or 'quadratic'")
+        
+    fig = go.Figure()
+    
+    # Contour plot
+    fig.add_trace(go.Contour(
+        x=x_range, y=y_range, z=Z,
+        colorscale='Viridis',
+        contours=dict(showlabels=True, labelfont=dict(size=12, color='white')),
+        showscale=False,
+        opacity=0.7
+    ))
+    
+    # Convergence path
+    import numpy as np
+    import plotly.express as px
+    
+    # We want to draw each segment with a color from the colormap
+    if len(iterations) > 1:
+        colors = px.colors.sample_colorscale('magma', np.linspace(0, 1, len(iterations)-1))
+        for i in range(len(iterations)-1):
+            fig.add_trace(go.Scatter(
+                x=iterations[i:i+2, 0], y=iterations[i:i+2, 1],
+                mode='lines',
+                line=dict(color=colors[i], width=3),
+                showlegend=False
+            ))
+        
+        # Add a dummy trace just to show the colorbar
+        fig.add_trace(go.Scatter(
+            x=[None], y=[None],
+            mode='markers',
+            marker=dict(
+                size=0, 
+                color=[0, len(iterations)-1], 
+                colorscale='magma', 
+                showscale=True,
+                colorbar=dict(title="Iteration", len=0.5, y=0.5, x=1.1)
+            ),
+            showlegend=False
+        ))
+    else:
+        # Just in case there is no path
+        fig.add_trace(go.Scatter(
+            x=iterations[:, 0], y=iterations[:, 1],
+            mode='markers',
+            marker=dict(size=8, color='white'),
+            name='Iterations'
+        ))
+    
+
+    
+    fig.update_layout(
+        title=title,
+        width=700, height=600,
+        xaxis_title="x₁",
+        yaxis_title="x₂",
+        yaxis=dict(scaleanchor="x", scaleratio=1),
+        margin=dict(l=20, r=20, t=50, b=20)
+    )
+    return fig
+
+def create_diagonally_dominant_matrix(n):
+    """Creates a diagonally dominant random matrix.
+
+    Args:
+        n: The size of the matrix.
+
+    Returns:
+        A diagonally dominant random matrix.
+    """
+    import numpy as np
+    A = np.random.rand(n, n)
+    for i in range(n):
+        A[i, i] = np.sum(np.abs(A[i, :])) + np.random.rand()
+    return A
+
+def iter_solve(A, b, method, tol=1e-6, track_history=False):
+    """
+    General wrapper function that repeatedly applies an iterative step 
+    until the residual error falls below a tolerance.
+    """
+    import numpy as np
+    x = np.zeros(len(b))
+    max_iter = 1000
+    
+    if track_history:
+        iterations = [x.copy()]
+
+    for i in range(max_iter):
+        x_new = method(A, b, x.copy())
+        if track_history:
+            iterations.append(x_new.copy())
+            
+        if np.linalg.norm(A @ x_new - b) < tol:
+            print(f'Converged after {i+1} iterations.')
+            break
+        x = x_new.copy()
+        
+    if track_history:
+        return x, iterations
+    return x
+
+def steepest_descent(A, b, x0, tol=1e-6, max_iter=100, track_history=False):
+    """Solves a linear system Ax = b using the method of steepest descent."""
+    import numpy as np
+    x = x0.copy()
+    if track_history:
+        iterations = [x.copy()]
+        
+    for i in range(max_iter):
+        r = A @ x - b
+        if np.linalg.norm(r) < tol:
+            if track_history: print(f'Converged after {i+1} iterations.')
+            break
+        alpha = np.dot(r, r) / np.dot(r, A @ r)
+        x = x - alpha * r
+        if track_history:
+            iterations.append(x.copy())
+            
+    if track_history:
+        return x, iterations
+    return x
+
+def conjugate_gradient(A, b, x0, tol=1e-6, track_history=False):
+    """Wrapper around SciPy CG to track iterations if needed."""
+    import numpy as np
+    from scipy.sparse.linalg import cg
+    
+    if track_history:
+        iterations = [x0.copy()]
+        def callback(xk):
+            iterations.append(np.copy(xk))
+        solution, info = cg(A, b, x0=x0, tol=tol, callback=callback)
+        return solution, np.array(iterations)
+    else:
+        solution, info = cg(A, b, x0=x0, tol=tol)
+        return solution
+
+class IterationTracker:
+    """
+    A clean callback tracker for native SciPy solvers (cg, gmres, etc.).
+    """
+    def __init__(self, x0=None):
+        import numpy as np
+        if x0 is not None:
+            self.iterations = [np.array(x0).copy()]
+        else:
+            self.iterations = []
+
+    def __call__(self, xk):
+        import numpy as np
+        self.iterations.append(np.array(xk).copy())

{executable_engineering-0.1.33.dist-info → executable_engineering-0.1.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: executable_engineering
-Version: 0.1.33
+Version: 0.1.34
 Summary: Demonstrative tools for the Executable Engineering textbook
 Home-page: https://github.com/themintlab/ExecutableEngineering/tree/main/executable_engineering
 Author: Michael Welland

{executable_engineering-0.1.33.dist-info → executable_engineering-0.1.34.dist-info}/RECORD

@@ -1,14 +1,14 @@
-executable_engineering/__init__.py,sha256=jrrsfub0C6cM1R9r7Gw97tW5CxX5kNEoYkvxlHzSJjU,1166
+executable_engineering/__init__.py,sha256=2DTTPvFi5e9Si0wGobfvaL5khJHAoCjrFYAr2q_h1DQ,1572
 executable_engineering/closedoptimization_module.py,sha256=i9KkdulyCZmriYKlx0CuUetjoMmxJm9ADWgStU3w85w,9273
 executable_engineering/closedrootfinder_module.py,sha256=ozccVABOrTiqcdkkqwAWRNo04MsDC0Z_f_tfukl3q20,5706
 executable_engineering/gradientoptimization_module.py,sha256=-2fErE9cemSEPeV9PlWOf4cF7Tr6DjilEw_NxvE-JYw,6601
-executable_engineering/linearsystems_module.py,sha256=JNKcHPUxOBJ4xoFYZyUFwbEOGGD_gi6zRQfcJKYBb5E,6080
+executable_engineering/linearsystems_module.py,sha256=4fJyuFGUdm2FKiydDD-_vAh1O9XEH8f0puBKWkGtlqM,15101
 executable_engineering/neuralnet_module.py,sha256=Hu9QFoMyODg4RCEpHmT9zTwzjcVFYM8ZLYtbB3CbrsA,10102
 executable_engineering/numerical_error_module.py,sha256=wxfYP8u29c19I2D6MxpQV3zDMV0DpS1QUqFpp3f6eGE,1204
 executable_engineering/openoptimization_module.py,sha256=OCPyrynkTo1It50RoT7irnL72aQn6FexE_R1SfFYxlg,8590
 executable_engineering/openrootfinder_module.py,sha256=rmXDi0XdrDYdLZdPFgYCihMg_4NF1D71i6kh8Kx-V2w,5802
-executable_engineering-0.1.33.dist-info/licenses/LICENSE,sha256=Tg4nrt8rFhgpkPbIA8SWoCR3MlGLw0NufB8AE6-TH_o,1074
-executable_engineering-0.1.33.dist-info/METADATA,sha256=bZoPtBOuuAakueT9uX15GfwOIJeQaEw3YDkewAiKjaM,1648
-executable_engineering-0.1.33.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-executable_engineering-0.1.33.dist-info/top_level.txt,sha256=0U5ATV5WGTLvN9rRSjQ54TyL-ztTyXaN3FzZ_QMq4HM,23
-executable_engineering-0.1.33.dist-info/RECORD,,
+executable_engineering-0.1.34.dist-info/licenses/LICENSE,sha256=Tg4nrt8rFhgpkPbIA8SWoCR3MlGLw0NufB8AE6-TH_o,1074
+executable_engineering-0.1.34.dist-info/METADATA,sha256=ABgLWLdM0FnHXlY2BkYbVJer6d9Mb4H6nrE9VoiHkc8,1648
+executable_engineering-0.1.34.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+executable_engineering-0.1.34.dist-info/top_level.txt,sha256=0U5ATV5WGTLvN9rRSjQ54TyL-ztTyXaN3FzZ_QMq4HM,23
+executable_engineering-0.1.34.dist-info/RECORD,,