# saurabh-iitr2020/practice-cpp architecture

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

- Interactive diagram: https://gitdiagram.com/saurabh-iitr2020/practice-cpp
- Repository: https://github.com/saurabh-iitr2020/practice-cpp

## Overview

##### Project Type and Purpose
- This is a monorepo of C++ practice projects: implementations of core data structures (arrays, linked lists, trees, graphs, hash tables, queues, priority queues) and algorithms (merge sort, quick sort, binary search tree operations).
- It uses CMake as the build system and GoogleTest (under lib/googletest) for unit testing.
- It is not a deployed service or full-stack app, but an educational/utility library of independent modules.

##### File Structure Analysis
- Top‐level:
- CMakeLists.txt – orchestrates discovery and building of each module.
- valgrind.sh – helper script for memory checking.
- lib/googletest – external test framework.
- A directory per module (arrays, binary_search_tree, graphs, hash_table, linked_lists, merge_sort, priority_queue, queue_array, queue_linked_list, quick_sort).
- Each module:
- CMakeLists.txt
- src files (.cc/.h)
- main.cc (example driver)
- tests (for some modules, either built into the same folder or separate tests folder)
- No cross‐dependencies between modules except all link to GoogleTest for their unit tests.

##### README Insights
- Minimal description: confirms this is day-to-day C++ practice code.
- Warns code quality/bugs might exist.

##### Components
a. Build System (CMake)
b. Modules (grouped by category):
- Data Structures: arrays/jvector, linked_lists, queue_array, queue_linked_list, priority_queue, hash_table, binary_search_tree, graphs
- Algorithms: merge_sort, quick_sort
c. Test Framework: GoogleTest (external library under lib/googletest)
d. Drivers: each module’s main.cc for demonstration
e. Tools: valgrind.sh
f. Developer Workflow: developer runs CMake → build → runs tests and demo executables → optionally valgrind.sh

##### Relationships and Data Flows
- CMakeLists.txt (root) ──► invokes module‐level CMakeLists.txt
- Module source files ──► compiled by CMake into:
- Demo executables (from main.cc)
- Test executables (linking module code + GoogleTest)
- Test executables ──► execute unit tests, reporting via GoogleTest
- valgrind.sh ──► runs built executables under Valgrind for memory checks

##### Architectural Patterns and Principles
- Modular separation: each algorithm/data structure is isolated in its own CMake target
- Single Responsibility: modules only contain code/tests for one concept
- External dependency isolation: GoogleTest lives in lib/googletest and is only linked by test targets
- Build‐time orchestration via hierarchical CMakeLists

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build System
    BuildSystem["Build System\n(CMake)"]:::build

    %% Data Structures Group
    subgraph "Data Structures"
        direction TB
        arrays["arrays/jvector"]:::ds
        linked_lists["linked_lists"]:::ds
        queue_array["queue_array"]:::ds
        queue_linked_list["queue_linked_list"]:::ds
        priority_queue["priority_queue"]:::ds
        hash_table["hash_table"]:::ds
        binary_search_tree["binary_search_tree"]:::ds
        graphs["graphs"]:::ds
    end

    %% Algorithms Group
    subgraph "Algorithms"
        direction TB
        merge_sort["merge_sort"]:::algo
        quick_sort["quick_sort"]:::algo
    end

    %% Executables and Tests
    DemoExe["Demo Executables"]:::exec
    TestExe["Test Executables"]:::test
    GoogleTest["GoogleTest\n(lib/googletest)"]:::external
    Valgrind["valgrind.sh"]:::tools

    %% Build System to Modules
    BuildSystem --> arrays
    BuildSystem --> linked_lists
    BuildSystem --> queue_array
    BuildSystem --> queue_linked_list
    BuildSystem --> priority_queue
    BuildSystem --> hash_table
    BuildSystem --> binary_search_tree
    BuildSystem --> graphs
    BuildSystem --> merge_sort
    BuildSystem --> quick_sort

    %% Module to Executables
    arrays --> DemoExe
    arrays --> TestExe
    linked_lists --> DemoExe
    linked_lists --> TestExe
    queue_array --> DemoExe
    queue_array --> TestExe
    queue_linked_list --> DemoExe
    queue_linked_list --> TestExe
    priority_queue --> DemoExe
    priority_queue --> TestExe
    hash_table --> DemoExe
    hash_table --> TestExe
    binary_search_tree --> DemoExe
    binary_search_tree --> TestExe
    graphs --> DemoExe
    graphs --> TestExe
    merge_sort --> DemoExe
    merge_sort --> TestExe
    quick_sort --> DemoExe
    quick_sort --> TestExe

    %% Test Executables to GoogleTest
    TestExe --> GoogleTest

    %% Tools to Executables
    Valgrind --> DemoExe
    Valgrind --> TestExe

    %% Click Events
    click BuildSystem "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/CMakeLists.txt"
    click arrays "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/arrays/jvector.cc"
    click arrays "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/arrays/jvector.h"
    click arrays "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/arrays/jvector_test.cc"
    click arrays "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/arrays/main.cc"
    click linked_lists "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/linked_lists/src/linked_list.cc"
    click linked_lists "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/linked_lists/src/linked_list.h"
    click linked_lists "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/linked_lists/src/list_element.h"
    click linked_lists "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/linked_lists/tests/list_tests.cc"
    click linked_lists "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/linked_lists/main.cc"
    click queue_array "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_array/src/queue_array.cc"
    click queue_array "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_array/src/queue_array.h"
    click queue_array "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_array/tests/queue_array_tests.cc"
    click queue_array "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_array/main.cc"
    click queue_linked_list "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_linked_list/src/queue_linked_list.cc"
    click queue_linked_list "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_linked_list/src/queue_linked_list.h"
    click queue_linked_list "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_linked_list/src/list_element.h"
    click queue_linked_list "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_linked_list/tests/queue_llist_tests.cc"
    click queue_linked_list "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/queue_linked_list/main.cc"
    click priority_queue "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/priority_queue/priority_queue.cc"
    click priority_queue "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/priority_queue/priority_queue.h"
    click priority_queue "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/priority_queue/main.cc"
    click hash_table "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/hash_table/hash_table.cc"
    click hash_table "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/hash_table/hash_table.h"
    click hash_table "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/hash_table/hash_object.h"
    click hash_table "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/hash_table/hash_tables_tests.cc"
    click hash_table "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/hash_table/main.cc"
    click binary_search_tree "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/binary_search_tree/bst_simple.cc"
    click binary_search_tree "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/binary_search_tree/bst_simple.h"
    click binary_search_tree "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/binary_search_tree/main.cc"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/Graph.cc"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/Graph.h"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/DirectedGraph.cc"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/DirectedGraph.h"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/GraphRepresentation.cc"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/GraphRepresentation.h"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/experiments.h"
    click graphs "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/graphs/main.cc"
    click merge_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/merge_sort/merge_sort.cc"
    click merge_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/merge_sort/merge_sort.h"
    click merge_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/merge_sort/test_merge_sort.cc"
    click merge_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/merge_sort/test_merge_sort.h"
    click merge_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/merge_sort/main.cc"
    click quick_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/quick_sort/quick_sort.cc"
    click quick_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/quick_sort/quick_sort.h"
    click quick_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/quick_sort/test_sort.cc"
    click quick_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/quick_sort/test_sort.h"
    click quick_sort "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/quick_sort/main.cc"
    click GoogleTest "https://github.com/saurabh-iitr2020/practice-cpp/tree/master/lib/googletest"
    click Valgrind "https://github.com/saurabh-iitr2020/practice-cpp/blob/master/valgrind.sh"

    %% Styling
    classDef build fill:#ffe599,stroke:#b07f00,color:#000;
    classDef ds fill:#b4c7e7,stroke:#2f5597,color:#000;
    classDef algo fill:#f4cccc,stroke:#a61c00,color:#000;
    classDef exec fill:#d9ead3,stroke:#38761d,color:#000;
    classDef test fill:#ead1dc,stroke:#741b47,color:#000;
    classDef external fill:#cfe2f3,stroke:#0b5394,color:#000;
    classDef tools fill:#fff2cc,stroke:#b45f06,color:#000;
```
