# alifahrri/nmtools architecture

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

- Interactive diagram: https://gitdiagram.com/alifahrri/nmtools
- Repository: https://github.com/alifahrri/nmtools

## Overview

nmtools is a generic C++ multidimensional-array and tensor-computation library. Users create or wrap arrays, compose NumPy-like operations and views, then evaluate results with a selected context; the README also describes computational-graph capture, Tilekit kernels, and CPU/GPU execution. The graph groups array operations, core composition and indexing, evaluation and runtime, and parallel backends. Relationships are limited to README statements and source excerpts or index references; unsampled subsystem internals are not assumed.

Main entry points: [`include/nmtools/array/matmul.hpp`](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/array/matmul.hpp) (Numerical operations), [`include/nmtools/core/eval.hpp`](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/eval.hpp) (Evaluation), [`include/nmtools/core/functor.hpp`](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/functor.hpp) (Composable views), [`include/nmtools/core/computational_graph.hpp`](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/computational_graph.hpp) (Computational graphs)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_arrays["Array operations"]
  node_array_api["Array API<br/>[array.hpp]"]
  node_ndarray["Array containers<br/>[array.hpp]"]
  node_array_ops["Numerical operations<br/>[matmul.hpp]"]
  node_ufunc["Universal functions<br/>[greater.hpp]"]
end

subgraph group_core["Views and indexing"]
  node_views["Composable views<br/>[functor.hpp]"]
  node_decorators["View decorators<br/>[decorator.hpp]"]
  node_computational_graph["Computational graphs"]
  node_indexing["Index calculations<br/>[slice.hpp]"]
  node_shape_product["Shape sizing<br/>[product.hpp]"]
  node_type_traits["Type and shape metadata<br/>[meta.hpp]"]
end

subgraph group_execution["Evaluation and runtime"]
  node_evaluation["Evaluation<br/>[eval.hpp]"]
  node_contexts["Execution contexts<br/>[context.hpp]"]
  node_runtime_array["Dynamic runtime arrays<br/>[ndarray.hpp]"]
  node_runtime_context["Runtime context<br/>[context.hpp]"]
  node_cpu_runtime["CPU runtime<br/>[mod.hpp]"]
end

subgraph group_accelerators["Parallel backends"]
  node_gpu_contexts["GPU contexts<br/>[cuda.hpp]"]
  node_tilekit["Tilekit kernels<br/>[vector.hpp]"]
end

node_user(("C++ user"))
node_result["Computed result"]

node_user -->|"uses"| node_array_api
node_array_api -->|"wraps arrays"| node_ndarray
node_user -->|"composes operations"| node_array_ops
node_array_ops -->|"uses functions"| node_ufunc
node_user -->|"composes views"| node_views
node_views -->|"uses decorators"| node_decorators
node_user -->|"captures graph"| node_computational_graph
node_computational_graph -.->|"represents views"| node_views
node_array_ops -->|"uses indices"| node_indexing
node_indexing -->|"sizes shapes"| node_shape_product
node_ndarray -->|"evaluates views"| node_evaluation
node_evaluation -->|"dispatches evaluation"| node_contexts
node_contexts -->|"sizes buffers"| node_shape_product
node_evaluation -->|"returns result"| node_result
node_runtime_array -->|"uses graph transforms"| node_computational_graph
node_runtime_context -->|"provides runtime"| node_runtime_array
node_user -->|"selects backend"| node_gpu_contexts
node_gpu_contexts -.->|"evaluates operations"| node_evaluation
node_user -->|"runs tiled kernels"| node_tilekit
node_type_traits -->|"resolves operation types"| node_array_ops
node_user -.->|"uses CPU runtime"| node_cpu_runtime

click node_array_api "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/array.hpp"
click node_ndarray "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/ndarray/array.hpp"
click node_array_ops "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/array/matmul.hpp"
click node_ufunc "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/array/ufuncs/greater.hpp"
click node_views "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/functor.hpp"
click node_decorators "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/decorator.hpp"
click node_computational_graph "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/computational_graph.hpp"
click node_indexing "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/index/slice.hpp"
click node_shape_product "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/index/product.hpp"
click node_type_traits "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/meta.hpp"
click node_evaluation "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/eval.hpp"
click node_contexts "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/context.hpp"
click node_runtime_array "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/runtime/ndarray.hpp"
click node_runtime_context "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/runtime/context.hpp"
click node_cpu_runtime "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/runtime/cpu/mod.hpp"
click node_gpu_contexts "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/context/cuda.hpp"
click node_tilekit "https://github.com/alifahrri/nmtools/blob/master/include/nmtools/tilekit/vector.hpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_array_api,node_ndarray,node_array_ops,node_ufunc,node_user toneBlue
class node_views,node_decorators,node_computational_graph,node_indexing,node_shape_product,node_type_traits toneAmber
class node_evaluation,node_contexts,node_runtime_array,node_runtime_context,node_cpu_runtime toneMint
class node_gpu_contexts,node_tilekit toneRose
class node_result toneIndigo
```

## Components

### Array operations

- [Array API](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/array.hpp): `include/nmtools/array.hpp`
- [Array containers](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/ndarray/array.hpp): `include/nmtools/ndarray/array.hpp`
- [Numerical operations](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/array/matmul.hpp): `include/nmtools/array/matmul.hpp`
- [Universal functions](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/array/ufuncs/greater.hpp): `include/nmtools/array/ufuncs/greater.hpp`

### Views and indexing

- [Composable views](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/functor.hpp): `include/nmtools/core/functor.hpp`
- [View decorators](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/decorator.hpp): `include/nmtools/core/decorator.hpp`
- [Computational graphs](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/computational_graph.hpp): `include/nmtools/core/computational_graph.hpp`
- [Index calculations](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/index/slice.hpp): `include/nmtools/index/slice.hpp`
- [Shape sizing](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/index/product.hpp): `include/nmtools/index/product.hpp`
- [Type and shape metadata](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/meta.hpp): `include/nmtools/meta.hpp`

### Evaluation and runtime

- [Evaluation](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/eval.hpp): `include/nmtools/core/eval.hpp`
- [Execution contexts](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/core/context.hpp): `include/nmtools/core/context.hpp`
- [Dynamic runtime arrays](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/runtime/ndarray.hpp): `include/nmtools/runtime/ndarray.hpp`
- [Runtime context](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/runtime/context.hpp): `include/nmtools/runtime/context.hpp`
- [CPU runtime](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/runtime/cpu/mod.hpp): `include/nmtools/runtime/cpu/mod.hpp`

### Parallel backends

- [GPU contexts](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/context/cuda.hpp): `include/nmtools/context/cuda.hpp`
- [Tilekit kernels](https://github.com/alifahrri/nmtools/blob/master/include/nmtools/tilekit/vector.hpp): `include/nmtools/tilekit/vector.hpp`

### Other components

- **C++ user**
- **Computed result**

## Connections

- C++ user → Array API: uses (evidence: `README.md`)
- Array API → Array containers: wraps arrays (evidence: `include/nmtools/ndarray/array.hpp`)
- C++ user → Numerical operations: composes operations (evidence: `README.md`)
- Numerical operations → Universal functions: uses functions (evidence: `include/nmtools/array/matmul.hpp`)
- C++ user → Composable views: composes views (evidence: `README.md`)
- Composable views → View decorators: uses decorators (evidence: `include/nmtools/core/functor.hpp`)
- C++ user → Computational graphs: captures graph (evidence: `README.md`)
- Computational graphs → Composable views: represents views
- Numerical operations → Index calculations: uses indices (evidence: `include/nmtools/array/matmul.hpp`)
- Index calculations → Shape sizing: sizes shapes (evidence: `include/nmtools/index/product.hpp`)
- Array containers → Evaluation: evaluates views (evidence: `include/nmtools/ndarray/array.hpp`)
- Evaluation → Execution contexts: dispatches evaluation (evidence: `include/nmtools/core/eval.hpp`)
- Execution contexts → Shape sizing: sizes buffers (evidence: `include/nmtools/core/context.hpp`)
- Evaluation → Computed result: returns result (evidence: `include/nmtools/core/eval.hpp`)
- Dynamic runtime arrays → Computational graphs: uses graph transforms (evidence: `include/nmtools/runtime/ndarray.hpp`)
- Runtime context → Dynamic runtime arrays: provides runtime (evidence: `include/nmtools/runtime/context.hpp`)
- C++ user → GPU contexts: selects backend (evidence: `README.md`)
- GPU contexts → Evaluation: evaluates operations
- C++ user → Tilekit kernels: runs tiled kernels (evidence: `README.md`)
- Type and shape metadata → Numerical operations: resolves operation types (evidence: `include/nmtools/array/matmul.hpp`)
- C++ user → CPU runtime: uses CPU runtime
