# srijan-xi/algovisualizer architecture

> Architecture diagram of the GitHub repository srijan-xi/algovisualizer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/srijan-xi/algovisualizer
- Repository: https://github.com/srijan-xi/algovisualizer

## Overview

##### Project type and purpose
- AlgoVisualizer is a standalone, Java-based interactive visualization tool (an open-source educational application) for demonstrating how different sorting algorithms work in real time.
- The README highlights that its goal is to provide animations of sorting steps (Bubble Sort, Merge Sort, etc.), adjustable speed, and an intuitive GUI to help learners understand sorting algorithms.

##### File structure
- Top-level:
- README.md – project description
- assets/ – static image assets used in the README and possibly the UI
- Visualizer/ – main Java package
- Inside Visualizer/:
- SortingVisualizer.java – likely the entry point and controller
- VisualizerFrame.java – the GUI window and view layer
- Sorts/ – each sorting algorithm as a separate class (BubbleSort, InsertionSort, etc.)
- rrgf.txt, tset.txt – sample data files for test arrays or presets
- No web services or database directories; this is a purely client-side Java application.

##### README for additional insights

a. Main components:
1. UI Layer (VisualizerFrame.java)
- Dropdown for algorithm selection
- Speed control slider
2. Controller (SortingVisualizer.java)
- Reads user inputs
- Loads initial data (from tset.txt or random generator)
- Orchestrates calls to sorting algorithms
- Receives “step” callbacks to update UI
3. Sorting Engine (Sorts package)
- One class per algorithm, each exposes a standardized interface, e.g., sort(int[] array, Callback callback)
- Emits events or calls back with array states
4. Data Model
- The integer array being sorted
- Configuration objects (speed, algorithm type)
5. Assets Loader (optional)
- Loads tset.txt / rrgf.txt test files
- Provides data to the controller
b. Relationships and interactions:
- UI → Controller: user actions trigger runSorting(algorithm, data, speed)
- Controller → Sorting Engine: invokes specific Sort class
- Sorting Engine → Controller/UI: emits step events with array snapshots
- Controller/UI → UI Canvas: redraw bars on each step
- UI → Data Model: reads updated array for visualization
- (Optional) Controller → Assets Loader: fetch sample data files
c. Architectural patterns & design principles:
- MVC (Model-View-Controller):
- Model = Data array + speed/config
- View = VisualizerFrame (Canvas, controls)
- Controller = SortingVisualizer (orchestrates model & view)
- Strategy Pattern for algorithms: each Sort class implements a common interface
- Observer/Callback Pattern: sorting steps notify the UI for incremental rendering
d. Key technologies/frameworks:
- Java Swing/AWT for GUI
- Plain Java collections (int[] arrays)
- File I/O ( java.io ) for loading text files
- Thread.sleep or Swing Timer for pacing animations

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% MVC Components
    subgraph "View (UI Layer)"
        VF["VisualizerFrame"]:::view
    end

    subgraph "Controller"
        SV["SortingVisualizer"]:::controller
    end

    subgraph "Model (Data)"
        DM["Data Model<br/>(int[] & Config)"]:::model
    end

    subgraph "Assets Loader (File I/O)"
        AL["Sample Data Loader"]:::assets
    end

    subgraph "Sorting Engine<br/>(Strategy Package)"
        SP["Sorts Package"]:::logic
        IS["ISorter Interface"]:::logic
        BS["BubbleSort"]:::logic
        ISort["InsertionSort"]:::logic
        MS["MergeSort"]:::logic
        SS["SelectionSort"]:::logic
        ShS["ShellSort"]:::logic
        RS["RadixSort"]:::logic
        GS["GnomeSort"]:::logic
        QS["QuandrixSort"]:::logic
    end

    %% File nodes
    subgraph "Project Files"
        RD["README.md"]:::file
        AS["assets/"]:::file
        TD1["tset.txt"]:::assets
        TD2["rrgf.txt"]:::assets
    end

    %% Relationships
    VF -->|"user actions"| SV
    SV -->|"loadData()"| AL
    AL -->|"provides data"| SV
    SV -->|"updateModel()"| DM
    SV -->|"updateView(arrState)"| VF

    SV -->|"sort(array,callback)"| IS
    IS -->|"implemented by"| BS
    IS -->|"implemented by"| ISort
    IS -->|"implemented by"| MS
    IS -->|"implemented by"| SS
    IS -->|"implemented by"| ShS
    IS -->|"implemented by"| RS
    IS -->|"implemented by"| GS
    IS -->|"implemented by"| QS

    BS -.->|"onStep(arrState)"| SV
    ISort -.->|"onStep(arrState)"| SV
    MS -.->|"onStep(arrState)"| SV
    SS -.->|"onStep(arrState)"| SV
    ShS -.->|"onStep(arrState)"| SV
    RS -.->|"onStep(arrState)"| SV
    GS -.->|"onStep(arrState)"| SV
    QS -.->|"onStep(arrState)"| SV

    %% File relationships
    RD --- VF
    AS --- VF
    TD1 --- AL
    TD2 --- AL

    %% Click Events
    click VF "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/VisualizerFrame.java"
    click SV "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/SortingVisualizer.java"
    click SP "https://github.com/srijan-xi/algovisualizer/tree/main/Visualizer/Sorts/"
    click BS "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/BubbleSort.java"
    click ISort "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/InsertionSort.java"
    click MS "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/MergeSort.java"
    click SS "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/SelectionSort.java"
    click ShS "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/ShellSort.java"
    click RS "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/RadixSort.java"
    click GS "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/GnomeSort.java"
    click QS "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/Sorts/QuandrixSort.java"
    click TD1 "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/tset.txt"
    click TD2 "https://github.com/srijan-xi/algovisualizer/blob/main/Visualizer/rrgf.txt"
    click RD "https://github.com/srijan-xi/algovisualizer/blob/main/README.md"
    click AS "https://github.com/srijan-xi/algovisualizer/tree/main/assets/"

    %% Styles
    classDef view fill:#D0E6FF,stroke:#0366d6,color:#0366d6;
    classDef controller fill:#D0F0E1,stroke:#28A745,color:#28A745;
    classDef logic fill:#E8F5E9,stroke:#2E7D32,color:#2E7D32;
    classDef model fill:#FFF8E1,stroke:#FFB300,color:#FFB300;
    classDef assets fill:#FFE0B2,stroke:#EF6C00,color:#EF6C00;
    classDef file fill:#F5F5F5,stroke:#9E9E9E,color:#616161;
```
