# anqooqie/proconlib architecture

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

- Interactive diagram: https://gitdiagram.com/anqooqie/proconlib
- Repository: https://github.com/anqooqie/proconlib

## Overview

##### Project type and purpose
- This is an open-source, header-only C++ library (“My Library for Competitive Programming”) that provides algorithms and data structures for contest use.
- It offers hundreds of modules (tools/*.hpp), a suite of automated tests (tests/…), documentation (docs/…), example templates (template/…), and CI verification (​.github/, .verify-helper/).

##### File structure
- Top-level directories:
- tools/ – the library’s core: each header implements one algorithm or DS.
- docs/ – markdown documentation for each algorithm.
- tests/ – Google-Test-style or custom test cases exercising each module.
- template/ – example code (main.cpp, input/output generators, Makefile).
- lib/ac-library – submodule for AtCoder’s library.
- .github/ & .verify-helper/ – CI workflows and configuration for automatic verification.
- Build scripts:
- Makefile (root): orchestrates documentation generation, test compilation, and maybe bundling.
- template/Makefile: shows how to compile example code with the library.
- Configuration:
- .gitmodules for submodule.
- .github/workflows/verify.yml triggers CI on push/PR.
- verify-helper/config.toml for test runner settings.

##### README for additional insights
- Describes usage: include headers, use oj-bundle to flatten includes for judge submissions.
- Points to GitHub Pages for published docs.
- Mentions C++20, gcc.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Competitive Programming Library"
        subgraph "Code Modules"
            LibraryCore["Library Core\n(tools/)"]:::code
        end
        subgraph "Documentation"
            DocsSrc["Documentation Sources\n(docs/)"]:::docs
        end
        subgraph "Test Harness"
            TestHarness["Test Harness\n(tests/)"]:::code
            TestConfig["Test Runner Config\n(.verify-helper/config.toml)"]:::ci
        end
        subgraph "Examples"
            Template["Example Templates\n(template/)"]:::code
            TemplateMake["Template Makefile\n(template/Makefile)"]:::code
        end
        RootMake["Root Build Orchestration\n(Makefile)"]:::code
        Readme["Project Metadata\n(README.md)"]:::code
        License["License Information\n(LICENSE)"]:::code
        Gitmodules["Git Submodule Config\n(.gitmodules)"]:::code
        ACSub["AtCoder Library Submodule\n(lib/ac-library)"]:::external
    end

    subgraph "CI Pipeline"
        CIWorkflow["CI Workflow Definitions\n(.github/workflows/verify.yml)"]:::ci
        CIHelper["CI Helper Scripts\n(.verify-helper/)"]:::ci
    end

    OjBundle["oj-bundle Tool"]:::external
    GitPages["GitHub Pages"]:::external

    CIWorkflow -->|initializes submodule| ACSub
    CIWorkflow -->|runs| CIHelper
    CIHelper -->|compiles & runs| TestHarness
    CIHelper -->|generates docs from| DocsSrc
    CIWorkflow -->|deploys docs to| GitPages

    CIWorkflow -->|invokes| RootMake
    RootMake -->|build & test| TestHarness
    RootMake -->|build docs| DocsSrc
    RootMake -->|bundle user code| OjBundle

    LibraryCore -->|tested by| TestHarness
    LibraryCore -->|documented in| DocsSrc
    Template -->|includes| LibraryCore
    OjBundle -->|flattens includes of| LibraryCore
    DocsSrc -->|publishes to| GitPages

    click LibraryCore "https://github.com/anqooqie/proconlib/tree/main/tools/"
    click DocsSrc "https://github.com/anqooqie/proconlib/tree/main/docs/"
    click TestHarness "https://github.com/anqooqie/proconlib/tree/main/tests/"
    click TestConfig "https://github.com/anqooqie/proconlib/blob/main/.verify-helper/config.toml"
    click CIWorkflow "https://github.com/anqooqie/proconlib/blob/main/.github/workflows/verify.yml"
    click CIHelper "https://github.com/anqooqie/proconlib/tree/main/.verify-helper/"
    click Template "https://github.com/anqooqie/proconlib/tree/main/template/"
    click TemplateMake "https://github.com/anqooqie/proconlib/tree/main/template/Makefile"
    click RootMake "https://github.com/anqooqie/proconlib/tree/main/Makefile"
    click ACSub "https://github.com/anqooqie/proconlib/tree/main/lib/ac-library"
    click Gitmodules "https://github.com/anqooqie/proconlib/blob/main/.gitmodules"
    click Readme "https://github.com/anqooqie/proconlib/blob/main/README.md"
    click License "https://github.com/anqooqie/proconlib/tree/main/LICENSE"

    classDef code fill:#D0E6FF,stroke:#5B8FF9,color:#000;
    classDef docs fill:#E6FFDA,stroke:#73D13D,color:#000;
    classDef ci fill:#FFF1B8,stroke:#FAAD14,color:#000;
    classDef external fill:#F5F5F5,stroke:#A8A8A8,color:#000;
```
