# ihortarkhan/sorting-algorithms-visualisation architecture

> Architecture diagram of the GitHub repository ihortarkhan/sorting-algorithms-visualisation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ihortarkhan/sorting-algorithms-visualisation
- Repository: https://github.com/ihortarkhan/sorting-algorithms-visualisation

## Overview

##### Project type and purpose
- This is a desktop “sorting algorithm visualization” application implemented in Python.
- It provides a GUI for users to generate arrays (with different orderings), run individual or batch sorting experiments across six algorithms, collect timing/memory data into a local database, and render charts.

##### File structure
- Top-level files:
- main.py – application entrypoint
- config.ini – database/config settings
- UI/ – GUI components (views):
- Check_box.py, Extract_results.py, Graphs.py, Visualization.py
- calculation/ – business logic:
- controller/benchmark.py – orchestrates a benchmark run
- service/array_generate/ArrayFactory.py – Factory pattern for array creation
- service/sorting/SortAlgorithmSingleton.py – Singleton dispatcher for sorting
- service/sorting/algoritms/… – implementations of each sorting algorithm (Strategy pattern)
- service/sorting/SorterResult.py – captures result of a single sort
- db/Connector.py & sorting_logs_connector.py & AverageSortingLog.py – data access layer for persisting/retrieving logs
- util/FloatUtil.py, PySorter.py – low-level utilities
- entity/ – data models and enums (ArrayOrderEnum, SortAlgorithmEnum, SortingLog, StatisticSortingResponse)

##### Key insights from README
- MVC-style separation: UI (views) ↔ controller (benchmark) ↔ service (model/business) ↔ DB (persistence)
- Uses Factory (ArrayFactory) for array generation, Strategy (each sorter implements AbstractSorter), Singleton (SortAlgorithmSingleton)
- Outputs time/memory graphs for single runs or full experiments

##### Components
a. Main components:
- Desktop UI layer (Visualization, CheckBoxes, Graphs, Extraction interface)
- Controller layer (BenchmarkController – triggers experiments)
- Service layer:
– ArrayFactory (array gen.)
– SortAlgorithmSingleton & individual SortAlgorithm implementations
– SorterResult aggregator
– Utility modules (FloatUtil, PySorter)
- Data Access layer (Connector, sorting_logs_connector, AverageSortingLog)
- Database (e.g., SQLite instance configured via config.ini)
- Entities/DTOs (SortingLog, StatisticSortingResponse, Enums)
- Application entrypoint (main.py)

b. Relationships and data flows:
1. main.py initializes UI components and reads config.ini → passes DB connector to controller
2. UI event (e.g., “Run single sample” or “Run full benchmark”) → calls BenchmarkController.run()
3. BenchmarkController
→ uses ArrayFactory to generate input arrays
→ calls SortAlgorithmSingleton to dispatch to a specific sorter (e.g., QuickSorter)
→ SorterResult collects timing & memory metrics (utilizing FloatUtil, PySorter)
→ persists results via sorting_logs_connector into Database
→ retrieves aggregated statistics (AverageSortingLog) if needed
→ returns StatisticSortingResponse DTOs back to controller
4. Controller instructs UI to render graphs (Graphs.py) or update result panels (Extract_results.py, Visualization.py)

c. Architectural patterns & principles:
- MVC / layered architecture – isolates UI, business logic, persistence
- Factory pattern for array generation
- Strategy pattern for pluggable sorting algorithms
- Singleton for central algorithm dispatcher
- DAO for database interactions

d. Key technologies/libraries:
- Python GUI toolkit (e.g., Tkinter or PyQt – inferred from UI files)
- SQLite or lightweight file-based DB via Connector
- matplotlib or similar for chart rendering (in Graphs.py)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Application Entrypoint and Config
    Main["main.py"]:::entry
    Config["config.ini"]:::config

    Main -->|reads config| Config
    Main -->|initializes UI| Presentation

    %% Presentation Layer
    subgraph "Presentation Layer" 
        direction TB
        Visualization["Visualization View"]:::ui
        CheckBox["Checkbox Controls"]:::ui
        ExtractResults["Results Extraction Panel"]:::ui
        Graphs["Chart Rendering"]:::ui
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        BenchmarkController["BenchmarkController"]:::controller
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        subgraph "Array Generation" 
            direction TB
            ArrayFactory["ArrayFactory «Factory»"]:::service
        end
        subgraph "Sorting Dispatch"
            direction TB
            SortSingleton["SortAlgorithmSingleton «Singleton»"]:::service
        end
        subgraph "Sorting Algorithms «Strategy»"
            direction TB
            AbstractSorter["AbstractSorter"]:::service
            BrickSorter["BrickSorter"]:::service
            BubbleSorter["BubbleSorter"]:::service
            CocktailSorter["CocktailSorter"]:::service
            InsertionSorter["InsertionSorter"]:::service
            MergeSorter["MergeSorter"]:::service
            QuickSorter["QuickSorter"]:::service
        end
        SorterResult["SorterResult"]:::service
        subgraph "Utility Modules"
            direction TB
            FloatUtil["FloatUtil"]:::util
            PySorter["PySorter"]:::util
        end
    end

    %% Data Access Layer
    subgraph "Data Access Layer «DAO»"
        direction TB
        Connector["DB Connector"]:::dao
        LogsConnector["Sorting Logs Connector"]:::dao
        AvgLog["AverageSortingLog"]:::dao
    end

    %% Entities / DTOs
    subgraph "Entities / DTOs"
        direction TB
        SortingLogEntity["SortingLog Model"]:::entity
        StatisticResponse["StatisticSortingResponse DTO"]:::entity
        ArrayOrderEnum["ArrayOrderEnum"]:::entity
        SortAlgorithmEnum["SortAlgorithmEnum"]:::entity
    end

    %% Data Flow
    Visualization -->|user action| BenchmarkController
    CheckBox -->|user action| BenchmarkController
    ExtractResults -->|requests data| BenchmarkController
    Graphs -->|requests data| BenchmarkController

    BenchmarkController -->|generate array| ArrayFactory
    ArrayFactory -->|returns array| BenchmarkController

    BenchmarkController -->|dispatch sort| SortSingleton
    SortSingleton -->|selects strategy| AbstractSorter
    SortSingleton --> BrickSorter
    SortSingleton --> BubbleSorter
    SortSingleton --> CocktailSorter
    SortSingleton --> InsertionSorter
    SortSingleton --> MergeSorter
    SortSingleton --> QuickSorter

    SortSingleton -->|executes sort| SorterResult
    SorterResult -->|uses| FloatUtil
    SorterResult -->|uses| PySorter

    SorterResult -->|persist result| LogsConnector
    LogsConnector -->|calls| Connector
    BenchmarkController -->|aggregate stats| AvgLog
    AvgLog -->|calls| Connector

    LogsConnector -->|stores logs| Database[(SQLite Database)]:::database
    Connector -->|connects to| Database
    AvgLog -->|reads from| Database

    Connector -->|maps| SortingLogEntity
    Connector -->|maps| StatisticResponse

    BenchmarkController -->|returns DTO| StatisticResponse
    StatisticResponse -->|updated in UI| ExtractResults
    StatisticResponse -->|render charts| Graphs

    %% Entry to UI
    Main --> Visualization
    Main --> CheckBox
    Main --> ExtractResults
    Main --> Graphs

    %% Click Events
    click Main "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/main.py"
    click Config "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/config.ini"
    click Visualization "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/UI/Visualization.py"
    click CheckBox "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/UI/Check_box.py"
    click ExtractResults "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/UI/Extract_results.py"
    click Graphs "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/UI/Graphs.py"
    click BenchmarkController "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/controller/benchmark.py"
    click ArrayFactory "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/array_generate/ArrayFactory.py"
    click SortSingleton "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/SortAlgorithmSingleton.py"
    click AbstractSorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/algoritms/AbstractSorter.py"
    click BrickSorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/algoritms/BrickSorter.py"
    click BubbleSorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/algoritms/BubbleSorter.py"
    click CocktailSorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/algoritms/CocktailSorter.py"
    click InsertionSorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/algoritms/InsertionSorter.py"
    click MergeSorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/algoritms/MargeSorter.py"
    click QuickSorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/algoritms/QuickSorter.py"
    click SorterResult "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/service/sorting/SorterResult.py"
    click FloatUtil "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/util/FloatUtil.py"
    click PySorter "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/util/PySorter.py"
    click Connector "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/db/Connector.py"
    click LogsConnector "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/db/sorting_logs_connector.py"
    click AvgLog "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/calculation/db/AverageSortingLog.py"
    click SortingLogEntity "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/entity/SortingLog.py"
    click StatisticResponse "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/entity/StatisticSortingResponse.py"
    click ArrayOrderEnum "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/entity/ArrayOrderEnum.py"
    click SortAlgorithmEnum "https://github.com/ihortarkhan/sorting-algorithms-visualisation/blob/master/entity/SortAlgorithmEnum.py"

    %% Styles
    classDef entry fill:#D6B4FF,stroke:#663399,color:#000
    classDef config fill:#FFD580,stroke:#FFA500,color:#000
    classDef ui fill:#B3D9FF,stroke:#3399FF,color:#000
    classDef controller fill:#CFE2F3,stroke:#2E75B6,color:#000
    classDef service fill:#D9EAD3,stroke:#6AA84F,color:#000
    classDef util fill:#F4CCCC,stroke:#CC0000,color:#000
    classDef dao fill:#FFE599,stroke:#E69138,color:#000
    classDef database fill:#F9CB9C,stroke:#E06666,color:#000
    classDef entity fill:#E7E6E6,stroke:#939393,color:#000
```
