# coltonc3/comp250 architecture

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

- Interactive diagram: https://gitdiagram.com/coltonc3/comp250
- Repository: https://github.com/coltonc3/comp250

## Overview

##### Project Type and Purpose
- The repository is not a single full-stack application; it is a collection of separate assignments covering topics such as KD Trees, implementing big integers, search engine functionalities with XML parsing, and a strategy game simulation.
- The README emphasizes the course’s focus on mathematical tools, fundamental data structures, algorithms (both recursive and non-recursive), and abstract data types.
- Each assignment (e.g., KDTrees, MyBigInteger, SearchEngines, StrategyGame) is implemented as a standalone project within the repository, with its own source files and test or assignment instructions (e.g., “A1.pdf”, “A2.pdf”, etc.).

##### File Structure
- Top-level directories (KDTrees, MyBigInteger, SearchEngines, StrategyGame) represent independent modules or assignments.
- Each directory’s “src” subfolder contains the primary Java source files that implement the key functionality.
- There are test or demo classes (e.g., TestAllCases.java, MiniTester.java, SyntaxTester.java) which indicate where unit tests or simulators are.
- The PDFs (A1.pdf, A2.pdf, etc.) likely contain assignment specifications that further detail expected design and functionality.

- Central Component: “COMP250 Coursework” – this is the overarching container. Underneath, list each assignment as a separate component.
- For KDTrees:
- Components: KDTree, Datum, and accompanying test classes (Tester.java, TestAllCases.java).
- Relationship: KDTree uses/operates on Datum objects; test classes validate functionality.
- For MyBigInteger:
- Components: MyBigInteger.java and TesterPosted.java.
- Relationship: The main arithmetic logic is encapsulated in MyBigInteger, while the tester exercises its methods.
- For SearchEngines:
- Components: SearchEngine, MyWebGraph, XmlParser, Sorting, and driver classes (GraderV2.java, MyTester.java).
- Relationships: Likely, the SearchEngine orchestrates interactions with MyWebGraph (for linking or indexing) and XmlParser (for interpreting XML test files). Sorting is a utility which might be used in indexing or query processing.
- For StrategyGame:
- Components: MilitaryUnit (base type) and its derived classes such as Archer, Warrior, Settler, Worker, and other supporting components like Tile and ListOfUnits.
- Relationship: The game simulation illustrates interactions among different units and terrain (Tile), with test classes (MiniTester.java, SyntaxTester.java) ensuring game rules and behavior.

##### Architectural Patterns / Design Principles
- Though these assignments are largely self-contained, you might note common Java object–oriented design principles (inheritance used in StrategyGame, encapsulation in MyBigInteger, modularization in SearchEngines).
- “utility” or “helper” modules (for instance, the XmlParser and Sorting in SearchEngines) that support core functionality.

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["COMP250 Coursework"]:::umbrella

    subgraph "KDTrees"
        KDZ["KDTree.java"]:::core
        DAT["Datum.java"]:::core
        TEST1["TestAllCases.java"]:::test
        TEST2["Tester.java"]:::test
        SPEC["A3.pdf"]:::doc
        KDZ -->|"uses"| DAT
        TEST1 -.->|"tests"| KDZ
        TEST2 -.->|"tests"| KDZ
    end

    subgraph "MyBigInteger"
        MBI["MyBigInteger.java"]:::core
        TEST_MB["TesterPosted.java"]:::test
        SPEC_MB["A2.pdf"]:::doc
        TEST_MB -.->|"tests"| MBI
    end

    subgraph "SearchEngines"
        SE["SearchEngine.java"]:::core
        WG["MyWebGraph.java"]:::core
        XMLP["XmlParser.java"]:::util
        SORT["Sorting.java"]:::util
        GRADER["GraderV2.java"]:::test
        TEST_SE["MyTester.java"]:::test
        SPEC_SE["A4.pdf"]:::doc
        XML_S1["sampleTest.xml"]:::doc
        XML_S2["test.xml"]:::doc
        XML_S3["testAcyclic.xml"]:::doc
        SE -->|"manages"| WG
        SE -->|"parses"| XMLP
        SE -->|"sorts"| SORT
        GRADER -.->|"drives"| SE
        TEST_SE -.->|"drives"| SE
    end

    subgraph "StrategyGame"
        MU["MilitaryUnit.java"]:::core
        ARCH["Archer.java"]:::core
        WARN["Warrior.java"]:::core
        SETT["Settler.java"]:::core
        WORK["Worker.java"]:::core
        UNIT["Unit.java"]:::core
        TILE["Tile.java"]:::core
        LOU["ListOfUnits.java"]:::util
        TEST_MINI["MiniTester.java"]:::test
        TEST_SYNTAX["SyntaxTester.java"]:::test
        SPEC_STRAT["A1.pdf"]:::doc
        MU -->|"inherits"| ARCH
        MU -->|"inherits"| WARN
        MU -->|"inherits"| SETT
        MU -->|"inherits"| WORK
        MU -->|"inherits"| UNIT
        MU -->|"operates on"| TILE
        TEST_MINI -.->|"validates"| MU
        TEST_SYNTAX -.->|"validates"| MU
    end

    A -->|"contains"| KDZ
    A -->|"contains"| MBI
    A -->|"contains"| SE
    A -->|"contains"| MU

    click A "https://github.com/coltonc3/comp250/blob/master/."
    click KDZ "https://github.com/coltonc3/comp250/blob/master/KDTrees/src/KDTree.java"
    click DAT "https://github.com/coltonc3/comp250/blob/master/KDTrees/src/Datum.java"
    click TEST1 "https://github.com/coltonc3/comp250/blob/master/KDTrees/src/TestAllCases.java"
    click TEST2 "https://github.com/coltonc3/comp250/blob/master/KDTrees/src/Tester.java"
    click SPEC "https://github.com/coltonc3/comp250/blob/master/KDTrees/A3.pdf"
    click MBI "https://github.com/coltonc3/comp250/blob/master/MyBigInteger/src/MyBigInteger.java"
    click TEST_MB "https://github.com/coltonc3/comp250/blob/master/MyBigInteger/src/TesterPosted.java"
    click SPEC_MB "https://github.com/coltonc3/comp250/blob/master/MyBigInteger/A2.pdf"
    click SE "https://github.com/coltonc3/comp250/blob/master/SearchEngines/src/SearchEngine.java"
    click WG "https://github.com/coltonc3/comp250/blob/master/SearchEngines/src/MyWebGraph.java"
    click XMLP "https://github.com/coltonc3/comp250/blob/master/SearchEngines/src/XmlParser.java"
    click SORT "https://github.com/coltonc3/comp250/blob/master/SearchEngines/src/Sorting.java"
    click GRADER "https://github.com/coltonc3/comp250/blob/master/SearchEngines/src/GraderV2.java"
    click TEST_SE "https://github.com/coltonc3/comp250/blob/master/SearchEngines/src/MyTester.java"
    click SPEC_SE "https://github.com/coltonc3/comp250/blob/master/SearchEngines/A4.pdf"
    click XML_S1 "https://github.com/coltonc3/comp250/blob/master/SearchEngines/sampleTest.xml"
    click XML_S2 "https://github.com/coltonc3/comp250/blob/master/SearchEngines/test.xml"
    click XML_S3 "https://github.com/coltonc3/comp250/blob/master/SearchEngines/testAcyclic.xml"
    click MU "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/MilitaryUnit.java"
    click ARCH "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/Archer.java"
    click WARN "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/Warrior.java"
    click SETT "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/Settler.java"
    click WORK "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/Worker.java"
    click UNIT "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/Unit.java"
    click TILE "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/Tile.java"
    click LOU "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/ListOfUnits.java"
    click TEST_MINI "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/MiniTester.java"
    click TEST_SYNTAX "https://github.com/coltonc3/comp250/blob/master/StrategyGame/src/SyntaxTester.java"
    click SPEC_STRAT "https://github.com/coltonc3/comp250/blob/master/StrategyGame/A1.pdf"

    classDef core fill:#cce5ff,stroke:#333,stroke-width:2px;
    classDef test fill:#d4edda,stroke:#333,stroke-width:2px;
    classDef util fill:#fff3cd,stroke:#333,stroke-width:2px;
    classDef doc fill:#f8d7da,stroke:#333,stroke-width:2px;
    classDef umbrella fill:#FAD7A0,stroke:#333,stroke-width:2px;
```
