# h-ssiqueira/sort_algorithms architecture

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

- Interactive diagram: https://gitdiagram.com/h-ssiqueira/sort_algorithms
- Repository: https://github.com/h-ssiqueira/sort_algorithms

## Overview

##### Project type and purpose
- This is a standalone, command-line C application that demonstrates and benchmarks 48 different sorting algorithms.
- It provides a text-based menu/UI, allows the user to configure parameters (array size, input distribution, output options), runs the selected sort, measures execution time, optionally saves results, then displays results.

##### File structure
- Top-level:
- README.md, LICENSE, .gitignore, Makefile, execute.bat (build & run scripts)
- imgs/ (screenshots for README)
- src/:
- main.c (entry point, CLI menu dispatcher)
- utils/ (array helpers, screen/IO routines, error messages)
- one subdirectory per category of sorts (esotericFunMiscellaneous, exchange, hybrids, insertion, merge, networksConcurrent, noncomparisonDistribution, selection). Each has a header (e.g., sortCategory.h) and multiple .c files implementing each algorithm.
- Build files:
- Makefile for Unix/macOS (rules to compile all modules, link the binary).
- execute.bat for Windows.

##### README for additional insights
- The “Description” confirms the core functionality: demonstration + timing + optional file output.
- The “Algorithms” section enumerates the 8 categories and 48 source files—this tells us how modules are grouped.

##### Detail reminders
- Main.c sitting at the center orchestrating.
- Don’t overload with trivial details—focus on capturing how components interact, how new sorts are integrated, and the build/runtime flow.

- Reflects the project’s modular C-code structure.
- Shows both build-time and run-time architecture.
- Emphasizes extensibility and separation of concerns.

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "UI/CLI Layer"
        CLI["main.c"]:::cli
    end

    subgraph "Utilities Module"
        Array["array.c"]:::utils
        Screen["screen.c"]:::utils
        UtilsH["utils.h"]:::utils
        ErrMsgs["errorMessages.h"]:::utils
    end

    subgraph "Sorting Module"
        subgraph "Esoteric/Fun/Miscellaneous"
            ESMHg["esotericFunMiscellaneous.h"]:::sorting
            EsDir["esotericFunMiscellaneous/*.c"]:::sorting
        end
        subgraph "Exchange Sorts"
            EXHg["exchange.h"]:::sorting
            ExDir["exchange/*.c"]:::sorting
        end
        subgraph "Hybrid Sorts"
            HYbHg["hybrids.h"]:::sorting
            TimC["timSort.c"]:::sorting
        end
        subgraph "Insertion-Based Sorts"
            InHg["insertion.h"]:::sorting
            InDir["insertion/*.c"]:::sorting
        end
        subgraph "Merge Sorts"
            MeHg["merge.h"]:::sorting
            MeDir["merge/*.c"]:::sorting
        end
        subgraph "Network/Concurrent Sorts"
            NeHg["networksConcurrent.h"]:::sorting
            NeDir["networksConcurrent/*.c"]:::sorting
        end
        subgraph "Non-Comparison/Distribution Sorts"
            NoHg["noncomparisonDistribution.h"]:::sorting
            NoDir["noncomparisonDistribution/*.c"]:::sorting
        end
        subgraph "Selection Sorts"
            SeHg["selection.h"]:::sorting
            SeDir["selection/*.c"]:::sorting
        end
    end

    subgraph "Build System"
        Make["Makefile"]:::build
        Bat["execute.bat"]:::build
        GCC["GCC Compiler"]:::build
        Linker["Linker"]:::build
        Exe["Executable"]:::build
    end

    subgraph "External/Platform"
        OS["OS Console (stdin/stdout)"]:::external
        FS["File System"]:::external
        Shell["Shell/PowerShell"]:::external
    end

    %% Runtime Flow
    OS -->|user input/output| CLI
    CLI -->|renders menu| Screen
    Screen -->|user choice| CLI
    CLI -->|dispatches| ESMHg
    CLI -->|dispatches| EXHg
    CLI -->|dispatches| HYbHg
    CLI -->|dispatches| InHg
    CLI -->|dispatches| MeHg
    CLI -->|dispatches| NeHg
    CLI -->|dispatches| NoHg
    CLI -->|dispatches| SeHg
    ESMHg -->|calls| EsDir
    EXHg -->|calls| ExDir
    HYbHg -->|calls| TimC
    InHg -->|calls| InDir
    MeHg -->|calls| MeDir
    NeHg -->|calls| NeDir
    NoHg -->|calls| NoDir
    SeHg -->|calls| SeDir
    EsDir -->|uses| Array
    ExDir -->|uses| Array
    TimC -->|uses| Array
    InDir -->|uses| Array
    MeDir -->|uses| Array
    NeDir -->|uses| Array
    NoDir -->|uses| Array
    SeDir -->|uses| Array
    CLI -->|measures time| Array
    CLI -->|outputs results| Screen
    CLI -->|saves results| FS

    %% Build Flow
    Make -->|invokes| GCC
    Bat -->|invokes| Shell
    GCC -->|compiles| Array
    GCC -->|compiles| Screen
    GCC -->|compiles| ESMHg
    GCC -->|compiles| EXHg
    GCC -->|compiles| HYbHg
    GCC -->|compiles| InHg
    GCC -->|compiles| MeHg
    GCC -->|compiles| NeHg
    GCC -->|compiles| NoHg
    GCC -->|compiles| SeHg
    GCC -->|compiles| CLI
    GCC -->|produces| Linker
    Linker -->|links .o files| Exe

    %% Click Events
    click CLI "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/main.c"
    click Array "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/utils/array.c"
    click Screen "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/utils/screen.c"
    click UtilsH "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/utils/utils.h"
    click ErrMsgs "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/utils/errorMessages.h"
    click ESMHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/esotericFunMiscellaneous/esotericFunMiscellaneous.h"
    click EsDir "https://github.com/h-ssiqueira/sort_algorithms/tree/master/src/esotericFunMiscellaneous/"
    click EXHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/exchange/exchange.h"
    click ExDir "https://github.com/h-ssiqueira/sort_algorithms/tree/master/src/exchange/"
    click HYbHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/hybrids/hybrids.h"
    click TimC "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/hybrids/timSort.c"
    click InHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/insertion/insertion.h"
    click InDir "https://github.com/h-ssiqueira/sort_algorithms/tree/master/src/insertion/"
    click MeHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/merge/merge.h"
    click MeDir "https://github.com/h-ssiqueira/sort_algorithms/tree/master/src/merge/"
    click NeHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/networksConcurrent/networksConcurrent.h"
    click NeDir "https://github.com/h-ssiqueira/sort_algorithms/tree/master/src/networksConcurrent/"
    click NoHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/noncomparisonDistribution/noncomparisonDistribution.h"
    click NoDir "https://github.com/h-ssiqueira/sort_algorithms/tree/master/src/noncomparisonDistribution/"
    click SeHg "https://github.com/h-ssiqueira/sort_algorithms/blob/master/src/selection/selection.h"
    click SeDir "https://github.com/h-ssiqueira/sort_algorithms/tree/master/src/selection/"
    click Make "https://github.com/h-ssiqueira/sort_algorithms/tree/master/Makefile"
    click Bat "https://github.com/h-ssiqueira/sort_algorithms/blob/master/execute.bat"

    %% Styles
    classDef cli fill:#D0E4F5,stroke:#0288D1,color:#000;
    classDef utils fill:#E8F5E9,stroke:#43A047,color:#000;
    classDef sorting fill:#FFF3E0,stroke:#FB8C00,color:#000;
    classDef build fill:#ECEFF1,stroke:#78909C,color:#000;
    classDef external fill:#F5F5F5,stroke:#B0BEC5,color:#000
```
