# fionaverzivolli/exploring-ge-pivoting-and-lu-factorization architecture

> Architecture diagram of the GitHub repository fionaverzivolli/exploring-ge-pivoting-and-lu-factorization, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization
- Repository: https://github.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization

## Overview

##### Main Components
- Algorithm Implementations:
- GE_no_pivot.py (No Pivoting)
- GE_partial_pivot.py (Partial Pivoting)
- GE_complete_pivoting.py (Complete Pivoting)
- Testing Module:
- GE_testing.py (Unit tests using NumPy for correctness and functionality)
- Visualization Module:
- GE_visualize.py (Generates plots and visual performance metrics using Pandas)
- Documentation:
- README.md (Describes the purpose, underlying methodology, and comparison of the three algorithms)

##### Representing Relationships and Interactions
- Input Data Flow:
- Algorithm Execution:
- Testing Flow:
- The testing module validates the correctness and robustness of each method.
- Visualization Flow:
- Also, indicate that performance metrics (like residuals, conditioning numbers, error metrics, etc.) from the algorithm executions are gathered and then passed to GE_visualize.py.
- This module then outputs relevant visualizations/charts.

##### Architecturally Relevant Patterns
- Modularity:
- Data Flow Architecture:
- Dependence on Third-Party Libraries:
- External dependencies such as NumPy (for numerical testing) and Pandas (for visualization) near the testing and visualization modules.

## Diagram (Mermaid)

```mermaid
flowchart TD
    doc["Documentation/README"]:::documentation
    inp["Input Matrix/Data"]:::input
    a1["No Pivoting Implementation"]:::algorithm
    a2["Partial Pivoting Implementation"]:::algorithm
    a3["Complete Pivoting Implementation"]:::algorithm
    res["Algorithm Results"]:::algorithm
    test["Unit Testing Module (NumPy)"]:::testing
    viz["Visualization Module (Pandas)"]:::visualization

    %% Documentation informs the design
    doc -->|"informs"| inp

    %% Input feeds each algorithm implementation
    inp -->|"feeds"| a1
    inp -->|"feeds"| a2
    inp -->|"feeds"| a3

    %% Each algorithm produces results
    a1 -->|"output"| res
    a2 -->|"output"| res
    a3 -->|"output"| res

    %% Algorithm results are used for testing and visualization
    res -->|"verifies"| test
    res -->|"visualizes"| viz

    click a1 "https://github.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization/blob/main/GE_no_pivot.py"
    click a2 "https://github.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization/blob/main/GE_partial_pivot.py"
    click a3 "https://github.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization/blob/main/GE_complete_pivoting.py"
    click test "https://github.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization/blob/main/GE_testing.py"
    click viz "https://github.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization/blob/main/GE_visualize.py"
    click doc "https://github.com/fionaverzivolli/exploring-ge-pivoting-and-lu-factorization/blob/main/README.md"

    classDef input fill:#FFE0B2,stroke:#f39c12,stroke-width:2px,color:#000;
    classDef algorithm fill:#D6EAF8,stroke:#2980B9,stroke-width:2px,color:#000;
    classDef testing fill:#D5F5E3,stroke:#27AE60,stroke-width:2px,color:#000;
    classDef visualization fill:#FCF3CF,stroke:#F1C40F,stroke-width:2px,color:#000;
    classDef documentation fill:#FADBD8,stroke:#E74C3C,stroke-width:2px,color:#000;
```
