# const-me/simdintroarticle architecture

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

- Interactive diagram: https://gitdiagram.com/const-me/simdintroarticle
- Repository: https://github.com/const-me/simdintroarticle

## Overview

##### Project Type & Purpose
- This is a collection of three standalone demo applications (DotProduct, FloodFill, Grayscale) illustrating scalar vs. SIMD‐vector implementations.
- Each demo is a small command-line tool with its own Visual Studio solution (+ CMakeLists), containing a “main” driver, supporting modules (scalar, vector, misc), and in FloodFill’s case an I/O sub-library.

##### Top-Level Components
- Build System
– CMakeLists.txt at each demo root
– Visual Studio solution/project files (.sln, .vcxproj)
- Common Code
– common.h (shared declarations)
- Demo Applications
– DotProduct
– FloodFill
– Grayscale

##### Internal Structure of Each Demo
- Main executable (“main.cpp”)
- Scalar module (e.g. scalar.cpp, scanline.cpp)
- Vector module (e.g. vecFloat.cpp, vertical.cpp)
- Misc / helper code (misc.cpp / .hpp)
- FloodFill only: IO sub-library (stb_image, Image.cpp, Image.save.cpp) under FloodFill/IO.

##### Architectural Patterns & Principles
- Layered structure:
– Presentation/CLI layer (main.cpp)
– Algorithm layer (Scalar vs. Vector implementations)
– Utility layer (misc, common)
– Platform/IO layer (only in FloodFill)
- Separation of concerns: each demo isolates its I/O, core algorithm, and build scripts.
- Reuse: common.h and CMake macros can be highlighted as shared resources.

##### Key Technologies & Libraries
- CMake, Visual Studio Projects
- SIMD intrinsics (e.g. SSE/AVX in vecFloat.cpp)
- stb_image / stb_image_write for image I/O (FloodFill)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build System
    subgraph "Build System"
        BS["CMake + VS Solutions"]:::build
    end

    %% Common Code
    COMMON["common.h"]:::common

    %% DotProduct Demo
    subgraph "DotProduct Demo"
        DP_MAIN["CLI Driver\n(main.cpp)"]:::cli
        DP_SCALAR["Scalar Implementation\n(scalar.cpp)"]:::scalar
        DP_VECTOR["Vector Implementation\n(vertical.cpp)"]:::vector
        DP_MISC["Misc Helper\n(misc.cpp)"]:::misc
        DP_DPPS["Additional Module\n(dpps.cpp)"]:::misc
    end

    %% Grayscale Demo
    subgraph "Grayscale Demo"
        GS_MAIN["CLI Driver\n(main.cpp)"]:::cli
        GS_SCALAR["Scalar Implementation\n(scalar.cpp)"]:::scalar
        GS_VECF["Vector Implementation\n(vecFloat.cpp)"]:::vector
        GS_VECI["Vector Implementation\n(vecInt16.cpp)"]:::vector
        GS_MISC["Misc Helper\n(misc.cpp)"]:::misc
    end

    %% FloodFill Demo
    subgraph "FloodFill Demo"
        FF_MAIN["CLI Driver\n(main.cpp)"]:::cli
        FF_SCALAR["Scalar Implementation\n(scanline.cpp)"]:::scalar
        FF_VECTOR["Vector Implementation\n(vectorFill.cpp)"]:::vector
        FF_MISC["Misc Helper\n(misc.hpp)"]:::misc
        FF_IO["I/O Sub-Library"]:::io
        FF_ARGS["Arguments Module\n(Arguments.cpp)"]:::misc
    end

    %% Build System to Demos
    BS -->|"builds with"| DP_MAIN
    BS -->|"builds with"| GS_MAIN
    BS -->|"builds with"| FF_MAIN

    %% Demos to Common
    DP_MAIN -.includes.-> COMMON
    GS_MAIN -.includes.-> COMMON
    FF_MAIN -.includes.-> COMMON

    %% DotProduct Calls
    DP_MAIN -->|"calls"| DP_SCALAR
    DP_MAIN -->|"calls"| DP_VECTOR
    DP_MAIN -->|"calls"| DP_MISC
    DP_MAIN -->|"calls"| DP_DPPS

    %% Grayscale Calls
    GS_MAIN -->|"calls"| GS_SCALAR
    GS_MAIN -->|"calls"| GS_VECF
    GS_MAIN -->|"calls"| GS_VECI
    GS_MAIN -->|"calls"| GS_MISC

    %% FloodFill Calls
    FF_MAIN -->|"calls"| FF_SCALAR
    FF_MAIN -->|"calls"| FF_VECTOR
    FF_MAIN -->|"calls"| FF_MISC
    FF_MAIN -->|"calls"| FF_IO
    FF_MAIN -->|"calls"| FF_ARGS

    %% Styles
    classDef build fill:#dddddd,stroke:#333,stroke-width:1px
    classDef cli fill:#cde8ff,stroke:#0366d6,stroke-width:1px
    classDef scalar fill:#d4f8d4,stroke:#28a745,stroke-width:1px
    classDef vector fill:#ffe5b4,stroke:#ff8c00,stroke-width:1px
    classDef misc fill:#f0f0f0,stroke:#6c757d,stroke-width:1px
    classDef io fill:#e5daff,stroke:#6f42c1,stroke-width:1px
    classDef common fill:#fff3cd,stroke:#856404,stroke-width:1px

    %% Click Events
    click DP_MAIN "https://github.com/const-me/simdintroarticle/blob/master/DotProduct/main.cpp"
    click DP_SCALAR "https://github.com/const-me/simdintroarticle/blob/master/DotProduct/scalar.cpp"
    click DP_VECTOR "https://github.com/const-me/simdintroarticle/blob/master/DotProduct/vertical.cpp"
    click DP_MISC "https://github.com/const-me/simdintroarticle/blob/master/DotProduct/misc.cpp"
    click DP_DPPS "https://github.com/const-me/simdintroarticle/blob/master/DotProduct/dpps.cpp"
    click GS_MAIN "https://github.com/const-me/simdintroarticle/blob/master/Grayscale/main.cpp"
    click GS_SCALAR "https://github.com/const-me/simdintroarticle/blob/master/Grayscale/scalar.cpp"
    click GS_VECF "https://github.com/const-me/simdintroarticle/blob/master/Grayscale/vecFloat.cpp"
    click GS_VECI "https://github.com/const-me/simdintroarticle/blob/master/Grayscale/vecInt16.cpp"
    click GS_MISC "https://github.com/const-me/simdintroarticle/blob/master/Grayscale/misc.cpp"
    click FF_MAIN "https://github.com/const-me/simdintroarticle/blob/master/FloodFill/main.cpp"
    click FF_SCALAR "https://github.com/const-me/simdintroarticle/blob/master/FloodFill/Scalar/scanline.cpp"
    click FF_VECTOR "https://github.com/const-me/simdintroarticle/blob/master/FloodFill/Vector/vectorFill.cpp"
    click FF_MISC "https://github.com/const-me/simdintroarticle/blob/master/FloodFill/misc.hpp"
    click FF_IO "https://github.com/const-me/simdintroarticle/blob/master/FloodFill/IO/Image.cpp"
    click FF_ARGS "https://github.com/const-me/simdintroarticle/blob/master/FloodFill/Arguments.cpp"
    click COMMON "https://github.com/const-me/simdintroarticle/blob/master/common.h"
```
