# abdelhamid108/numerical-project architecture

> Architecture diagram of the GitHub repository abdelhamid108/numerical-project, 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/abdelhamid108/numerical-project
- Repository: https://github.com/abdelhamid108/numerical-project

## Overview

##### Project type and purpose
- This is a C++ command-line numerical-analysis toolkit (not a web or distributed system).
- Its core is an EquationParser for parsing and evaluating mathematical expressions, plus a suite of numerical-methods modules (root finding, interpolation, integration, ODE stepping, polynomial fitting).
- The main.cpp file ties everything together into a single executable.

##### File structure
- Top level:
- .vscode (IDE config)
- README.md (EquationParser documentation)
- headers/ (public API headers for each module)
- src/ (implementation of each module)
- main.cpp (the CLI “driver”)
- main.exe (built executable)
- Notice one directory for headers, one for sources, and one entry-point file.
- Each numerical method lives in its own header+cpp pair: bisection, secant, integration, EulerMethods, LagrangeInterpolator, DividedDifferenceInterpolator, PolynomialFitter, plus parser.

##### README for additional insights
- The README focuses on the EquationParser class—its public API, tokenization, infix→postfix conversion, and evaluation.
- It does not describe the numerical algorithms in detail, but their existence in the headers/src makes clear they form separate modules that consume either the parser or raw numbers.

a. Main components:
1. CLI Interface (main.cpp)
2. EquationParser
- Tokenizer (splits input string into tokens)
- Infix→Postfix Converter
- Evaluator (postfix interpreter)
3. Numerical Methods Modules
- Root-finding: Bisection, Secant
- Integration
- ODE solver: EulerMethods
- Interpolation: LagrangeInterpolator, DividedDifferenceInterpolator
- PolynomialFitter
4. Data models: Token, AST node (implicit in parser), result data structures
5. Output/Console
b. Relationships & interactions:
- CLI → reads user input → passes equation (string) & parameters to EquationParser
- EquationParser → parses → converts to postfix → evaluates to produce a callable function f(x) or f(x,y)
- CLI → selects numerical method → passes f(x)/data to the chosen module
- Numerical module → computes results → returns numeric result or data array
- CLI → prints results to console
c. Architectural patterns & principles:
- Modular design: each algorithm is self-contained in its own header+cpp
- Single executable, no external services
- Separation of concerns: parsing/evaluation isolated from numerical methods
d. Key technologies:
- C++17 (or above), standard library
- No external dependencies
- Build system: presumably g++ or MSVC (main.exe present)

##### Elements
- Clear rectangular blocks for each component (CLI, Parser, Tokenizer, Converter, Evaluator, each numerical module).
- Input flow: User input → CLI
- Parsing flow: CLI → Tokenizer → Converter → Evaluator
- Computation flow: Evaluator → Numerical Method → Result
- Output flow: CLI → Console
- Numerical modules in another
- I/O in a third
- Annotations for key methods (e.g., EquationParser::parseEquation(), ::evaluate(), Bisection::findRoot()).

## Diagram (Mermaid)

```mermaid
flowchart TB
    User["User"]:::external
    CLI["CLI Interface\n(main.cpp)"]:::io
    Console["Console Output"]:::io

    subgraph "Parser Subsystem"
        Tokenizer["Tokenizer"]:::parser
        Converter["Infix→Postfix Converter"]:::parser
        Evaluator["Evaluator"]:::parser
    end

    subgraph "Numerical Methods" 
        Bisection["Bisection"]:::num
        Secant["Secant"]:::num
        Integration["Integration"]:::num
        EulerMethods["EulerMethods"]:::num
        LagrangeInterpolator["LagrangeInterpolator"]:::num
        DividedDifferenceInterpolator["DividedDifferenceInterpolator"]:::num
        PolynomialFitter["PolynomialFitter"]:::num
    end

    User -->|"enters equation & params"| CLI
    CLI -->|"parseEquation()"| Tokenizer
    Tokenizer -->|"tokens"| Converter
    Converter -->|"postfix expr"| Evaluator

    Evaluator -->|"f(x), f(x,y)"| Bisection
    Evaluator -->|"f(x), f(x,y)"| Secant
    Evaluator -->|"f(x), f(x,y)"| Integration
    Evaluator -->|"f(x), f(x,y)"| EulerMethods
    Evaluator -->|"f(x), f(x,y)"| LagrangeInterpolator
    Evaluator -->|"f(x), f(x,y)"| DividedDifferenceInterpolator
    Evaluator -->|"f(x), f(x,y)"| PolynomialFitter

    Bisection -->|"result"| CLI
    Secant -->|"result"| CLI
    Integration -->|"result"| CLI
    EulerMethods -->|"result"| CLI
    LagrangeInterpolator -->|"data array"| CLI
    DividedDifferenceInterpolator -->|"data array"| CLI
    PolynomialFitter -->|"coefficients"| CLI

    CLI -->|"print()"| Console

    click CLI "https://github.com/abdelhamid108/numerical-project/blob/master/main.cpp"
    click Tokenizer "https://github.com/abdelhamid108/numerical-project/blob/master/headers/parser.h"
    click Converter "https://github.com/abdelhamid108/numerical-project/blob/master/headers/parser.h"
    click Evaluator "https://github.com/abdelhamid108/numerical-project/blob/master/headers/parser.h"
    click Bisection "https://github.com/abdelhamid108/numerical-project/blob/master/headers/bisection.h"
    click Secant "https://github.com/abdelhamid108/numerical-project/blob/master/headers/secant.h"
    click Integration "https://github.com/abdelhamid108/numerical-project/blob/master/headers/integration.h"
    click EulerMethods "https://github.com/abdelhamid108/numerical-project/blob/master/headers/EulerMethods.h"
    click LagrangeInterpolator "https://github.com/abdelhamid108/numerical-project/blob/master/headers/LagrangeInterpolator.h"
    click DividedDifferenceInterpolator "https://github.com/abdelhamid108/numerical-project/blob/master/headers/DividedDifferenceInterpolator.h"
    click PolynomialFitter "https://github.com/abdelhamid108/numerical-project/blob/master/headers/PolynomialFitter.h"
    click Console "https://github.com/abdelhamid108/numerical-project/blob/master/main.cpp"

    classDef parser fill:#AED6F1,stroke:#1B4F72,color:#1B2631
    classDef num fill:#A9DFBF,stroke:#145A32,color:#1B2631
    classDef io fill:#D5D8DC,stroke:#424949,color:#1B2631
    classDef external fill:#F9E79F,stroke:#7D6608,color:#1B2631
```
