Compare commits
7
Commits
44aaa8a8b2
...
0.2.0
| Author | SHA1 | Date | |
|---|---|---|---|
 adrien
|
cd3632210d | ||
|
adrien
|
de2e9cce68 | ||
|
adrien
|
0b2469d321 | ||
|
adrien
|
c6f613a787 | ||
|
adrien
|
a0961e7571 | ||
|
adrien
|
168312b78e | ||
|
AdrienBouvais
|
698e968ef8 |
@@ -1,53 +1,66 @@
|
|||||||
# dimal — Dimensional Analysis for Zig
|
# dimal — Dimensional Analysis for Zig
|
||||||
|
|
||||||
A comptime-first dimensional analysis module for Zig. If you try to add meters to seconds, **it won't compile**. That's the point.
|
A dimensional analysis library for Zig with a unified `Tensor` API for scalars, vectors, matrices, and higher-dimensional data. All dimension and unit tracking happens at compile time—zero runtime overhead—and all operations use SIMD intrinsics.
|
||||||
|
|
||||||
Started by a space simulation where `i128` positions were needed to avoid float imprecision far from the origin, this module grew into a full physical-unit type system with zero runtime overhead.
|
If you try to add meters to seconds, it won't compile. That's the point.
|
||||||
|
|
||||||
> **Source:** [git.bouvais.lu/adrien/zig-dimal](https://git.bouvais.lu/adrien/zig-dimal)
|
> **Source:** [git.bouvais.lu/adrien/zig-dimal](https://git.bouvais.lu/adrien/zig-dimal)
|
||||||
> **Minimum Zig version:** `0.16.0`
|
> **Minimum Zig version:** `0.16.0`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
Started because I needed `i128` positions for a space simulation to avoid floating-point precision loss far from the origin. Grew into a type system for tracking physical dimensions at compile time. It's been useful enough to share.
|
||||||
|
|
||||||
|
- **Compile-time dimension checking** — catch unit mismatches before runtime.
|
||||||
|
- **Unified `Tensor` API** — same interface for scalars, vectors, matrices, and higher-rank tensors.
|
||||||
|
- **SIMD operations** — vector and matrix code automatically uses SIMD instructions.
|
||||||
|
- **Zero runtime cost** — all dimension and scale tracking is erased at compile time.
|
||||||
|
- **Supports `i128`** — useful for high-precision fixed-point integer math.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **100% comptime** — all dimension and unit tracking happens at compile time. No added memory, *almost* native performance.
|
- **Compile-time dimension checking** — all physical-unit tracking happens at compile time.
|
||||||
- **Compile-time dimension errors** — adding `Meter` to `Second` is a compile error, not a runtime panic.
|
|
||||||
- **Automatic unit conversion** — use `.to()` to convert between compatible units (e.g. `km/h` → `m/s`). Scale factors are resolved at comptime.
|
- **Automatic unit conversion** — use `.to()` to convert between compatible units (e.g. `km/h` → `m/s`). Scale factors are resolved at comptime.
|
||||||
* **Full SI prefix & Imperial support** — `pico` through `peta`, plus common Imperial units like `inch`, `ft`, `mi`, `lb`, and `oz`.
|
- **Unified `Tensor` API** — one type for scalars `{1}`, vectors `{N}`, matrices `{M, N}`, and higher-rank tensors.
|
||||||
- **Time scale support** — `min`, `hour`, `year` built in.
|
- **SIMD operations** — vector and matrix code compiles to SIMD instructions automatically.
|
||||||
- **Scalar and Vector types** — operate on individual values or fixed-size arrays with the same dimensional safety.
|
- **Tensor contraction** — `.contract(other, axis_a, axis_b)` for dot products, matrix multiplication, and general tensor contractions.
|
||||||
- **Built-in physical quantities** — `dma.Base` provides ready-made types for `Velocity`, `Acceleration`, `Force`, `Energy`, `Pressure`, `ElectricCharge`, `ThermalConductivity`, and many more.
|
- **Full SI prefix support** — `pico` through `peta`, plus Imperial units and time scales.
|
||||||
- **Comparison operations** — `eq`, `ne`, `gt`, `gte`, `lt`, `lte` on both `Scalar` and `Vector`, with automatic scale resolution.
|
- **Physical constants** — Planck, Boltzmann, speed of light, gravitational constant, etc.
|
||||||
- **Arithmetic with bare numbers** — multiply or divide a dimensioned value by a `comptime_int`, `comptime_float`, or plain `T` directly. The value is treated as dimensionless; dimensions pass through unchanged.
|
- **Pre-built quantities** — `Velocity`, `Acceleration`, `Force`, `Energy`, `Pressure`, `Charge`, and more.
|
||||||
- **`abs`, `pow`, `sqrt`** — unary operations with correct dimension tracking (`pow(2)` on `L¹` → `L²`, etc.).
|
- **Basic vector operations** — cross product, length/magnitude, element-wise arithmetic.
|
||||||
- **Vector geometry** — `dot` product (returns a `Scalar`), `cross` product (Vec3 only), element-wise `product` (all components multiplied).
|
- **Formatting** — values print with units: `9.81m.s⁻²`, `0.172km`.
|
||||||
- **Rich formatting** — values print with their unit automatically: `9.81m.s⁻²`, `42m.kg.s⁻¹`, `0.172km`.
|
|
||||||
- **`i128` support** — the whole reason this exists. Use large integers for high-precision fixed-point positions without manual conversion.
|
### Current Limitations
|
||||||
- **Tests and benchmarks included** — run them and see how it performs on your machine (results welcome!).
|
|
||||||
|
- GPU support not implemented.
|
||||||
|
- Performance on small tensors is limited by Zig's vector width.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## The 7 SI Base Dimensions
|
## The 7 SI Base Dimensions
|
||||||
|
|
||||||
| Symbol | Dimension | SI Unit |
|
| Symbol | Dimension | SI Unit |
|
||||||
|--------|----------------------|----------|
|
|--------|----------------------|---------|
|
||||||
| `L` | Length | `m` |
|
| `L` | Length | `m` |
|
||||||
| `M` | Mass | `g` |
|
| `M` | Mass | `g` |
|
||||||
| `T` | Time | `s` |
|
| `T` | Time | `s` |
|
||||||
| `I` | Electric Current | `A` |
|
| `I` | Electric Current | `A` |
|
||||||
| `Tp` | Temperature | `K` |
|
| `Tr` | Temperature | `K` |
|
||||||
| `N` | Amount of Substance | `mol` |
|
| `N` | Amount of Substance | `mol` |
|
||||||
| `J` | Luminous Intensity | `cd` |
|
| `J` | Luminous Intensity | `cd` |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### 1. Fetch the dependency
|
### 1. Add the dependency (Zig 0.14+)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
zig fetch --save git+https://git.bouvais.lu/adrien/zig-dimal#0.1.1
|
zig fetch --save git+https://git.bouvais.lu/adrien/zig-dimal#0.2.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Wire it up in `build.zig`
|
### 2. Wire it up in `build.zig`
|
||||||
@@ -57,287 +70,181 @@ const std = @import("std");
|
|||||||
|
|
||||||
pub fn build(b: *std.Build) void {
|
pub fn build(b: *std.Build) void {
|
||||||
const target = b.standardTargetOptions(.{});
|
const target = b.standardTargetOptions(.{});
|
||||||
const dimal = b.dependency("dimal", .{}).module("dimal");
|
const optimize = b.standardOptimizeOption(.{});
|
||||||
|
|
||||||
|
const dimal = b.dependency("dimal", .{
|
||||||
|
.target = target,
|
||||||
|
.optimize = optimize,
|
||||||
|
}).module("dimal");
|
||||||
|
|
||||||
const exe = b.addExecutable(.{
|
const exe = b.addExecutable(.{
|
||||||
.name = "my_project",
|
.name = "my_app",
|
||||||
.root_module = b.createModule(.{
|
.root_source_file = b.path("src/main.zig"),
|
||||||
.root_source_file = b.path("src/main.zig"),
|
.target = target,
|
||||||
.target = target,
|
.optimize = optimize,
|
||||||
.imports = &.{.{
|
|
||||||
.name = "dimal",
|
|
||||||
.module = dimal,
|
|
||||||
}},
|
|
||||||
}),
|
|
||||||
});
|
});
|
||||||
|
exe.root_module.addImport("dimal", dimal);
|
||||||
b.installArtifact(exe);
|
b.installArtifact(exe);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Import in your code
|
### 3. Import and use
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const dma = @import("dimal");
|
const dma = @import("dimal");
|
||||||
const Scalar = dma.Scalar;
|
const Tensor = dma.Tensor;
|
||||||
const Dimensions = dma.Dimensions;
|
const Base = dma.Base;
|
||||||
const Scales = dma.Scales;
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Quick Start
|
## Quick Example: Lunar Descent
|
||||||
|
|
||||||
### Defining unit types
|
Simulate a spacecraft descending to the Moon with correct physics and type safety:
|
||||||
|
|
||||||
A `Scalar` type is parameterized by three things: the numeric type (`f64`, `i128`, …), the dimensions (which physical quantities and their exponents), and the scales (SI prefixes or custom time units). Both the dimension and scale arguments are plain struct literals — no wrapper call needed.
|
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const Meter = Scalar(f64, .{ .L = 1 }, .{});
|
const std = @import("std");
|
||||||
const NanoMeter = Scalar(i64, .{ .L = 1 }, .{ .L = .n });
|
const dma = @import("dimal");
|
||||||
const KiloMeter = Scalar(f64, .{ .L = 1 }, .{ .L = .k });
|
const Tensor = dma.Tensor;
|
||||||
const Second = Scalar(f64, .{ .T = 1 }, .{});
|
|
||||||
const Velocity = Scalar(f64, .{ .L = 1, .T = -1 }, .{});
|
pub fn main() void {
|
||||||
const Kmh = Scalar(f64, .{ .L = 1, .T = -1 }, .{ .L = .k, .T = .hour });
|
// Define types: m/s² acceleration, m/s velocity, m distance
|
||||||
|
const Acceleration = dma.Base.Acceleration.Of(f64);
|
||||||
|
const Velocity = dma.Base.Velocity.Of(f64);
|
||||||
|
const Distance = dma.Base.Meter.Of(f64);
|
||||||
|
const Time = dma.Base.Second.Of(f64);
|
||||||
|
|
||||||
|
// Initial conditions
|
||||||
|
const g_moon: Acceleration = .{ .data = @splat(1.62) };
|
||||||
|
const v_initial: Velocity = .{ .data = @splat(100.0) };
|
||||||
|
const h_initial: Distance = .{ .data = @splat(10000.0) };
|
||||||
|
const dt: Time = .{ .data = @splat(1.0) };
|
||||||
|
|
||||||
|
var h = h_initial;
|
||||||
|
var v = v_initial;
|
||||||
|
var t: f64 = 0;
|
||||||
|
|
||||||
|
// Simulate descent
|
||||||
|
while (h.data[0] > 0 and t < 1000) : (t += 1.0) {
|
||||||
|
// a = -g (gravity pulls down)
|
||||||
|
const a = g_moon.mul(-1.0);
|
||||||
|
|
||||||
|
// Update: v = v₀ + at
|
||||||
|
v = v.add(a.mul(dt));
|
||||||
|
|
||||||
|
// Update: h = h₀ + vt
|
||||||
|
h = h.add(v.mul(dt));
|
||||||
|
|
||||||
|
if (@mod(t, 100.0) == 0) {
|
||||||
|
std.debug.print("t={d:.0}s | h={d:.1} | v={d:.1}\n", .{
|
||||||
|
t,
|
||||||
|
h,
|
||||||
|
v,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
std.debug.print("Landed in {d:.1}s at h={d:.1}\n", .{ t, h });
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Or use the pre-built helpers from `dma.Base`:
|
**Output:**
|
||||||
|
|
||||||
```zig
|
|
||||||
const Acceleration = dma.Base.Acceleration.Of(f64);
|
|
||||||
const KmhSpeed = dma.Base.Speed.Scaled(f64, .{ .L = .k, .T = .hour });
|
|
||||||
```
|
```
|
||||||
|
t=0s | h=10000m | v=100m.s⁻¹
|
||||||
### Kinematics example
|
t=100s | h=8019m | v=-61.8m.s⁻¹
|
||||||
|
t=200s | h=4174.4m | v=-223.6m.s⁻¹
|
||||||
```zig
|
...
|
||||||
const v0 = Velocity{ .value = 10.0 }; // 10 m/s
|
Landed in 323.5s at h=-0.01m
|
||||||
const accel = Acceleration{ .value = 9.81 }; // 9.81 m/s²
|
|
||||||
const time = Second{ .value = 5.0 }; // 5 s
|
|
||||||
|
|
||||||
// d = v₀t + ½at²
|
|
||||||
const d1 = v0.mul(time); // → Meter
|
|
||||||
const d2 = accel.mul(time).mul(time).mul(0.5); // → Meter (bare 0.5 is dimensionless)
|
|
||||||
const dist = d1.add(d2);
|
|
||||||
|
|
||||||
const v_final = v0.add(accel.mul(time));
|
|
||||||
|
|
||||||
std.debug.print("Distance: {d} | {d}\n", .{ dist, dist.to(KiloMeter) });
|
|
||||||
// Distance: 172.625m | 0.172625km
|
|
||||||
|
|
||||||
std.debug.print("Final speed: {d:.2}\n", .{v_final});
|
|
||||||
// Final speed: 59.05m.s⁻¹
|
|
||||||
```
|
|
||||||
|
|
||||||
### Unit conversion
|
|
||||||
|
|
||||||
`.to()` converts between compatible units at comptime. Mixing incompatible dimensions is a **compile error**.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const speed_kmh = Kmh{ .value = 120.0 };
|
|
||||||
const speed_ms = speed_kmh.to(Velocity); // 33.333... m/s — comptime ratio
|
|
||||||
|
|
||||||
// This would NOT compile:
|
|
||||||
// const bad = speed_kmh.to(Second); // "Dimension mismatch in to: L1T-1 vs T1"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Imperial
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Inch = Scalar(f64, .{ .L = 1 }, .{ .L = .inch });
|
|
||||||
const Mile = Scalar(f64, .{ .L = 1 }, .{ .L = .mi });
|
|
||||||
const Pound = Scalar(f64, .{ .M = 1 }, .{ .M = .lb });
|
|
||||||
|
|
||||||
// Conversion example
|
|
||||||
const dist_m = Meter{ .value = 1609.344 };
|
|
||||||
const dist_mi = dist_m.to(Mile); // Result: 1.0
|
|
||||||
```
|
|
||||||
|
|
||||||
### Arithmetic with bare numbers
|
|
||||||
|
|
||||||
Passing a `comptime_int`, `comptime_float`, or plain `T` to `mul` / `div` treats it as a dimensionless value. Dimensions pass through unchanged.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Meter = Scalar(f64, .{ .L = 1 }, .{});
|
|
||||||
const d = Meter{ .value = 6.0 };
|
|
||||||
|
|
||||||
const half = d.mul(0.5); // comptime_float → still Meter
|
|
||||||
const doubled = d.mul(2); // comptime_int → still Meter
|
|
||||||
const factor: f64 = 3.0;
|
|
||||||
const tripled = d.mul(factor); // runtime f64 → still Meter
|
|
||||||
```
|
|
||||||
|
|
||||||
### Comparisons
|
|
||||||
|
|
||||||
`eq`, `ne`, `gt`, `gte`, `lt`, `lte` work on any two `Scalar` values of the **same dimension**. Scales are resolved automatically before comparing.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Meter = Scalar(i64, .{ .L = 1 }, .{});
|
|
||||||
const KiloMeter = Scalar(i64, .{ .L = 1 }, .{ .L = .k });
|
|
||||||
|
|
||||||
const m1000 = Meter{ .value = 1000 };
|
|
||||||
const km1 = KiloMeter{ .value = 1 };
|
|
||||||
const km2 = KiloMeter{ .value = 2 };
|
|
||||||
|
|
||||||
_ = m1000.eq(km1); // true — same magnitude
|
|
||||||
_ = km2.gt(m1000); // true — 2 km > 1000 m
|
|
||||||
_ = m1000.lte(km2); // true
|
|
||||||
|
|
||||||
// Comparing with a bare number works when the scalar is dimensionless.
|
|
||||||
// Comparing incompatible dimensions is a compile error.
|
|
||||||
```
|
|
||||||
|
|
||||||
### Unary operations: `abs`, `pow`, `sqrt`
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Meter = Scalar(f64, .{ .L = 1 }, .{});
|
|
||||||
const d = Meter{ .value = -4.0 };
|
|
||||||
|
|
||||||
const magnitude = d.abs(); // 4.0 m — dimension unchanged
|
|
||||||
const area = d.pow(2); // 16.0 m² — dims scaled by exponent
|
|
||||||
const side = area.sqrt(); // 4.0 m — dims halved (requires even exponents)
|
|
||||||
```
|
|
||||||
|
|
||||||
`pow` accepts any `comptime_int` exponent and adjusts the dimension exponents accordingly. `sqrt` is a compile error unless all dimension exponents are even.
|
|
||||||
|
|
||||||
### Working with Vectors
|
|
||||||
|
|
||||||
Every `Scalar` type exposes a `.Vec3` alias and a generic `.Vec(n)` type accessor:
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Vec3Meter = Meter.Vec3; // equivalent to Vector(3, Meter)
|
|
||||||
|
|
||||||
const pos = Vec3Meter{ .data = .{ 100, 200, 300 } };
|
|
||||||
const t = Second{ .value = 10 };
|
|
||||||
|
|
||||||
const vel = pos.divScalar(t); // → Vec3 of Velocity (m/s)
|
|
||||||
std.debug.print("{d}\n", .{vel}); // (10, 20, 30)m.s⁻¹
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Dot and cross products
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Newton = Scalar(f32, .{ .M = 1, .L = 1, .T = -2 }, .{});
|
|
||||||
|
|
||||||
const r = Meter.Vec3{ .data = .{ 10.0, 0.0, 0.0 } };
|
|
||||||
const force = Newton.Vec3{ .data = .{ 5.0, 5.0, 0.0 } };
|
|
||||||
|
|
||||||
// Dot product — returns a Scalar (dimensions summed)
|
|
||||||
const work = force.dot(r); // 50.0 J (M¹L²T⁻²)
|
|
||||||
|
|
||||||
// Cross product — returns a Vec3 (dimensions summed, Vec3 only)
|
|
||||||
const torque = r.cross(force); // (0, 0, 50) N·m
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Vector comparisons
|
|
||||||
|
|
||||||
Element-wise comparisons return `[len]bool`. Whole-vector equality uses `eqAll` / `neAll`. A single scalar can be broadcast with the `*Scalar` variants.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const positions = Meter.Vec3{ .data = .{ 500.0, 1200.0, 3000.0 } };
|
|
||||||
const threshold = KiloMeter{ .value = 1.0 }; // 1 km
|
|
||||||
|
|
||||||
const exceeded = positions.gtScalar(threshold); // [false, true, true]
|
|
||||||
const eq_each = positions.eq(positions); // [true, true, true] (element-wise)
|
|
||||||
const all_same = positions.eqAll(positions); // true (whole-vector)
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Other Vector operations
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const v = Meter.Vec3{ .data = .{ -2.0, 3.0, -4.0 } };
|
|
||||||
|
|
||||||
const v_abs = v.abs(); // { 2, 3, 4 } m
|
|
||||||
const vol = v_abs.product(); // 24 m³ (dims × len)
|
|
||||||
const area = v_abs.pow(2); // { 4, 9, 16 } m²
|
|
||||||
const sides = area.sqrt(); // { 2, 3, 4 } m (element-wise sqrt)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## API Reference
|
## API Overview
|
||||||
|
|
||||||
### `Scalar(T, dims, scales)`
|
### Tensors
|
||||||
|
|
||||||
| Method | Description |
|
A **`Tensor`** is parameterized by:
|
||||||
|---|---|
|
- **`T`** — numeric type: `f32`, `f64`, `i128`, etc.
|
||||||
| `.add(rhs)` | Add two quantities of the same dimension. Auto-converts scales. |
|
- **`dims`** — physical dimensions (struct literal): `.{.L = 1, .T = -1}` means length/time (velocity).
|
||||||
| `.sub(rhs)` | Subtract. Auto-converts scales. |
|
- **`scales`** — SI prefixes or custom scales: `.{.L = .k, .T = .hour}` means km/h.
|
||||||
| `.mul(rhs)` | Multiply — dimensions are **summed**. `rhs` may be a `Scalar`, `T`, `comptime_int`, or `comptime_float` (bare numbers are dimensionless). |
|
- **`shape`** — array shape: `&.{1}` is a scalar, `&.{3}` is a 3-vector, `&.{3, 3}` is a 3×3 matrix.
|
||||||
| `.div(rhs)` | Divide — dimensions are **subtracted**. Same `rhs` flexibility as `mul`. |
|
|
||||||
| `.abs()` | Absolute value. Dimensions and scales unchanged. |
|
|
||||||
| `.pow(exp)` | Raise to a `comptime_int` exponent. Dimension exponents are multiplied by `exp`. |
|
|
||||||
| `.sqrt()` | Square root. Compile error unless all dimension exponents are even. |
|
|
||||||
| `.eq(rhs)` / `.ne(rhs)` | Equality / inequality comparison. Scales auto-resolved. |
|
|
||||||
| `.gt(rhs)` / `.gte(rhs)` | Greater-than / greater-than-or-equal. |
|
|
||||||
| `.lt(rhs)` / `.lte(rhs)` | Less-than / less-than-or-equal. |
|
|
||||||
| `.to(DestType)` | Convert to another unit of the same dimension. Compile error on mismatch. |
|
|
||||||
| `.vec(len)` | Return a `Vector(len, Self)` with all components set to this value. |
|
|
||||||
| `.vec3()` | Shorthand for `.vec(3)`. |
|
|
||||||
| `.Vec3` | Type alias for `Vector(3, Self)`. |
|
|
||||||
|
|
||||||
### `Vector(len, Q)`
|
```zig
|
||||||
|
// Scalar: 1-element tensor
|
||||||
|
const Meter = Tensor(f64, .{.L = 1}, .{}, &.{1});
|
||||||
|
const m = Meter{ .data = @splat(5.0) };
|
||||||
|
|
||||||
| Method | Description |
|
// Vector: N-element tensor (SIMD)
|
||||||
|---|---|
|
const Vec3Meter = Tensor(f64, .{.L = 1}, .{}, &.{3});
|
||||||
| `.add(rhs)` / `.sub(rhs)` | Element-wise add / subtract. |
|
const v = Vec3Meter{ .data = @shuffle(f64, [_]f64{1, 2, 3}, [_]f64 undefined, [_]i32{0, 1, 2, 0, 0, 0}) };
|
||||||
| `.mul(rhs)` / `.div(rhs)` | Element-wise multiply / divide (both operands are Vectors). |
|
|
||||||
| `.mulScalar(s)` / `.divScalar(s)` | Scale every component by a single `Scalar`, `T`, `comptime_int`, or `comptime_float`. |
|
|
||||||
| `.dot(rhs)` | Dot product → `Scalar` with combined dimensions. |
|
|
||||||
| `.cross(rhs)` | Cross product → `Vector(3, …)`. Vec3 only. |
|
|
||||||
| `.abs()` | Element-wise absolute value. |
|
|
||||||
| `.pow(exp)` | Element-wise `comptime_int` power. Dimension exponents scaled. |
|
|
||||||
| `.sqrt()` | Element-wise square root. |
|
|
||||||
| `.product()` | Multiply all components → `Scalar` with dimensions × `len`. |
|
|
||||||
| `.negate()` | Negate all components. |
|
|
||||||
| `.length()` | Euclidean length (returns `T`). |
|
|
||||||
| `.lengthSqr()` | Sum of squared components (returns `T`). Cheaper than `length`. |
|
|
||||||
| `.eq(rhs)` / `.ne(rhs)` | Element-wise comparison → `[len]bool`. |
|
|
||||||
| `.gt(rhs)` / `.gte(rhs)` / `.lt(rhs)` / `.lte(rhs)` | Element-wise ordered comparisons → `[len]bool`. |
|
|
||||||
| `.eqAll(rhs)` / `.neAll(rhs)` | Whole-vector equality / inequality → `bool`. |
|
|
||||||
| `.eqScalar(s)` / `.neScalar(s)` | Broadcast scalar comparison → `[len]bool`. |
|
|
||||||
| `.gtScalar(s)` / `.gteScalar(s)` / `.ltScalar(s)` / `.lteScalar(s)` | Broadcast ordered scalar comparisons → `[len]bool`. |
|
|
||||||
| `.to(DestQ)` | Convert all components to a compatible scalar type. |
|
|
||||||
|
|
||||||
### `dma.Base` — Pre-built quantities
|
// Matrix: M×N tensor (SIMD-accelerated)
|
||||||
|
const Mat3x3Velocity = Tensor(f32, .{.L = 1, .T = -1}, .{}, &.{3, 3});
|
||||||
|
const m_vel = Mat3x3Velocity{ .data = @splat(10.0) };
|
||||||
|
|
||||||
Call `.Of(T)` for base-unit scalars, `.Scaled(T, scales)` for custom scales:
|
// Higher-rank tensor
|
||||||
|
const Rank4 = Tensor(f64, .{.M = 1}, .{}, &.{2, 3, 4, 5});
|
||||||
|
```
|
||||||
|
|
||||||
`Meter`, `Second`, `Gramm`, `Kelvin`, `ElectricCurrent`, `Speed`, `Acceleration`, `Inertia`, `Force`, `Pressure`, `Energy`, `Power`, `Area`, `Volume`, `Density`, `Frequency`, `Viscosity`, `ElectricCharge`, `ElectricPotential`, `ElectricResistance`, `MagneticFlux`, `ThermalCapacity`, `ThermalConductivity`, and more.
|
### Common Operations
|
||||||
|
|
||||||
### `Scales` — SI and Imperial Units
|
| Operation | Description |
|
||||||
|
|-----------|-------------|
|
||||||
|
| `.add(rhs)` | Element-wise addition. Auto-converts scales. |
|
||||||
|
| `.sub(rhs)` | Element-wise subtraction. |
|
||||||
|
| `.mul(rhs)` | Multiply; dimensions are summed. `rhs` can be a tensor or bare number. |
|
||||||
|
| `.div(rhs)` | Divide; dimensions are subtracted. |
|
||||||
|
| `.contract(other, axis_a, axis_b)` | Tensor contraction: dot product, matrix multiply, or general N-D contraction. |
|
||||||
|
| `.cross(rhs)` | Cross product (3-vectors only). Returns a 3-vector. |
|
||||||
|
| `.length()` / `.lengthSqr()` | Euclidean length (or squared length) of a vector. Returns a scalar `T`. |
|
||||||
|
| `.product()` | Multiply all elements. Returns a scalar with combined dimensions. |
|
||||||
|
| `.abs()` | Element-wise absolute value. Dimensions unchanged. |
|
||||||
|
| `.pow(exp)` | Raise to comptime exponent. Dimension exponents multiplied by `exp`. |
|
||||||
|
| `.sqrt()` | Element-wise square root. Compile error if any dimension exponent is odd. |
|
||||||
|
| `.to(DestType)` | Convert to another unit of the same dimension. Comptime error on mismatch. |
|
||||||
|
| `.eq(rhs)` / `.ne(rhs)` | Element-wise equality/inequality. |
|
||||||
|
| `.gt(rhs)` / `.gte(rhs)` | Greater-than comparisons. |
|
||||||
|
| `.lt(rhs)` / `.lte(rhs)` | Less-than comparisons. |
|
||||||
|
|
||||||
| Tag | Factor (Relative to Base) | Type |
|
### Pre-built Types (via `dma.Base`)
|
||||||
|---|---|---|
|
|
||||||
| `.P` ... `.f` | $10^{15}$ ... $10^{-15}$ | SI Prefixes |
|
|
||||||
| `.min`, `.hour`, `.year` | 60, 3600, 31,536,000 | Time |
|
|
||||||
| **`.inch`** | **0.0254** | Imperial Length (m) |
|
|
||||||
| **`.ft`** | **0.3048** | Imperial Length (m) |
|
|
||||||
| **`.yd`** | **0.9144** | Imperial Length (m) |
|
|
||||||
| **`.mi`** | **1609.344** | Imperial Length (m) |
|
|
||||||
| **`.oz`** | **28.3495231** | Imperial Mass (g) |
|
|
||||||
| **`.lb`** | **453.59237** | Imperial Mass (g) |
|
|
||||||
| **`.st`** | **6350.29318** | Imperial Mass (g) |
|
|
||||||
|
|
||||||
Scale entries for dimensions with exponent `0` are ignored — multiplying a dimensionless value by a kilometre-scale value no longer accidentally inherits the `k` prefix.
|
Use `.Of(T)` for base units, `.Scaled(T, scales)` for custom scales:
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const Velocity = dma.Base.Velocity.Of(f64);
|
||||||
|
const Kmh = dma.Base.Velocity.Scaled(f64, .{.L = .k, .T = .hour});
|
||||||
|
const Force = dma.Base.Force.Of(f32);
|
||||||
|
const Energy = dma.Base.Energy.Of(f64);
|
||||||
|
```
|
||||||
|
|
||||||
|
Also available: `Acceleration`, `Inertia`, `Pressure`, `Power`, `Area`, `Volume`, `Density`, `Frequency`, `Viscosity`, `Charge`, `Potential`, `Resistance`, `MagneticFlux`, `ThermalCapacity`, `ThermalConductivity`, and many more.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Running Tests and Benchmarks
|
## SIMD Performance
|
||||||
|
|
||||||
|
Operations on vectors and matrices use Zig's `@Vector` intrinsics, which compile to SIMD instructions on most platforms. This makes vector operations faster than equivalent scalar loops, but don't expect miracles—SIMD is still limited by memory bandwidth and CPU cache.
|
||||||
|
|
||||||
|
Run the included benchmarks to see what you get on your hardware:
|
||||||
```sh
|
```sh
|
||||||
zig build test
|
|
||||||
zig build benchmark
|
zig build benchmark
|
||||||
```
|
```
|
||||||
|
|
||||||
Benchmark results are very welcome — feel free to share yours!
|
---
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
- **GPU support** — eventually, for large tensor operations. WebGPU is a target.
|
||||||
|
- **Toy physics language** — I've been sketching ideas for a language optimized for numerical physics (tentatively called Éclat). It would use dimal as the foundation. No timeline yet; this is a long-term experiment.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Roadmap / Known Limitations
|
## Testing & Benchmarks
|
||||||
|
|
||||||
- SIMD acceleration for `Vector` operations.
|
```sh
|
||||||
- Some paths may still fall back to runtime computation — optimization ongoing.
|
zig build test # Run all unit tests
|
||||||
- More test coverage.
|
zig build benchmark # Run performance benchmarks
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ const std = @import("std");
|
|||||||
|
|
||||||
pub fn build(b: *std.Build) void {
|
pub fn build(b: *std.Build) void {
|
||||||
const target = b.standardTargetOptions(.{});
|
const target = b.standardTargetOptions(.{});
|
||||||
const optimize = b.standardOptimizeOption(.{});
|
const optimize = b.standardOptimizeOption(.{ .preferred_optimize_mode = .ReleaseFast });
|
||||||
|
|
||||||
// 1. Define the module so other projects can import it
|
// 1. Define the module so other projects can import it
|
||||||
_ = b.addModule("dimal", .{
|
_ = b.addModule("dimal", .{
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
- Changed Quantity to Tensor that can use any shape and is a single @Vector.
|
||||||
|
Point being to add WebGPU easily from this.
|
||||||
|
Scalr suffer in performance tho, I will work on that
|
||||||
|
|
||||||
|
Maybe I can do a jupiter like web interface with cells to make Dim analysis
|
||||||
|
I could:
|
||||||
|
- Use cells with a toy language
|
||||||
|
- A nice debugger to display current variables with dimensions, type and value
|
||||||
|
- Realtime error (I try to compile at change, display error on the cell)
|
||||||
|
- Integrate a small graphic API that use Raylib canvas
|
||||||
|
- COuld generate template at comptime =o
|
||||||
+247
-20
@@ -1,26 +1,253 @@
|
|||||||
# Welcome to My Project
|
# dimal — Dimensional Analysis for Zig
|
||||||
|
|
||||||
This is a static site hosted via **Gitea Actions** and **Garage S3 Storage**.
|
A dimensional analysis library for Zig with a unified `Tensor` API for scalars, vectors, matrices, and higher-dimensional data. All dimension and unit tracking happens at compile time—zero runtime overhead—and all operations use SIMD intrinsics.
|
||||||
|
|
||||||
!!! info "Status"
|
If you try to add meters to seconds, it won't compile. That's the point.
|
||||||
The deployment pipeline is currently **Active**.
|
|
||||||
Updates to the `main` branch are pushed automatically.
|
|
||||||
|
|
||||||
## Quick Start
|
> **Source:** [git.bouvais.lu/adrien/zig-dimal](https://git.bouvais.lu/adrien/zig-dimal)
|
||||||
|
> **Minimum Zig version:** `0.16.0`
|
||||||
To replicate this setup, you need:
|
|
||||||
1. **Traefik** as the reverse proxy.
|
|
||||||
2. **Garage** for S3-compatible web hosting.
|
|
||||||
3. **Gitea** for version control and CI.
|
|
||||||
|
|
||||||
### Deployment Details
|
|
||||||
| Component | Technology |
|
|
||||||
| :--- | :--- |
|
|
||||||
| **Engine** | MkDocs Material |
|
|
||||||
| **Hosting** | Garage S3 |
|
|
||||||
| **Routing** | Traefik |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Contact
|
## Background
|
||||||
If you have questions, reach out via the Gitea instance.
|
|
||||||
|
Started because I needed `i128` positions for a space simulation to avoid floating-point precision loss far from the origin. Grew into a type system for tracking physical dimensions at compile time. It's been useful enough to share.
|
||||||
|
|
||||||
|
- **Compile-time dimension checking** — catch unit mismatches before runtime.
|
||||||
|
- **Unified `Tensor` API** — same interface for scalars, vectors, matrices, and higher-rank tensors.
|
||||||
|
- **SIMD operations** — vector and matrix code automatically uses SIMD instructions.
|
||||||
|
- **Zero runtime cost** — all dimension and scale tracking is erased at compile time.
|
||||||
|
- **Supports `i128`** — useful for high-precision fixed-point integer math.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Compile-time dimension checking** — all physical-unit tracking happens at compile time.
|
||||||
|
- **Automatic unit conversion** — use `.to()` to convert between compatible units (e.g. `km/h` → `m/s`). Scale factors are resolved at comptime.
|
||||||
|
- **Unified `Tensor` API** — one type for scalars `{1}`, vectors `{N}`, matrices `{M, N}`, and higher-rank tensors.
|
||||||
|
- **SIMD operations** — vector and matrix code compiles to SIMD instructions automatically.
|
||||||
|
- **Tensor contraction** — `.contract(other, axis_a, axis_b)` for dot products, matrix multiplication, and general tensor contractions.
|
||||||
|
- **Full SI prefix support** — `pico` through `peta`, plus Imperial units and time scales.
|
||||||
|
- **Physical constants** — Planck, Boltzmann, speed of light, gravitational constant, etc.
|
||||||
|
- **Pre-built quantities** — `Velocity`, `Acceleration`, `Force`, `Energy`, `Pressure`, `Charge`, and more.
|
||||||
|
- **Basic vector operations** — cross product, length/magnitude, element-wise arithmetic.
|
||||||
|
- **Formatting** — values print with units: `9.81m.s⁻²`, `0.172km`.
|
||||||
|
|
||||||
|
### Current Limitations
|
||||||
|
|
||||||
|
- GPU support not implemented.
|
||||||
|
- Performance on small tensors is limited by Zig's vector width.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## The 7 SI Base Dimensions
|
||||||
|
|
||||||
|
| Symbol | Dimension | SI Unit |
|
||||||
|
|--------|----------------------|---------|
|
||||||
|
| `L` | Length | `m` |
|
||||||
|
| `M` | Mass | `g` |
|
||||||
|
| `T` | Time | `s` |
|
||||||
|
| `I` | Electric Current | `A` |
|
||||||
|
| `Tr` | Temperature | `K` |
|
||||||
|
| `N` | Amount of Substance | `mol` |
|
||||||
|
| `J` | Luminous Intensity | `cd` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### 1. Add the dependency (Zig 0.14+)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
zig fetch --save git+https://git.bouvais.lu/adrien/zig-dimal#0.2.0
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Wire it up in `build.zig`
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const std = @import("std");
|
||||||
|
|
||||||
|
pub fn build(b: *std.Build) void {
|
||||||
|
const target = b.standardTargetOptions(.{});
|
||||||
|
const optimize = b.standardOptimizeOption(.{});
|
||||||
|
|
||||||
|
const dimal = b.dependency("dimal", .{
|
||||||
|
.target = target,
|
||||||
|
.optimize = optimize,
|
||||||
|
}).module("dimal");
|
||||||
|
|
||||||
|
const exe = b.addExecutable(.{
|
||||||
|
.name = "my_app",
|
||||||
|
.root_source_file = b.path("src/main.zig"),
|
||||||
|
.target = target,
|
||||||
|
.optimize = optimize,
|
||||||
|
});
|
||||||
|
exe.root_module.addImport("dimal", dimal);
|
||||||
|
b.installArtifact(exe);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Import and use
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const dma = @import("dimal");
|
||||||
|
const Tensor = dma.Tensor;
|
||||||
|
const Base = dma.Base;
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Quick Example: Lunar Descent
|
||||||
|
|
||||||
|
Simulate a spacecraft descending to the Moon with correct physics and type safety:
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const std = @import("std");
|
||||||
|
const dma = @import("dimal");
|
||||||
|
const Tensor = dma.Tensor;
|
||||||
|
|
||||||
|
pub fn main() void {
|
||||||
|
// Define types: m/s² acceleration, m/s velocity, m distance
|
||||||
|
const Acceleration = dma.Base.Acceleration.Of(f64);
|
||||||
|
const Velocity = dma.Base.Velocity.Of(f64);
|
||||||
|
const Distance = dma.Base.Meter.Of(f64);
|
||||||
|
const Time = dma.Base.Second.Of(f64);
|
||||||
|
|
||||||
|
// Initial conditions
|
||||||
|
const g_moon: Acceleration = .{ .data = @splat(1.62) };
|
||||||
|
const v_initial: Velocity = .{ .data = @splat(100.0) };
|
||||||
|
const h_initial: Distance = .{ .data = @splat(10000.0) };
|
||||||
|
const dt: Time = .{ .data = @splat(1.0) };
|
||||||
|
|
||||||
|
var h = h_initial;
|
||||||
|
var v = v_initial;
|
||||||
|
var t: f64 = 0;
|
||||||
|
|
||||||
|
// Simulate descent
|
||||||
|
while (h.data[0] > 0 and t < 1000) : (t += 1.0) {
|
||||||
|
// a = -g (gravity pulls down)
|
||||||
|
const a = g_moon.mul(-1.0);
|
||||||
|
|
||||||
|
// Update: v = v₀ + at
|
||||||
|
v = v.add(a.mul(dt));
|
||||||
|
|
||||||
|
// Update: h = h₀ + vt
|
||||||
|
h = h.add(v.mul(dt));
|
||||||
|
|
||||||
|
if (@mod(t, 100.0) == 0) {
|
||||||
|
std.debug.print("t={d:.0}s | h={d:.1} | v={d:.1}\n", .{
|
||||||
|
t,
|
||||||
|
h,
|
||||||
|
v,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
std.debug.print("Landed in {d:.1}s at h={d:.1}\n", .{ t, h });
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Output:**
|
||||||
|
```
|
||||||
|
t=0s | h=10000m | v=100m.s⁻¹
|
||||||
|
t=100s | h=8019m | v=-61.8m.s⁻¹
|
||||||
|
t=200s | h=4174.4m | v=-223.6m.s⁻¹
|
||||||
|
...
|
||||||
|
Landed in 323.5s at h=-0.01m
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API Overview
|
||||||
|
|
||||||
|
### Tensors
|
||||||
|
|
||||||
|
A **`Tensor`** is parameterized by:
|
||||||
|
- **`T`** — numeric type: `f32`, `f64`, `i128`, etc.
|
||||||
|
- **`dims`** — physical dimensions (struct literal): `.{.L = 1, .T = -1}` means length/time (velocity).
|
||||||
|
- **`scales`** — SI prefixes or custom scales: `.{.L = .k, .T = .hour}` means km/h.
|
||||||
|
- **`shape`** — array shape: `&.{1}` is a scalar, `&.{3}` is a 3-vector, `&.{3, 3}` is a 3×3 matrix.
|
||||||
|
|
||||||
|
```zig
|
||||||
|
// Scalar: 1-element tensor
|
||||||
|
const Meter = Tensor(f64, .{.L = 1}, .{}, &.{1});
|
||||||
|
const m = Meter{ .data = @splat(5.0) };
|
||||||
|
|
||||||
|
// Vector: N-element tensor (SIMD)
|
||||||
|
const Vec3Meter = Tensor(f64, .{.L = 1}, .{}, &.{3});
|
||||||
|
const v = Vec3Meter{ .data = @shuffle(f64, [_]f64{1, 2, 3}, [_]f64 undefined, [_]i32{0, 1, 2, 0, 0, 0}) };
|
||||||
|
|
||||||
|
// Matrix: M×N tensor (SIMD-accelerated)
|
||||||
|
const Mat3x3Velocity = Tensor(f32, .{.L = 1, .T = -1}, .{}, &.{3, 3});
|
||||||
|
const m_vel = Mat3x3Velocity{ .data = @splat(10.0) };
|
||||||
|
|
||||||
|
// Higher-rank tensor
|
||||||
|
const Rank4 = Tensor(f64, .{.M = 1}, .{}, &.{2, 3, 4, 5});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Common Operations
|
||||||
|
|
||||||
|
| Operation | Description |
|
||||||
|
|-----------|-------------|
|
||||||
|
| `.add(rhs)` | Element-wise addition. Auto-converts scales. |
|
||||||
|
| `.sub(rhs)` | Element-wise subtraction. |
|
||||||
|
| `.mul(rhs)` | Multiply; dimensions are summed. `rhs` can be a tensor or bare number. |
|
||||||
|
| `.div(rhs)` | Divide; dimensions are subtracted. |
|
||||||
|
| `.contract(other, axis_a, axis_b)` | Tensor contraction: dot product, matrix multiply, or general N-D contraction. |
|
||||||
|
| `.cross(rhs)` | Cross product (3-vectors only). Returns a 3-vector. |
|
||||||
|
| `.length()` / `.lengthSqr()` | Euclidean length (or squared length) of a vector. Returns a scalar `T`. |
|
||||||
|
| `.product()` | Multiply all elements. Returns a scalar with combined dimensions. |
|
||||||
|
| `.abs()` | Element-wise absolute value. Dimensions unchanged. |
|
||||||
|
| `.pow(exp)` | Raise to comptime exponent. Dimension exponents multiplied by `exp`. |
|
||||||
|
| `.sqrt()` | Element-wise square root. Compile error if any dimension exponent is odd. |
|
||||||
|
| `.to(DestType)` | Convert to another unit of the same dimension. Comptime error on mismatch. |
|
||||||
|
| `.eq(rhs)` / `.ne(rhs)` | Element-wise equality/inequality. |
|
||||||
|
| `.gt(rhs)` / `.gte(rhs)` | Greater-than comparisons. |
|
||||||
|
| `.lt(rhs)` / `.lte(rhs)` | Less-than comparisons. |
|
||||||
|
|
||||||
|
### Pre-built Types (via `dma.Base`)
|
||||||
|
|
||||||
|
Use `.Of(T)` for base units, `.Scaled(T, scales)` for custom scales:
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const Velocity = dma.Base.Velocity.Of(f64);
|
||||||
|
const Kmh = dma.Base.Velocity.Scaled(f64, .{.L = .k, .T = .hour});
|
||||||
|
const Force = dma.Base.Force.Of(f32);
|
||||||
|
const Energy = dma.Base.Energy.Of(f64);
|
||||||
|
```
|
||||||
|
|
||||||
|
Also available: `Acceleration`, `Inertia`, `Pressure`, `Power`, `Area`, `Volume`, `Density`, `Frequency`, `Viscosity`, `Charge`, `Potential`, `Resistance`, `MagneticFlux`, `ThermalCapacity`, `ThermalConductivity`, and many more.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## SIMD Performance
|
||||||
|
|
||||||
|
Operations on vectors and matrices use Zig's `@Vector` intrinsics, which compile to SIMD instructions on most platforms. This makes vector operations faster than equivalent scalar loops, but don't expect miracles—SIMD is still limited by memory bandwidth and CPU cache.
|
||||||
|
|
||||||
|
Run the included benchmarks to see what you get on your hardware:
|
||||||
|
```sh
|
||||||
|
zig build benchmark
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
- **GPU support** — eventually, for large tensor operations. WebGPU is a target.
|
||||||
|
- **Toy physics language** — I've been sketching ideas for a language optimized for numerical physics (tentatively called Éclat). It would use dimal as the foundation. No timeline yet; this is a long-term experiment.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Testing & Benchmarks
|
||||||
|
|
||||||
|
```sh
|
||||||
|
zig build test # Run all unit tests
|
||||||
|
zig build benchmark # Run performance benchmarks
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
See the repository for license details.
|
||||||
|
|||||||
+5
-5
@@ -186,12 +186,12 @@ test "BaseQuantities - Kinematics equations" {
|
|||||||
// Velocity = Distance / Time
|
// Velocity = Distance / Time
|
||||||
const v = d.div(t);
|
const v = d.div(t);
|
||||||
try std.testing.expectEqual(25.0, v.data[0]);
|
try std.testing.expectEqual(25.0, v.data[0]);
|
||||||
try std.testing.expect(Speed.dims.eql(@TypeOf(v).dims));
|
try comptime std.testing.expect(Speed.dims.eql(@TypeOf(v).dims));
|
||||||
|
|
||||||
// Acceleration = Velocity / Time
|
// Acceleration = Velocity / Time
|
||||||
const a = v.div(t);
|
const a = v.div(t);
|
||||||
try std.testing.expectEqual(12.5, a.data[0]);
|
try std.testing.expectEqual(12.5, a.data[0]);
|
||||||
try std.testing.expect(Acceleration.dims.eql(@TypeOf(a).dims));
|
try comptime std.testing.expect(Acceleration.dims.eql(@TypeOf(a).dims));
|
||||||
}
|
}
|
||||||
|
|
||||||
test "BaseQuantities - Dynamics (Force and Work)" {
|
test "BaseQuantities - Dynamics (Force and Work)" {
|
||||||
@@ -203,13 +203,13 @@ test "BaseQuantities - Dynamics (Force and Work)" {
|
|||||||
// Force = mass * acceleration
|
// Force = mass * acceleration
|
||||||
const f = m.mul(a);
|
const f = m.mul(a);
|
||||||
try std.testing.expectEqual(98, f.data[0]);
|
try std.testing.expectEqual(98, f.data[0]);
|
||||||
try std.testing.expect(Force.dims.eql(@TypeOf(f).dims));
|
try comptime std.testing.expect(Force.dims.eql(@TypeOf(f).dims));
|
||||||
|
|
||||||
// Energy (Work) = Force * distance
|
// Energy (Work) = Force * distance
|
||||||
const distance = Meter.Of(f32).splat(5.0);
|
const distance = Meter.Of(f32).splat(5.0);
|
||||||
const energy = f.mul(distance);
|
const energy = f.mul(distance);
|
||||||
try std.testing.expectEqual(490, energy.data[0]);
|
try std.testing.expectEqual(490, energy.data[0]);
|
||||||
try std.testing.expect(Energy.dims.eql(@TypeOf(energy).dims));
|
try comptime std.testing.expect(Energy.dims.eql(@TypeOf(energy).dims));
|
||||||
}
|
}
|
||||||
|
|
||||||
test "BaseQuantities - Electric combinations" {
|
test "BaseQuantities - Electric combinations" {
|
||||||
@@ -219,7 +219,7 @@ test "BaseQuantities - Electric combinations" {
|
|||||||
// Charge = Current * time
|
// Charge = Current * time
|
||||||
const charge = current.mul(time);
|
const charge = current.mul(time);
|
||||||
try std.testing.expectEqual(6.0, charge.data[0]);
|
try std.testing.expectEqual(6.0, charge.data[0]);
|
||||||
try std.testing.expect(ElectricCharge.dims.eql(@TypeOf(charge).dims));
|
try comptime std.testing.expect(ElectricCharge.dims.eql(@TypeOf(charge).dims));
|
||||||
}
|
}
|
||||||
|
|
||||||
test "Constants - Initialization and dimension checks" {
|
test "Constants - Initialization and dimension checks" {
|
||||||
|
|||||||
+22
-22
@@ -49,22 +49,22 @@ data: std.EnumArray(Dimension, comptime_int),
|
|||||||
|
|
||||||
/// Create a `Dimensions` from a struct literal, e.g. `.{ .L = 1, .T = -1 }`.
|
/// Create a `Dimensions` from a struct literal, e.g. `.{ .L = 1, .T = -1 }`.
|
||||||
/// Unspecified dimensions default to 0.
|
/// Unspecified dimensions default to 0.
|
||||||
pub fn init(comptime init_val: ArgOpts) Self {
|
pub fn init(init_val: ArgOpts) Self {
|
||||||
var s = Self{ .data = std.EnumArray(Dimension, comptime_int).initFill(0) };
|
var s = Self{ .data = std.EnumArray(Dimension, comptime_int).initFill(0) };
|
||||||
for (std.meta.fields(@TypeOf(init_val))) |f|
|
for (std.meta.fields(@TypeOf(init_val))) |f|
|
||||||
s.data.set(@field(Dimension, f.name), @field(init_val, f.name));
|
s.data.set(@field(Dimension, f.name), @field(init_val, f.name));
|
||||||
return s;
|
return s;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn initFill(comptime val: comptime_int) Self {
|
pub fn initFill(val: comptime_int) Self {
|
||||||
comptime return .{ .data = std.EnumArray(Dimension, comptime_int).initFill(val) };
|
return .{ .data = std.EnumArray(Dimension, comptime_int).initFill(val) };
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get(comptime self: Self, comptime key: Dimension) comptime_int {
|
pub fn get(self: Self, key: Dimension) comptime_int {
|
||||||
comptime return self.data.get(key);
|
return self.data.get(key);
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn set(comptime self: *Self, comptime key: Dimension, comptime val: i8) void {
|
pub fn set(self: *Self, key: Dimension, val: i8) void {
|
||||||
self.data.set(key, val);
|
self.data.set(key, val);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -72,58 +72,58 @@ pub fn argsOpt(self: Self) ArgOpts {
|
|||||||
var args: ArgOpts = undefined;
|
var args: ArgOpts = undefined;
|
||||||
for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
@field(args, @tagName(d)) = self.get(d);
|
@field(args, @tagName(d)) = self.get(d);
|
||||||
comptime return args;
|
return args;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Add exponents component-wise. Used internally by `mul`.
|
/// Add exponents component-wise. Used internally by `mul`.
|
||||||
pub fn add(comptime a: Self, comptime b: Self) Self {
|
pub fn add(a: Self, b: Self) Self {
|
||||||
var result = Self.initFill(0);
|
var result = Self.initFill(0);
|
||||||
for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
result.set(d, a.get(d) + b.get(d));
|
result.set(d, a.get(d) + b.get(d));
|
||||||
comptime return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Subtract exponents component-wise. Used internally by `div`.
|
/// Subtract exponents component-wise. Used internally by `div`.
|
||||||
pub fn sub(comptime a: Self, comptime b: Self) Self {
|
pub fn sub(a: Self, b: Self) Self {
|
||||||
var result = Self.initFill(0);
|
var result = Self.initFill(0);
|
||||||
for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
result.set(d, a.get(d) - b.get(d));
|
result.set(d, a.get(d) - b.get(d));
|
||||||
comptime return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Multiply exponents by a scalar integer. Used internally by `pow` in Scalar.
|
/// Multiply exponents by a scalar integer. Used internally by `pow` in Scalar.
|
||||||
pub fn scale(comptime a: Self, comptime exp: comptime_int) Self {
|
pub fn scale(a: Self, exp: comptime_int) Self {
|
||||||
var result = Self.initFill(0);
|
var result = Self.initFill(0);
|
||||||
for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
result.set(d, a.get(d) * exp);
|
result.set(d, a.get(d) * exp);
|
||||||
comptime return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn div(comptime a: Self, comptime exp: comptime_int) Self {
|
pub fn div(a: Self, exp: comptime_int) Self {
|
||||||
var result = Self.initFill(0);
|
var result = Self.initFill(0);
|
||||||
inline for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
result.set(d, a.get(d) / exp);
|
result.set(d, a.get(d) / exp);
|
||||||
comptime return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns true if every dimension exponent is equal. Used to enforce type compatibility in `add`, `sub`, `to`.
|
/// Returns true if every dimension exponent is equal. Used to enforce type compatibility in `add`, `sub`, `to`.
|
||||||
pub fn eql(comptime a: Self, comptime b: Self) bool {
|
pub fn eql(a: Self, b: Self) bool {
|
||||||
inline for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
if (a.get(d) != b.get(d)) return false;
|
if (a.get(d) != b.get(d)) return false;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn isSquare(comptime a: Self) bool {
|
pub fn isSquare(a: Self) bool {
|
||||||
inline for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
if (a.get(d) % 2 != 0) return false;
|
if (a.get(d) % 2 != 0) return false;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn str(comptime a: Self) []const u8 {
|
pub fn str(a: Self) []const u8 {
|
||||||
var out: []const u8 = "";
|
var out: []const u8 = "";
|
||||||
const dims = std.enums.values(Dimension);
|
const dims = std.enums.values(Dimension);
|
||||||
|
|
||||||
inline for (dims) |d| {
|
for (dims) |d| {
|
||||||
const val = a.get(d);
|
const val = a.get(d);
|
||||||
if (val != 0) {
|
if (val != 0) {
|
||||||
out = out ++ @tagName(d) ++ std.fmt.comptimePrint("{d}", .{val});
|
out = out ++ @tagName(d) ++ std.fmt.comptimePrint("{d}", .{val});
|
||||||
|
|||||||
+30
-24
@@ -55,33 +55,33 @@ pub const UnitScale = enum(isize) {
|
|||||||
// Undefined
|
// Undefined
|
||||||
_,
|
_,
|
||||||
|
|
||||||
pub inline fn str(self: @This()) []const u8 {
|
pub fn str(self: @This()) []const u8 {
|
||||||
var buf: [16]u8 = undefined;
|
var buf: [16]u8 = undefined;
|
||||||
return switch (self) {
|
return switch (self) {
|
||||||
inline .none => "",
|
.none => "",
|
||||||
inline .P, .T, .G, .M, .k, .h, .da, .d, .c, .m, .u, .n, .p, .f, .min, .hour, .year, .inch, .ft, .yd, .mi, .oz, .lb, .st => @tagName(self),
|
.P, .T, .G, .M, .k, .h, .da, .d, .c, .m, .u, .n, .p, .f, .min, .hour, .year, .inch, .ft, .yd, .mi, .oz, .lb, .st => @tagName(self),
|
||||||
else => std.fmt.bufPrint(&buf, "[{d}]", .{@intFromEnum(self)}) catch "[]", // This cannot be inline because of non exhaustive enum, but that's ok, it is just str, not calculation
|
else => std.fmt.bufPrint(&buf, "[{d}]", .{@intFromEnum(self)}) catch "[]", // This cannot be inline because of non exhaustive enum, but that's ok, it is just str, not calculation
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
pub inline fn getFactor(self: @This()) comptime_float {
|
pub fn getFactor(self: @This()) comptime_float {
|
||||||
comptime return switch (self) {
|
return switch (self) {
|
||||||
// Standard SI Exponents
|
// Standard SI Exponents
|
||||||
inline .P, .T, .G, .M, .k, .h, .da, .none, .d, .c, .m, .u, .n, .p, .f => std.math.pow(f64, 10.0, @floatFromInt(@intFromEnum(self))),
|
.P, .T, .G, .M, .k, .h, .da, .none, .d, .c, .m, .u, .n, .p, .f => std.math.pow(f64, 10.0, @floatFromInt(@intFromEnum(self))),
|
||||||
|
|
||||||
// Time Factors
|
// Time Factors
|
||||||
inline .min, .hour, .year => @floatFromInt(@intFromEnum(self)),
|
.min, .hour, .year => @floatFromInt(@intFromEnum(self)),
|
||||||
|
|
||||||
// Imperial Length (metres)
|
// Imperial Length (metres)
|
||||||
inline .inch => 0.0254,
|
.inch => 0.0254,
|
||||||
inline .ft => 0.3048,
|
.ft => 0.3048,
|
||||||
inline .yd => 0.9144,
|
.yd => 0.9144,
|
||||||
inline .mi => 1609.344,
|
.mi => 1609.344,
|
||||||
|
|
||||||
// Imperial Mass (grams — base unit for M is gram, i.e. .none = 1 g)
|
// Imperial Mass (grams — base unit for M is gram, i.e. .none = 1 g)
|
||||||
inline .oz => 28.3495231,
|
.oz => 28.3495231,
|
||||||
inline .lb => 453.59237,
|
.lb => 453.59237,
|
||||||
inline .st => 6350.29318,
|
.st => 6350.29318,
|
||||||
|
|
||||||
else => @floatFromInt(@intFromEnum(self)),
|
else => @floatFromInt(@intFromEnum(self)),
|
||||||
};
|
};
|
||||||
@@ -97,7 +97,7 @@ data: std.EnumArray(Dimension, UnitScale),
|
|||||||
/// Unspecified dimensions default to `.none` (factor 1).
|
/// Unspecified dimensions default to `.none` (factor 1).
|
||||||
pub fn init(comptime init_val: ArgOpts) Self {
|
pub fn init(comptime init_val: ArgOpts) Self {
|
||||||
comptime var s = Self{ .data = std.EnumArray(Dimension, UnitScale).initFill(.none) };
|
comptime var s = Self{ .data = std.EnumArray(Dimension, UnitScale).initFill(.none) };
|
||||||
inline for (std.meta.fields(@TypeOf(init_val))) |f| {
|
for (std.meta.fields(@TypeOf(init_val))) |f| {
|
||||||
if (comptime @typeInfo(@TypeOf(@field(init_val, f.name))) == .comptime_int)
|
if (comptime @typeInfo(@TypeOf(@field(init_val, f.name))) == .comptime_int)
|
||||||
s.data.set(@field(Dimension, f.name), @enumFromInt(@field(init_val, f.name)))
|
s.data.set(@field(Dimension, f.name), @enumFromInt(@field(init_val, f.name)))
|
||||||
else
|
else
|
||||||
@@ -106,31 +106,37 @@ pub fn init(comptime init_val: ArgOpts) Self {
|
|||||||
return comptime s;
|
return comptime s;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn initFill(comptime val: UnitScale) Self {
|
pub fn initFill(val: UnitScale) Self {
|
||||||
comptime return .{ .data = std.EnumArray(Dimension, UnitScale).initFill(val) };
|
return .{ .data = std.EnumArray(Dimension, UnitScale).initFill(val) };
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get(comptime self: Self, comptime key: Dimension) UnitScale {
|
pub fn get(self: Self, key: Dimension) UnitScale {
|
||||||
return comptime self.data.get(key);
|
return self.data.get(key);
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn set(comptime self: *Self, comptime key: Dimension, comptime val: UnitScale) void {
|
pub fn set(self: *Self, key: Dimension, val: UnitScale) void {
|
||||||
self.data.set(key, val);
|
self.data.set(key, val);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn eql(self: Self, other: Self) bool {
|
||||||
|
for (self.data.values, other.data.values) |l, r|
|
||||||
|
if (l != r) return false;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
pub fn argsOpt(self: Self) ArgOpts {
|
pub fn argsOpt(self: Self) ArgOpts {
|
||||||
var args: ArgOpts = undefined;
|
var args: ArgOpts = undefined;
|
||||||
inline for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
@field(args, @tagName(d)) = self.get(d);
|
@field(args, @tagName(d)) = self.get(d);
|
||||||
return args;
|
return args;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Compute the combined scale factor for a given dimension signature.
|
/// Compute the combined scale factor for a given dimension signature.
|
||||||
/// Each dimension's prefix is raised to its exponent and multiplied together.
|
/// Each dimension's prefix is raised to its exponent and multiplied together.
|
||||||
pub inline fn getFactor(comptime s: Self, comptime d: Dimensions) comptime_float {
|
pub fn getFactor(s: Self, d: Dimensions) comptime_float {
|
||||||
var factor: f64 = 1.0;
|
var factor: f64 = 1.0;
|
||||||
for (std.enums.values(Dimension)) |dim| {
|
for (std.enums.values(Dimension)) |dim| {
|
||||||
const power = comptime d.get(dim);
|
const power = d.get(dim);
|
||||||
if (power == 0) continue;
|
if (power == 0) continue;
|
||||||
|
|
||||||
const base = s.get(dim).getFactor();
|
const base = s.get(dim).getFactor();
|
||||||
@@ -144,5 +150,5 @@ pub inline fn getFactor(comptime s: Self, comptime d: Dimensions) comptime_float
|
|||||||
factor /= base;
|
factor /= base;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
comptime return factor;
|
return factor;
|
||||||
}
|
}
|
||||||
|
|||||||
+30
-29
@@ -8,14 +8,14 @@ const Dimension = Dimensions.Dimension;
|
|||||||
// Comptime utilities
|
// Comptime utilities
|
||||||
// ─────────────────────────────────────────────────────────────────────────────
|
// ─────────────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
pub fn shapeTotal(comptime shape: []const comptime_int) usize {
|
pub fn shapeTotal(shape: []const comptime_int) usize {
|
||||||
var t: comptime_int = 1;
|
var t: comptime_int = 1;
|
||||||
for (shape) |s| t *= s;
|
for (shape) |s| t *= s;
|
||||||
return t;
|
return t;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Check if two shapes are strictly identical.
|
/// Check if two shapes are strictly identical.
|
||||||
pub fn shapeEql(comptime a: []const comptime_int, comptime b: []const comptime_int) bool {
|
pub fn shapeEql(a: []const comptime_int, b: []const comptime_int) bool {
|
||||||
if (a.len != b.len) return false;
|
if (a.len != b.len) return false;
|
||||||
for (a, 0..) |v, i|
|
for (a, 0..) |v, i|
|
||||||
if (v != b[i]) return false;
|
if (v != b[i]) return false;
|
||||||
@@ -25,7 +25,7 @@ pub fn shapeEql(comptime a: []const comptime_int, comptime b: []const comptime_i
|
|||||||
/// Row-major (C-order) strides: strides[i] = product(shape[i+1..]).
|
/// Row-major (C-order) strides: strides[i] = product(shape[i+1..]).
|
||||||
/// e.g. shape {3, 4} → strides {4, 1}
|
/// e.g. shape {3, 4} → strides {4, 1}
|
||||||
/// shape {2, 3, 4} → strides {12, 4, 1}
|
/// shape {2, 3, 4} → strides {12, 4, 1}
|
||||||
pub fn shapeStrides(comptime shape: []const comptime_int) [shape.len]comptime_int {
|
pub fn shapeStrides(shape: []const comptime_int) [shape.len]comptime_int {
|
||||||
var st: [shape.len]comptime_int = undefined;
|
var st: [shape.len]comptime_int = undefined;
|
||||||
if (shape.len == 0) return st;
|
if (shape.len == 0) return st;
|
||||||
st[shape.len - 1] = 1;
|
st[shape.len - 1] = 1;
|
||||||
@@ -37,7 +37,7 @@ pub fn shapeStrides(comptime shape: []const comptime_int) [shape.len]comptime_in
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Return a copy of `shape` with the element at `axis` removed.
|
/// Return a copy of `shape` with the element at `axis` removed.
|
||||||
pub fn shapeRemoveAxis(comptime shape: []const comptime_int, comptime axis: comptime_int) [shape.len - 1]comptime_int {
|
pub fn shapeRemoveAxis(shape: []const comptime_int, axis: comptime_int) [shape.len - 1]comptime_int {
|
||||||
var out: [shape.len - 1]comptime_int = undefined;
|
var out: [shape.len - 1]comptime_int = undefined;
|
||||||
var j: comptime_int = 0;
|
var j: comptime_int = 0;
|
||||||
for (shape, 0..) |v, i| {
|
for (shape, 0..) |v, i| {
|
||||||
@@ -50,7 +50,7 @@ pub fn shapeRemoveAxis(comptime shape: []const comptime_int, comptime axis: comp
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Concatenate two compile-time slices.
|
/// Concatenate two compile-time slices.
|
||||||
pub fn shapeCat(comptime a: []const comptime_int, comptime b: []const comptime_int) [a.len + b.len]comptime_int {
|
pub fn shapeCat(a: []const comptime_int, b: []const comptime_int) [a.len + b.len]comptime_int {
|
||||||
var out: [a.len + b.len]comptime_int = undefined;
|
var out: [a.len + b.len]comptime_int = undefined;
|
||||||
for (a, 0..) |v, i| out[i] = v;
|
for (a, 0..) |v, i| out[i] = v;
|
||||||
for (b, 0..) |v, i| out[a.len + i] = v;
|
for (b, 0..) |v, i| out[a.len + i] = v;
|
||||||
@@ -59,11 +59,7 @@ pub fn shapeCat(comptime a: []const comptime_int, comptime b: []const comptime_i
|
|||||||
|
|
||||||
/// Decode a flat row-major index into N-D coordinates.
|
/// Decode a flat row-major index into N-D coordinates.
|
||||||
/// Called only in comptime contexts (all arguments are comptime).
|
/// Called only in comptime contexts (all arguments are comptime).
|
||||||
pub fn decodeFlatCoords(
|
pub fn decodeFlatCoords(flat: comptime_int, n: comptime_int, strd: [n]comptime_int) [n]usize {
|
||||||
comptime flat: comptime_int,
|
|
||||||
comptime n: comptime_int,
|
|
||||||
comptime strd: [n]comptime_int,
|
|
||||||
) [n]usize {
|
|
||||||
var coords: [n]comptime_int = undefined;
|
var coords: [n]comptime_int = undefined;
|
||||||
var tmp = flat;
|
var tmp = flat;
|
||||||
for (0..n) |i| {
|
for (0..n) |i| {
|
||||||
@@ -75,11 +71,7 @@ pub fn decodeFlatCoords(
|
|||||||
|
|
||||||
/// Encode N-D coordinates into a flat row-major index.
|
/// Encode N-D coordinates into a flat row-major index.
|
||||||
/// Called only in comptime contexts.
|
/// Called only in comptime contexts.
|
||||||
pub fn encodeFlatCoords(
|
pub fn encodeFlatCoords(coords: []const usize, n: usize, strd: [n]usize) usize {
|
||||||
comptime coords: []const usize,
|
|
||||||
comptime n: usize,
|
|
||||||
comptime strd: [n]usize,
|
|
||||||
) usize {
|
|
||||||
var flat: usize = 0;
|
var flat: usize = 0;
|
||||||
for (0..n) |i| flat += coords[i] * strd[i];
|
for (0..n) |i| flat += coords[i] * strd[i];
|
||||||
return flat;
|
return flat;
|
||||||
@@ -106,7 +98,7 @@ pub fn insertAxis(
|
|||||||
return out;
|
return out;
|
||||||
}
|
}
|
||||||
|
|
||||||
fn isInt(comptime T: type) bool {
|
inline fn isInt(comptime T: type) bool {
|
||||||
return @typeInfo(T) == .int or @typeInfo(T) == .comptime_int;
|
return @typeInfo(T) == .int or @typeInfo(T) == .comptime_int;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -130,25 +122,27 @@ fn finerScales(comptime T1: type, comptime T2: type) Scales {
|
|||||||
else
|
else
|
||||||
scale1);
|
scale1);
|
||||||
}
|
}
|
||||||
comptime return out;
|
return out;
|
||||||
}
|
}
|
||||||
// ─────────────────────────────────────────────────────────────────────────────
|
// ─────────────────────────────────────────────────────────────────────────────
|
||||||
// File-scope RHS normalisation helpers
|
// File-scope RHS normalisation helpers
|
||||||
// ─────────────────────────────────────────────────────────────────────────────
|
// ─────────────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
fn isTensor(comptime Rhs: type) bool {
|
inline fn isTensor(comptime Rhs: type) bool {
|
||||||
return comptime @typeInfo(Rhs) == .@"struct" and @hasDecl(Rhs, "ISTENSOR");
|
return comptime @typeInfo(Rhs) == .@"struct" and @hasDecl(Rhs, "ISTENSOR");
|
||||||
}
|
}
|
||||||
|
|
||||||
fn RhsTensorType(comptime T: type, comptime Rhs: type) type {
|
inline fn RhsTensorType(comptime T: type, comptime Rhs: type) type {
|
||||||
if (comptime isTensor(Rhs)) return Rhs;
|
if (comptime isTensor(Rhs)) return Rhs;
|
||||||
return Tensor(T, .{}, .{}, &.{1});
|
return Tensor(T, .{}, .{}, &.{1});
|
||||||
}
|
}
|
||||||
|
|
||||||
fn toRhsTensor(comptime T: type, r: anytype) RhsTensorType(T, @TypeOf(r)) {
|
/// Take the anyvalue coming from operation and if it is a Tensor, return it.
|
||||||
|
/// If it is a float or int, return a Tensor(T, .{}, .{}, .{1}).splat(r).
|
||||||
|
inline fn toRhsTensor(comptime T: type, r: anytype) RhsTensorType(T, @TypeOf(r)) {
|
||||||
const Rhs = @TypeOf(r);
|
const Rhs = @TypeOf(r);
|
||||||
if (comptime isTensor(Rhs)) return r;
|
if (comptime isTensor(Rhs)) return r;
|
||||||
const scalar: T = switch (comptime @typeInfo(Rhs)) {
|
const scalar: T = switch (@typeInfo(Rhs)) {
|
||||||
.comptime_int => switch (comptime @typeInfo(T)) {
|
.comptime_int => switch (comptime @typeInfo(T)) {
|
||||||
.float => @as(T, @floatFromInt(r)),
|
.float => @as(T, @floatFromInt(r)),
|
||||||
else => @as(T, r),
|
else => @as(T, r),
|
||||||
@@ -209,7 +203,7 @@ pub fn Tensor(
|
|||||||
if (s == 0) @compileError("Tensor shape dimensions must be strictly >= 1.");
|
if (s == 0) @compileError("Tensor shape dimensions must be strictly >= 1.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@setEvalBranchQuota(10_000_000);
|
@setEvalBranchQuota(100_000);
|
||||||
|
|
||||||
const _total: usize = comptime shapeTotal(shape_);
|
const _total: usize = comptime shapeTotal(shape_);
|
||||||
const _strides = comptime shapeStrides(shape_);
|
const _strides = comptime shapeStrides(shape_);
|
||||||
@@ -277,18 +271,20 @@ pub fn Tensor(
|
|||||||
finerScales(Self, RhsT(@TypeOf(r))).argsOpt(),
|
finerScales(Self, RhsT(@TypeOf(r))).argsOpt(),
|
||||||
shape_,
|
shape_,
|
||||||
) {
|
) {
|
||||||
const rhs_q = rhs(r);
|
const rhs_t = rhs(r);
|
||||||
const RhsType = @TypeOf(rhs_q);
|
const RhsType = @TypeOf(r);
|
||||||
if (comptime !dims.eql(RhsType.dims))
|
if (comptime !dims.eql(RhsType.dims))
|
||||||
@compileError("Dimension mismatch in add: " ++ dims.str() ++ " vs " ++ RhsType.dims.str());
|
@compileError("Dimension mismatch in add: " ++ dims.str() ++ " vs " ++ RhsType.dims.str());
|
||||||
if (comptime RhsType.total != 1 and !shapeEql(shape_, RhsType.shape))
|
if (comptime RhsType.total != 1 and !shapeEql(shape_, RhsType.shape))
|
||||||
@compileError("Shape mismatch in add: element-wise operations require identical shapes, or a scalar RHS.");
|
@compileError("Shape mismatch in add: element-wise operations require identical shapes, or a scalar RHS.");
|
||||||
|
if (comptime total == 1 and scales.eql(RhsType.scales)) // Here rhs_t has to be {1} too
|
||||||
|
return .{ .data = if (comptime isInt(T)) self.data +| rhs_t.data else self.data + rhs_t.data };
|
||||||
|
|
||||||
const TargetType = Tensor(T, dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), shape_);
|
const TargetType = Tensor(T, dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), shape_);
|
||||||
const l: Vec = if (comptime Self == TargetType) self.data else self.to(TargetType).data;
|
const l: Vec = if (comptime Self == TargetType) self.data else self.to(TargetType).data;
|
||||||
const rr: Vec = blk: {
|
const rr: Vec = blk: {
|
||||||
const RhsNorm = Tensor(T, RhsType.dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), RhsType.shape);
|
const RhsNorm = Tensor(T, RhsType.dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), RhsType.shape);
|
||||||
const rn = if (comptime RhsType == RhsNorm) rhs_q else rhs_q.to(RhsNorm);
|
const rn = if (comptime RhsType == RhsNorm) rhs_t else rhs_t.to(RhsNorm);
|
||||||
break :blk broadcastToVec(RhsNorm, rn);
|
break :blk broadcastToVec(RhsNorm, rn);
|
||||||
};
|
};
|
||||||
return .{ .data = if (comptime isInt(T)) l +| rr else l + rr };
|
return .{ .data = if (comptime isInt(T)) l +| rr else l + rr };
|
||||||
@@ -302,18 +298,20 @@ pub fn Tensor(
|
|||||||
finerScales(Self, RhsT(@TypeOf(r))).argsOpt(),
|
finerScales(Self, RhsT(@TypeOf(r))).argsOpt(),
|
||||||
shape_,
|
shape_,
|
||||||
) {
|
) {
|
||||||
const rhs_q = rhs(r);
|
const rhs_t = rhs(r);
|
||||||
const RhsType = @TypeOf(rhs_q);
|
const RhsType = @TypeOf(rhs_t);
|
||||||
if (comptime !dims.eql(RhsType.dims))
|
if (comptime !dims.eql(RhsType.dims))
|
||||||
@compileError("Dimension mismatch in sub: " ++ dims.str() ++ " vs " ++ RhsType.dims.str());
|
@compileError("Dimension mismatch in sub: " ++ dims.str() ++ " vs " ++ RhsType.dims.str());
|
||||||
if (comptime RhsType.total != 1 and !shapeEql(shape_, RhsType.shape))
|
if (comptime RhsType.total != 1 and !shapeEql(shape_, RhsType.shape))
|
||||||
@compileError("Shape mismatch in sub: element-wise operations require identical shapes, or a scalar RHS.");
|
@compileError("Shape mismatch in sub: element-wise operations require identical shapes, or a scalar RHS.");
|
||||||
|
if (comptime total == 1 and scales.eql(RhsType.scales)) // Here rhs_t has to be {1} too
|
||||||
|
return .{ .data = if (comptime isInt(T)) self.data -| rhs_t.data else self.data - rhs_t.data };
|
||||||
|
|
||||||
const TargetType = Tensor(T, dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), shape_);
|
const TargetType = Tensor(T, dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), shape_);
|
||||||
const l: Vec = if (comptime Self == TargetType) self.data else self.to(TargetType).data;
|
const l: Vec = if (comptime Self == TargetType) self.data else self.to(TargetType).data;
|
||||||
const rr: Vec = blk: {
|
const rr: Vec = blk: {
|
||||||
const RhsNorm = Tensor(T, RhsType.dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), RhsType.shape);
|
const RhsNorm = Tensor(T, RhsType.dims.argsOpt(), finerScales(Self, RhsType).argsOpt(), RhsType.shape);
|
||||||
const rn = if (comptime RhsType == RhsNorm) rhs_q else rhs_q.to(RhsNorm);
|
const rn = if (comptime RhsType == RhsNorm) rhs_t else rhs_t.to(RhsNorm);
|
||||||
break :blk broadcastToVec(RhsNorm, rn);
|
break :blk broadcastToVec(RhsNorm, rn);
|
||||||
};
|
};
|
||||||
return .{ .data = if (comptime isInt(T)) l -| rr else l - rr };
|
return .{ .data = if (comptime isInt(T)) l -| rr else l - rr };
|
||||||
@@ -450,6 +448,9 @@ pub fn Tensor(
|
|||||||
const DestT = ActualDest.ValueType;
|
const DestT = ActualDest.ValueType;
|
||||||
const DestVec = @Vector(total, DestT);
|
const DestVec = @Vector(total, DestT);
|
||||||
|
|
||||||
|
if (comptime ratio == 1.0 and T == DestT)
|
||||||
|
return .{ .data = self.data };
|
||||||
|
|
||||||
// If ratio is 1, handle type conversion correctly based on BOTH source and dest types
|
// If ratio is 1, handle type conversion correctly based on BOTH source and dest types
|
||||||
if (comptime ratio == 1.0) {
|
if (comptime ratio == 1.0) {
|
||||||
const T_info = @typeInfo(T);
|
const T_info = @typeInfo(T);
|
||||||
@@ -533,7 +534,7 @@ pub fn Tensor(
|
|||||||
pub inline fn eq(self: Self, r: anytype) CmpResult {
|
pub inline fn eq(self: Self, r: anytype) CmpResult {
|
||||||
const rhs_q = rhs(r);
|
const rhs_q = rhs(r);
|
||||||
if (comptime !dims.eql(@TypeOf(rhs_q).dims))
|
if (comptime !dims.eql(@TypeOf(rhs_q).dims))
|
||||||
@compileError("Dimension mismatch in eq: " ++ dims.str() ++ " vs " ++ @TypeOf(rhs_q).dims.str());
|
@compileError("Dimension mismatch in ne.");
|
||||||
const p = resolveScalePair(self, rhs_q);
|
const p = resolveScalePair(self, rhs_q);
|
||||||
return cmpResult(p.l == p.r);
|
return cmpResult(p.l == p.r);
|
||||||
}
|
}
|
||||||
|
|||||||
+164
-41
@@ -10,25 +10,27 @@ pub fn main(init: std.process.Init) !void {
|
|||||||
|
|
||||||
io = init.io;
|
io = init.io;
|
||||||
|
|
||||||
try vectorSIMDvsNative(f64, &stdout_writer.interface);
|
// try vectorSIMDvsNative(f64, &stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
// try stdout_writer.flush();
|
||||||
try vectorSIMDvsNative(f32, &stdout_writer.interface);
|
// try vectorSIMDvsNative(f32, &stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
// try stdout_writer.flush();
|
||||||
try vectorSIMDvsNative(i32, &stdout_writer.interface);
|
// try vectorSIMDvsNative(i32, &stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
// try stdout_writer.flush();
|
||||||
try vectorSIMDvsNative(i64, &stdout_writer.interface);
|
// try vectorSIMDvsNative(i64, &stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
// try stdout_writer.flush();
|
||||||
try vectorSIMDvsNative(i128, &stdout_writer.interface);
|
// try vectorSIMDvsNative(i128, &stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
// try stdout_writer.flush();
|
||||||
|
//
|
||||||
try bench_Scalar(&stdout_writer.interface);
|
// try bench_Scalar(&stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
// try stdout_writer.flush();
|
||||||
try bench_vsNative(&stdout_writer.interface);
|
try bench_vsNative(&stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
try stdout_writer.flush();
|
||||||
try bench_crossTypeVsNative(&stdout_writer.interface);
|
// try bench_crossTypeVsNative(&stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
try stdout_writer.flush();
|
||||||
try bench_Vector(&stdout_writer.interface);
|
try bench_Vector(&stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
try stdout_writer.flush();
|
||||||
|
try bench_HighDimTensor(&stdout_writer.interface);
|
||||||
|
try stdout_writer.flush();
|
||||||
}
|
}
|
||||||
|
|
||||||
fn getTime() Io.Timestamp {
|
fn getTime() Io.Timestamp {
|
||||||
@@ -169,7 +171,7 @@ fn bench_Scalar(writer: *std.Io.Writer) !void {
|
|||||||
|
|
||||||
fn bench_vsNative(writer: *std.Io.Writer) !void {
|
fn bench_vsNative(writer: *std.Io.Writer) !void {
|
||||||
const ITERS: usize = 100_000;
|
const ITERS: usize = 100_000;
|
||||||
const SAMPLES: usize = 5;
|
const SAMPLES: usize = 100;
|
||||||
|
|
||||||
const getValT = struct {
|
const getValT = struct {
|
||||||
fn f(comptime TT: type, i: usize) TT {
|
fn f(comptime TT: type, i: usize) TT {
|
||||||
@@ -178,8 +180,8 @@ fn bench_vsNative(writer: *std.Io.Writer) !void {
|
|||||||
}
|
}
|
||||||
}.f;
|
}.f;
|
||||||
|
|
||||||
const Types = .{ i32, i64, i128, f32, f64 };
|
const Types = .{ f64, i64, i128, f32, f64 };
|
||||||
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
const TNames = .{ "f64", "i64", "i128", "f32", "f64" };
|
||||||
// Expanded Ops to match bench_Scalar
|
// Expanded Ops to match bench_Scalar
|
||||||
const Ops = .{ "add", "sub", "mul", "div", "abs", "eq", "gt" };
|
const Ops = .{ "add", "sub", "mul", "div", "abs", "eq", "gt" };
|
||||||
|
|
||||||
@@ -187,35 +189,34 @@ fn bench_vsNative(writer: *std.Io.Writer) !void {
|
|||||||
\\
|
\\
|
||||||
\\ Scalar vs Native Overhead Analysis
|
\\ Scalar vs Native Overhead Analysis
|
||||||
\\
|
\\
|
||||||
\\┌───────────┬──────┬───────────┬───────────┬───────────┐
|
\\┌───────────┬──────┬───────────┬───────────┬───────────┬───────────────────────┐
|
||||||
\\│ Operation │ Type │ Native │ Scalar │ Slowdown │
|
\\│ Operation │ Type │ Native │ @Vector │ Tensor{{1}} │ Slowdown Nat | Vec │
|
||||||
\\├───────────┼──────┼───────────┼───────────┼───────────┤
|
\\├───────────┼──────┼───────────┼───────────┼───────────┼───────────────────────┤
|
||||||
\\
|
\\
|
||||||
, .{});
|
, .{});
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, j| {
|
inline for (Ops, 0..) |op_name, j| {
|
||||||
inline for (Types, 0..) |T, tidx| {
|
inline for (Types, 0..) |T, tidx| {
|
||||||
var native_total_ns: f64 = 0;
|
var native_total_ns: f64 = 0;
|
||||||
var quantity_total_ns: f64 = 0;
|
var vector_total_ns: f64 = 0;
|
||||||
|
var tensor_total_ns: f64 = 0;
|
||||||
|
|
||||||
const M = Tensor(T, .{ .L = 1 }, .{}, &.{1});
|
const M = Tensor(T, .{}, .{}, &.{1});
|
||||||
const S = Tensor(T, .{ .T = 1 }, .{}, &.{1});
|
|
||||||
|
|
||||||
std.mem.doNotOptimizeAway({
|
std.mem.doNotOptimizeAway({
|
||||||
for (0..SAMPLES) |_| {
|
for (0..SAMPLES) |_| {
|
||||||
// --- 1. Benchmark Native ---
|
// --- 1. Benchmark Native ---
|
||||||
const n_start = getTime();
|
const n_start = getTime();
|
||||||
for (0..ITERS) |i| {
|
const a = getValT(T, 10);
|
||||||
const a = getValT(T, i);
|
const b = getValT(T, 2);
|
||||||
const b = getValT(T, 2);
|
for (0..ITERS) |_| {
|
||||||
|
|
||||||
// Native logic branch
|
// Native logic branch
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
a + b
|
if (comptime @typeInfo(T) == .int) a +| b else a + b
|
||||||
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
||||||
a - b
|
if (comptime @typeInfo(T) == .int) a -| b else a - b
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
||||||
a * b
|
if (comptime @typeInfo(T) == .int) a *| b else a * b
|
||||||
else if (comptime std.mem.eql(u8, op_name, "div"))
|
else if (comptime std.mem.eql(u8, op_name, "div"))
|
||||||
if (comptime @typeInfo(T) == .int) @divTrunc(a, b) else a / b
|
if (comptime @typeInfo(T) == .int) @divTrunc(a, b) else a / b
|
||||||
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
||||||
@@ -230,12 +231,36 @@ fn bench_vsNative(writer: *std.Io.Writer) !void {
|
|||||||
const n_end = getTime();
|
const n_end = getTime();
|
||||||
native_total_ns += @as(f64, @floatFromInt(n_start.durationTo(n_end).toNanoseconds()));
|
native_total_ns += @as(f64, @floatFromInt(n_start.durationTo(n_end).toNanoseconds()));
|
||||||
|
|
||||||
|
const v_start = getTime();
|
||||||
|
const va = getValT(T, 10);
|
||||||
|
const vb = getValT(T, 2);
|
||||||
|
for (0..ITERS) |_| {
|
||||||
|
// Native logic branch
|
||||||
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
|
if (comptime @typeInfo(T) == .int) va +| vb else va + vb
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
||||||
|
if (comptime @typeInfo(T) == .int) va -| vb else va - vb
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
||||||
|
if (comptime @typeInfo(T) == .int) va *| vb else va * vb
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "div"))
|
||||||
|
if (comptime @typeInfo(T) == .int) @divTrunc(va, vb) else va / vb
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
||||||
|
if (comptime @typeInfo(T) == .int) @abs(va) else @as(T, @abs(va))
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "eq"))
|
||||||
|
va == vb
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "gt"))
|
||||||
|
va > vb
|
||||||
|
else
|
||||||
|
unreachable;
|
||||||
|
}
|
||||||
|
const v_end = getTime();
|
||||||
|
vector_total_ns += @as(f64, @floatFromInt(v_start.durationTo(v_end).toNanoseconds()));
|
||||||
|
|
||||||
// --- 2. Benchmark Scalar ---
|
// --- 2. Benchmark Scalar ---
|
||||||
const q_start = getTime();
|
const q_start = getTime();
|
||||||
for (0..ITERS) |i| {
|
const qa = M.splat(getValT(T, 10));
|
||||||
const qa = M.splat(getValT(T, i));
|
const qb = M.splat(getValT(T, 2));
|
||||||
const qb = if (comptime std.mem.eql(u8, op_name, "div")) S.splat(getValT(T, 2)) else M.splat(getValT(T, 2));
|
for (0..ITERS) |_| {
|
||||||
|
|
||||||
// Scalar logic branch
|
// Scalar logic branch
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
qa.add(qb)
|
qa.add(qb)
|
||||||
@@ -255,22 +280,24 @@ fn bench_vsNative(writer: *std.Io.Writer) !void {
|
|||||||
unreachable;
|
unreachable;
|
||||||
}
|
}
|
||||||
const q_end = getTime();
|
const q_end = getTime();
|
||||||
quantity_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
tensor_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
const avg_n = (native_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
const avg_n = (native_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
const avg_q = (quantity_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
const avg_v = (vector_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
const slowdown = avg_q / avg_n;
|
const avg_t = (tensor_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
|
const slowdown_nt = avg_t / avg_n;
|
||||||
|
const slowdown_vt = avg_t / avg_v;
|
||||||
|
|
||||||
try writer.print("│ {s:<9} │ {s:<4} │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>8.2}x │\n", .{
|
try writer.print("│ {s:<9} │ {s:<4} │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>8.2}x {d:>8.2}x │\n", .{
|
||||||
op_name, TNames[tidx], avg_n, avg_q, slowdown,
|
op_name, TNames[tidx], avg_n, avg_v, avg_t, slowdown_nt, slowdown_vt,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
if (j != Ops.len - 1) try writer.print("├───────────┼──────┼───────────┼───────────┼───────────┤\n", .{});
|
if (j != Ops.len - 1) try writer.print("├───────────┼──────┼───────────┼───────────┼───────────┼───────────────────────┤\n", .{});
|
||||||
}
|
}
|
||||||
|
|
||||||
try writer.print("└───────────┴──────┴───────────┴───────────┴───────────┘\n", .{});
|
try writer.print("└───────────┴──────┴───────────┴───────────┴───────────┴───────────────────────┘\n", .{});
|
||||||
}
|
}
|
||||||
|
|
||||||
fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
||||||
@@ -488,6 +515,102 @@ fn bench_Vector(writer: *std.Io.Writer) !void {
|
|||||||
try writer.print("└──────────────────┴──────┴─────────┴─────────┴─────────┴─────────┴─────────┘\n", .{});
|
try writer.print("└──────────────────┴──────┴─────────┴─────────┴─────────┴─────────┴─────────┘\n", .{});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn bench_HighDimTensor(writer: *std.Io.Writer) !void {
|
||||||
|
const ITERS: usize = 5_000;
|
||||||
|
const SAMPLES: usize = 5;
|
||||||
|
|
||||||
|
const getVal = struct {
|
||||||
|
fn f(comptime TT: type, i: usize, comptime mask: u7) TT {
|
||||||
|
const v: u8 = @as(u8, @truncate(i & @as(usize, mask))) + 1;
|
||||||
|
return if (comptime @typeInfo(TT) == .float) @floatFromInt(v) else @intCast(v);
|
||||||
|
}
|
||||||
|
}.f;
|
||||||
|
|
||||||
|
const computeStats = struct {
|
||||||
|
fn f(samples: []f64, iters: usize) f64 {
|
||||||
|
std.mem.sort(f64, samples, {}, std.sort.asc(f64));
|
||||||
|
const mid = samples.len / 2;
|
||||||
|
const median_ns = if (samples.len % 2 == 0)
|
||||||
|
(samples[mid - 1] + samples[mid]) / 2.0
|
||||||
|
else
|
||||||
|
samples[mid];
|
||||||
|
return median_ns / @as(f64, @floatFromInt(iters));
|
||||||
|
}
|
||||||
|
}.f;
|
||||||
|
|
||||||
|
try writer.print(
|
||||||
|
\\
|
||||||
|
\\ High Dimension Tensor benchmark — {d} iterations, {d} samples/cell
|
||||||
|
\\ (Results in ns/op)
|
||||||
|
\\
|
||||||
|
\\┌─────────────────┬──────┬──────────────┬──────────────┬──────────────┬──────────────┐
|
||||||
|
\\│ Operation │ Type │ 2x2x2 │ 3x3x3 │ 4x4x4 │ 10x10x10x10 │
|
||||||
|
\\├─────────────────┼──────┼──────────────┼──────────────┼──────────────┼──────────────┤
|
||||||
|
\\
|
||||||
|
, .{ ITERS, SAMPLES });
|
||||||
|
|
||||||
|
const Types = .{ i32, i64, f32, f64 };
|
||||||
|
const TNames = .{ "i32", "i64", "f32", "f64" };
|
||||||
|
|
||||||
|
// Testing multiple structural bounds
|
||||||
|
const Shapes = .{
|
||||||
|
&.{ 2, 2, 2 },
|
||||||
|
&.{ 3, 3, 3 },
|
||||||
|
&.{ 4, 4, 4 },
|
||||||
|
&.{ 10, 10, 10, 10 },
|
||||||
|
};
|
||||||
|
|
||||||
|
const Ops = .{ "add", "sub", "mulElem", "mulScalar", "abs" };
|
||||||
|
|
||||||
|
inline for (Ops, 0..) |op_name, o_idx| {
|
||||||
|
inline for (Types, TNames) |T, tname| {
|
||||||
|
try writer.print("│ {s:<15} │ {s:<4} │", .{ op_name, tname });
|
||||||
|
|
||||||
|
inline for (Shapes) |shape| {
|
||||||
|
const V = Tensor(T, .{ .L = 1 }, .{}, shape);
|
||||||
|
const Q = Tensor(T, .{ .T = 1 }, .{}, &.{1}); // For scalar broadcasting operations
|
||||||
|
|
||||||
|
var samples: [SAMPLES]f64 = undefined;
|
||||||
|
|
||||||
|
for (0..SAMPLES) |s_idx| {
|
||||||
|
const t_start = getTime();
|
||||||
|
|
||||||
|
for (0..ITERS) |i| {
|
||||||
|
std.mem.doNotOptimizeAway({
|
||||||
|
const t1 = V.splat(getVal(T, i, 63));
|
||||||
|
|
||||||
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
|
t1.add(V.splat(getVal(T, i +% 7, 63)))
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
||||||
|
t1.sub(V.splat(getVal(T, i +% 3, 63)))
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mulElem"))
|
||||||
|
t1.mul(V.splat(getVal(T, i +% 5, 63)))
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mulScalar"))
|
||||||
|
t1.mul(Q.splat(getVal(T, i +% 2, 63)))
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
||||||
|
t1.abs()
|
||||||
|
else
|
||||||
|
unreachable;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const t_end = getTime();
|
||||||
|
samples[s_idx] = @as(f64, @floatFromInt(t_start.durationTo(t_end).toNanoseconds()));
|
||||||
|
}
|
||||||
|
|
||||||
|
const median_ns_per_op = computeStats(&samples, ITERS);
|
||||||
|
try writer.print(" {d:>12.1} │", .{median_ns_per_op});
|
||||||
|
}
|
||||||
|
try writer.print("\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (o_idx < Ops.len - 1) {
|
||||||
|
try writer.print("├─────────────────┼──────┼──────────────┼──────────────┼──────────────┼──────────────┤\n", .{});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
try writer.print("└─────────────────┴──────┴──────────────┴──────────────┴──────────────┴──────────────┘\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
fn vectorSIMDvsNative(comptime T: type, writer: *std.Io.Writer) !void {
|
fn vectorSIMDvsNative(comptime T: type, writer: *std.Io.Writer) !void {
|
||||||
const iterations: u64 = 10_000;
|
const iterations: u64 = 10_000;
|
||||||
const lens = [_]u32{ 1, 2, 3, 4, 5, 10, 100, 1_000, 10_000 };
|
const lens = [_]u32{ 1, 2, 3, 4, 5, 10, 100, 1_000, 10_000 };
|
||||||
|
|||||||
Reference in New Issue
Block a user