# isharak7m/numj architecture

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

- Interactive diagram: https://gitdiagram.com/isharak7m/numj
- Repository: https://github.com/isharak7m/numj

## Overview

JNumj is a zero-dependency Java numerical-computing library. A user creates an NDArray through the Arrays API, applies element-wise or structural operations, and can pass results to analysis such as linear algebra or statistics. Its major documented capabilities also include indexing, search and sort, random generation, polynomials, file I/O, and forward- and reverse-mode autodiff. The graph reflects README capabilities and indexed dependencies; some subsystem implementations were not excerpted, so their internal links are omitted where unverified.

Main entry points: [`src/main/java/jnumpy/core/Arrays.java`](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/core/Arrays.java) (Arrays Facade), [`src/main/java/jnumpy/ndarray/NDArray.java`](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/ndarray/NDArray.java) (NDArray), [`src/main/java/jnumpy/ufunc/UFunc.java`](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/ufunc/UFunc.java) (Universal Functions), [`src/main/java/jnumpy/memory/MemoryBuffer.java`](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/memory/MemoryBuffer.java) (Memory Buffers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_array_core["Array Core"]
  node_api["Arrays Facade<br/>[Arrays.java]"]
  node_array["NDArray<br/>[NDArray.java]"]
  node_dtype["Data Types<br/>[DType.java]"]
  node_memory["Memory Buffers<br/>[MemoryBuffer.java]"]
  node_heap["Heap Buffers"]
  node_offheap["Off-Heap Buffer"]
  node_util["Typed Access<br/>[Util.java]"]
end

subgraph group_array_ops["Array Operations"]
  node_ufunc["Universal Functions<br/>[UFunc.java]"]
  node_broadcast["Broadcasting<br/>[Broadcast.java]"]
  node_indexing["Indexing<br/>[Indexer.java]"]
  node_manipulation["Array Manipulation<br/>[Manipulation.java]"]
end

subgraph group_analysis["Numerical Analysis"]
  node_linalg["Linear Algebra<br/>[Linalg.java]"]
  node_statistics["Statistics<br/>[Statistics.java]"]
  node_search["Search &amp; Sets<br/>[Search.java]"]
  node_sort["Sorting<br/>[Sort.java]"]
  node_polynomial["Polynomials<br/>[Polynomial.java]"]
end

subgraph group_generation_io["Generation &amp; I/O"]
  node_creation["Array Creation<br/>[Creation.java]"]
  node_random["Random Sampling<br/>[Random.java]"]
  node_io["Array I/O<br/>[IO.java]"]
end

subgraph group_autodiff["Differentiation"]
  node_dual["Dual Numbers<br/>[Dual.java]"]
  node_tape["Gradient Tape<br/>[Tape.java]"]
  node_var["Differentiable Var<br/>[Var.java]"]
  node_grad["Gradient API<br/>[Grad.java]"]
end

node_user(("Java Caller"))

node_user -->|"calls"| node_api
node_api -->|"delegates creation"| node_creation
node_api -->|"delegates operations"| node_ufunc
node_api -->|"delegates algebra"| node_linalg
node_api -->|"delegates statistics"| node_statistics
node_api -->|"delegates manipulation"| node_manipulation
node_api -->|"delegates search"| node_search
node_api -->|"delegates sorting"| node_sort
node_api -->|"delegates sampling"| node_random
node_api -->|"delegates fitting"| node_polynomial
node_api -->|"delegates I/O"| node_io
node_array -->|"invokes operations"| node_ufunc
node_array -->|"delegates indexing"| node_indexing
node_ufunc -->|"uses iteration"| node_broadcast
node_indexing -->|"broadcasts assignment"| node_broadcast
node_manipulation -->|"slices arrays"| node_indexing
node_search -->|"sorts inputs"| node_sort
node_statistics -->|"sorts quantiles"| node_sort
node_creation -->|"constructs arrays"| node_array
node_linalg -->|"consumes arrays"| node_array
node_statistics -->|"consumes arrays"| node_array
node_random -->|"produces arrays"| node_array
node_polynomial -->|"consumes arrays"| node_array
node_io -->|"reads and writes"| node_array
node_array -->|"stores data in"| node_memory
node_memory -->|"allocates heap"| node_heap
node_memory -->|"supports off-heap"| node_offheap
node_array -->|"tracks type"| node_dtype
node_ufunc -->|"reads and writes values"| node_util
node_user -->|"requests derivatives"| node_grad
node_grad -->|"evaluates forward mode"| node_dual
node_grad -->|"uses reverse mode"| node_tape
node_tape -->|"creates variables"| node_var
node_var -->|"records operations"| node_tape

click node_api "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/core/Arrays.java"
click node_array "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/ndarray/NDArray.java"
click node_dtype "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/dtype/DType.java"
click node_memory "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/memory/MemoryBuffer.java"
click node_heap "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/memory/HeapMemoryBuffer.java"
click node_offheap "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/memory/OffHeapMemoryBuffer.java"
click node_util "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/util/Util.java"
click node_creation "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/creation/Creation.java"
click node_ufunc "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/ufunc/UFunc.java"
click node_broadcast "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/broadcast/Broadcast.java"
click node_indexing "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/indexing/Indexer.java"
click node_manipulation "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/manipulation/Manipulation.java"
click node_linalg "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/linalg/Linalg.java"
click node_statistics "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/statistics/Statistics.java"
click node_search "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/search/Search.java"
click node_sort "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/sort/Sort.java"
click node_random "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/random/Random.java"
click node_polynomial "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/polynomial/Polynomial.java"
click node_io "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/io/IO.java"
click node_dual "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Dual.java"
click node_tape "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Tape.java"
click node_var "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Var.java"
click node_grad "https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Grad.java"

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_api,node_array,node_dtype,node_memory,node_heap,node_offheap,node_util toneBlue
class node_ufunc,node_broadcast,node_indexing,node_manipulation toneAmber
class node_linalg,node_statistics,node_search,node_sort,node_polynomial toneMint
class node_creation,node_random,node_io toneRose
class node_dual,node_tape,node_var,node_grad,node_user toneIndigo
```

## Components

### Array Core

- [Arrays Facade](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/core/Arrays.java): `src/main/java/jnumpy/core/Arrays.java`
- [NDArray](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/ndarray/NDArray.java): `src/main/java/jnumpy/ndarray/NDArray.java`
- [Data Types](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/dtype/DType.java): `src/main/java/jnumpy/dtype/DType.java`
- [Memory Buffers](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/memory/MemoryBuffer.java): `src/main/java/jnumpy/memory/MemoryBuffer.java`
- [Heap Buffers](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/memory/HeapMemoryBuffer.java): `src/main/java/jnumpy/memory/HeapMemoryBuffer.java`
- [Off-Heap Buffer](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/memory/OffHeapMemoryBuffer.java): `src/main/java/jnumpy/memory/OffHeapMemoryBuffer.java`
- [Typed Access](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/util/Util.java): `src/main/java/jnumpy/util/Util.java`

### Array Operations

- [Universal Functions](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/ufunc/UFunc.java): `src/main/java/jnumpy/ufunc/UFunc.java`
- [Broadcasting](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/broadcast/Broadcast.java): `src/main/java/jnumpy/broadcast/Broadcast.java`
- [Indexing](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/indexing/Indexer.java): `src/main/java/jnumpy/indexing/Indexer.java`
- [Array Manipulation](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/manipulation/Manipulation.java): `src/main/java/jnumpy/manipulation/Manipulation.java`

### Numerical Analysis

- [Linear Algebra](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/linalg/Linalg.java): `src/main/java/jnumpy/linalg/Linalg.java`
- [Statistics](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/statistics/Statistics.java): `src/main/java/jnumpy/statistics/Statistics.java`
- [Search & Sets](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/search/Search.java): `src/main/java/jnumpy/search/Search.java`
- [Sorting](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/sort/Sort.java): `src/main/java/jnumpy/sort/Sort.java`
- [Polynomials](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/polynomial/Polynomial.java): `src/main/java/jnumpy/polynomial/Polynomial.java`

### Generation & I/O

- [Array Creation](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/creation/Creation.java): `src/main/java/jnumpy/creation/Creation.java`
- [Random Sampling](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/random/Random.java): `src/main/java/jnumpy/random/Random.java`
- [Array I/O](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/io/IO.java): `src/main/java/jnumpy/io/IO.java`

### Differentiation

- [Dual Numbers](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Dual.java): `src/main/java/jnumpy/autodiff/Dual.java`
- [Gradient Tape](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Tape.java): `src/main/java/jnumpy/autodiff/Tape.java`
- [Differentiable Var](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Var.java): `src/main/java/jnumpy/autodiff/Var.java`
- [Gradient API](https://github.com/isharak7m/numj/blob/main/src/main/java/jnumpy/autodiff/Grad.java): `src/main/java/jnumpy/autodiff/Grad.java`

### Other components

- **Java Caller**

## Connections

- Java Caller → Arrays Facade: calls (evidence: `README.md`)
- Arrays Facade → Array Creation: delegates creation (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Universal Functions: delegates operations (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Linear Algebra: delegates algebra (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Statistics: delegates statistics (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Array Manipulation: delegates manipulation (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Search & Sets: delegates search (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Sorting: delegates sorting (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Random Sampling: delegates sampling (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Polynomials: delegates fitting (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- Arrays Facade → Array I/O: delegates I/O (evidence: `src/main/java/jnumpy/core/Arrays.java`)
- NDArray → Universal Functions: invokes operations (evidence: `src/main/java/jnumpy/ndarray/NDArray.java`)
- NDArray → Indexing: delegates indexing (evidence: `src/main/java/jnumpy/ndarray/NDArray.java`)
- Universal Functions → Broadcasting: uses iteration (evidence: `src/main/java/jnumpy/ufunc/UFunc.java`)
- Indexing → Broadcasting: broadcasts assignment (evidence: `src/main/java/jnumpy/indexing/Indexer.java`)
- Array Manipulation → Indexing: slices arrays (evidence: `src/main/java/jnumpy/manipulation/Manipulation.java`)
- Search & Sets → Sorting: sorts inputs (evidence: `src/main/java/jnumpy/search/Search.java`)
- Statistics → Sorting: sorts quantiles (evidence: `src/main/java/jnumpy/statistics/Statistics.java`)
- Array Creation → NDArray: constructs arrays (evidence: `src/main/java/jnumpy/creation/Creation.java`)
- Linear Algebra → NDArray: consumes arrays (evidence: `src/main/java/jnumpy/linalg/Linalg.java`)
- Statistics → NDArray: consumes arrays (evidence: `src/main/java/jnumpy/statistics/Statistics.java`)
- Random Sampling → NDArray: produces arrays (evidence: `src/main/java/jnumpy/random/Random.java`)
- Polynomials → NDArray: consumes arrays (evidence: `src/main/java/jnumpy/polynomial/Polynomial.java`)
- Array I/O → NDArray: reads and writes (evidence: `src/main/java/jnumpy/io/IO.java`)
- NDArray → Memory Buffers: stores data in (evidence: `src/main/java/jnumpy/ndarray/NDArray.java`)
- Memory Buffers → Heap Buffers: allocates heap (evidence: `src/main/java/jnumpy/memory/MemoryBuffer.java`)
- Memory Buffers → Off-Heap Buffer: supports off-heap (evidence: `src/main/java/jnumpy/memory/MemoryBuffer.java`)
- NDArray → Data Types: tracks type (evidence: `src/main/java/jnumpy/ndarray/NDArray.java`)
- Universal Functions → Typed Access: reads and writes values (evidence: `src/main/java/jnumpy/ufunc/UFunc.java`)
- Java Caller → Gradient API: requests derivatives (evidence: `README.md`)
- Gradient API → Dual Numbers: evaluates forward mode (evidence: `src/main/java/jnumpy/autodiff/Grad.java`)
- Gradient API → Gradient Tape: uses reverse mode (evidence: `src/main/java/jnumpy/autodiff/Grad.java`)
- Gradient Tape → Differentiable Var: creates variables (evidence: `src/main/java/jnumpy/autodiff/Tape.java`)
- Differentiable Var → Gradient Tape: records operations (evidence: `src/main/java/jnumpy/autodiff/Var.java`)
