# jishnurajendran/numerical-analysis architecture

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

- Interactive diagram: https://gitdiagram.com/jishnurajendran/numerical-analysis
- Repository: https://github.com/jishnurajendran/numerical-analysis

## Overview

##### Project type and purpose
- This is an open‐source Numerical Analysis repository implemented in MATLAB.
- It groups classical algorithms (root‐finding, interpolation, integration) each in its own directory of scripts and helper functions.
- It also includes static documentation (README.md, index.html, notebook.css) and a Git/GitHub hosting setup.

##### File structure
- Top‐level directories (“Fixed point”, “Newton’s Root finding”, “Lagrange Interpolation”, “Trapizoidal method”, etc.) each contain one or more .m scripts/functions plus related plots or data files.
- There is no client/server or microservices. Instead it’s a library of standalone MATLAB routines.
- Documentation files at root: README.md, README.org, index.html, notebook.css.
- LICENSE file and a Google site-verification HTML suggest GitHub Pages deployment of the static docs.

##### README for additional insights
- README describes categories: Root Finding Methods, Interpolation Techniques, Integration Methods.
- No external APIs, just MATLAB’s runtime environment.
- No mention of build scripts or automated CI/CD—usage is manual: clone repo, open scripts in MATLAB, run.

##### Main components & relationships
a. Code modules (grouped by algorithm category)
- Root‐finding: Newton’s method, Fixed point, Secant
- Interpolation: Hermite, Lagrange, Newton
- Integration: Euler, Newton–Cotes, Predictor–Corrector, Trapezoidal
b. Helper functions and scripts within each module (e.g., Eqn.m, hermit.m, lagrange_poly.m)
c. Documentation & Presentation layer:
- README in Markdown/Org
- Static site (index.html + notebook.css) served via GitHub Pages
d. External “service”: MATLAB runtime environment invoked by the user to execute .m files
e. Version control & hosting: Git/GitHub repository with open‐source license

##### Architectural patterns & principles
- Logical grouping by algorithm family (directory per category)
- Each directory follows a simple “module + helper functions + sample runs/plots” pattern
- Separation of concerns: code vs. documentation vs. license/config

##### Technologies & frameworks
- MATLAB (.m files) – core execution environment
- Git/GitHub – version control + hosting + Pages for static site
- HTML/CSS – for the static documentation site
- Markdown/Org – README sources

## Diagram (Mermaid)

```mermaid
flowchart TB
    actor("User"):::actor

    subgraph "External Systems"
        GH["GitHub / Git"]:::external
        MR["MATLAB Runtime"]:::external
    end

    subgraph "Repository"
        direction TB
        Repo["Repository"]:::container

        subgraph "Root-Finding Module"
            direction TB
            FP["Fixed point\n(Eqn.m, main.m)"]:::code
            NM["Newton’s method\n(Eqn.m, dEqn.m, main.m)"]:::code
            SM["Secant method\n(Eqn.m, main.m)"]:::code
        end

        subgraph "Interpolation Module"
            direction TB
            HI["Hermite Interpolation\n(hermit.m)"]:::code
            LI["Lagrange Interpolation\n(Lagrange_interpol_main.m, lagrange_poly.m)"]:::code
            NI["Newton’s Interpolation\n(Newtons_interpol.m, Newtons_interpol_00.m, newton_plot.m)"]:::code
        end

        subgraph "Integration Module"
            direction TB
            EM["Euler Method\n(euler.m)"]:::code
            NC["Newton–Cotes Method\n(Newton_Cotes.m, lagrange_poly.m)"]:::code
            PC["Predictor–Corrector\n(predictor_corrector.m)"]:::code
            TM["Trapezoidal Method\n(Trapizoidal.m, Trapizoidal_error.m)"]:::code
        end

        subgraph "Documentation & Presentation"
            direction TB
            RD["README.md, README.org"]:::docs
            SI["index.html, notebook.css"]:::docs
            GV["google20416f7f2c4463fa.html"]:::docs
        end

        LIC["LICENSE"]:::docs
    end

    actor -->|git clone / pull| GH
    GH -->|hosts repo| Repo
    actor -->|open / modify| Repo
    actor -->|executes .m scripts| MR
    Repo -->|serves docs via Pages| SI
    SI -->|view docs| actor

    click FP "https://github.com/jishnurajendran/numerical-analysis/tree/master/Fixed point/"
    click NM "https://github.com/jishnurajendran/numerical-analysis/tree/master/Newton’s Root finding/"
    click SM "https://github.com/jishnurajendran/numerical-analysis/tree/master/Secant method/"
    click HI "https://github.com/jishnurajendran/numerical-analysis/tree/master/Hermite Interpolation/"
    click LI "https://github.com/jishnurajendran/numerical-analysis/tree/master/Lagrange Interpolation/"
    click NI "https://github.com/jishnurajendran/numerical-analysis/tree/master/Newton's Interpolation/"
    click EM "https://github.com/jishnurajendran/numerical-analysis/tree/master/Euler Method/"
    click NC "https://github.com/jishnurajendran/numerical-analysis/tree/master/Newton-Cones method/"
    click PC "https://github.com/jishnurajendran/numerical-analysis/tree/master/Predictor-Corrector method/"
    click TM "https://github.com/jishnurajendran/numerical-analysis/tree/master/Trapizoidal method/"
    click RD "https://github.com/jishnurajendran/numerical-analysis/blob/master/README.md"
    click SI "https://github.com/jishnurajendran/numerical-analysis/blob/master/index.html"
    click GV "https://github.com/jishnurajendran/numerical-analysis/blob/master/google20416f7f2c4463fa.html"
    click LIC "https://github.com/jishnurajendran/numerical-analysis/tree/master/LICENSE"

    classDef code fill:#cce5ff,stroke:#004085,color:#004085;
    classDef docs fill:#d4edda,stroke:#155724,color:#155724;
    classDef external fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
    classDef actor fill:#fff3cd,stroke:#856404,color:#856404;
    classDef container fill:#ffffff,stroke:#0000ff,color:#000;
    class Repo container
```
