Compare commits
21
Commits
b02665fe89
..
0.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
 adrien
|
49b56bda91 | ||
|
adrien
|
76c69448de | ||
|
adrien
|
cb3c41cf4c | ||
|
adrien
|
5f42a8c107 | ||
|
adrien
|
1719b0de8b | ||
|
adrien
|
84d0698878 | ||
|
adrien
|
11a741f72c | ||
|
adrien
|
cc39c1a6f4 | ||
|
adrien
|
d96a1ac4bc | ||
|
adrien
|
fb922e3d5c | ||
|
adrien
|
1fd86a5807 | ||
|
adrien
|
a518a86fb2 | ||
|
adrien
|
8a22788a2e | ||
|
adrien
|
b9647e0426 | ||
|
adrien
|
cb51afe79c | ||
|
adrien
|
732bf11005 | ||
|
adrien
|
46380a95da | ||
|
adrien
|
aa46cef978 | ||
|
adrien
|
01c5b50b95 | ||
|
adrien
|
bbab41008f | ||
|
adrien
|
aa09054c4d |
@@ -1,268 +1,233 @@
|
|||||||
# zig_units
|
# dimal — Dimensional Analysis for Zig
|
||||||
|
|
||||||
`zig_units` lets you attach physical units to numeric values so that dimension mismatches (like adding distance to time) become **compile errors** rather than silent bugs.
|
A comptime-first dimensional analysis module for Zig. If you try to add meters to seconds, **it won't compile**. That's the point.
|
||||||
|
|
||||||
At runtime, a `Quantity` is just its underlying numeric value — **zero memory overhead.**
|
Born from 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.
|
||||||
|
|
||||||
```zig
|
> **Source:** [git.bouvais.lu/adrien/zig-dimal](https://git.bouvais.lu/adrien/zig-dimal)
|
||||||
const velocity = distance.divBy(time); // Result type: L¹T⁻¹ ✓
|
> **Minimum Zig version:** `0.16.0`
|
||||||
const error = mass.add(velocity); // COMPILE ERROR: M¹ != L¹T⁻¹
|
|
||||||
```
|
|
||||||
|
|
||||||
**Requirements:** Zig `0.16.0`
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **100% comptime** — all dimension and unit tracking happens at compile time. No added memory, *almost* native performance.
|
||||||
|
- **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.
|
||||||
|
- **Full SI prefix support** — `pico`, `nano`, `micro`, `milli`, `centi`, `deci`, `kilo`, `mega`, `giga`, `tera`, `peta`, and more.
|
||||||
|
- **Time scale support** — `min`, `hour`, `year` built in.
|
||||||
|
- **Scalar and Vector types** — operate on individual values or fixed-size arrays with the same dimensional safety.
|
||||||
|
- **Built-in physical quantities** — `dma.Base` provides ready-made types for `Velocity`, `Acceleration`, `Force`, `Energy`, `Pressure`, `ElectricCharge`, `ThermalConductivity`, and many more.
|
||||||
|
- **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.
|
||||||
|
- **Tests and benchmarks included** — run them and see how it performs on your machine (results welcome!).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## The 7 SI Base Dimensions
|
||||||
|
|
||||||
|
| Symbol | Dimension | SI Unit |
|
||||||
|
|--------|----------------------|----------|
|
||||||
|
| `L` | Length | `m` |
|
||||||
|
| `M` | Mass | `g` |
|
||||||
|
| `T` | Time | `s` |
|
||||||
|
| `I` | Electric Current | `A` |
|
||||||
|
| `Tp` | Temperature | `K` |
|
||||||
|
| `N` | Amount of Substance | `mol` |
|
||||||
|
| `J` | Luminous Intensity | `cd` |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### 1. Add as a Zig dependency
|
### 1. Fetch the dependency
|
||||||
```bash
|
|
||||||
zig fetch --save https://github.com/YOUR_USERNAME/zig_units/archive/refs/heads/main.tar.gz
|
```sh
|
||||||
|
zig fetch --save git+https://git.bouvais.lu/adrien/zig-dimal#b9647e04266e3f395cfd26b41622b0c119a1e5be
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Configure `build.zig`
|
This will add the following to your `build.zig.zon` automatically:
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const zig_units = b.dependency("zig_units", .{
|
.dependencies = .{
|
||||||
.target = target,
|
.dimal = .{
|
||||||
.optimize = optimize,
|
.url = "git+https://git.bouvais.lu/adrien/zig-dimal#b9647e04266e3f395cfd26b41622b0c119a1e5be",
|
||||||
});
|
.hash = "dimal-0.1.0-WNhSHvomAQAX1ISvq9ZBal-Gam6078y8hE67aC82l63V",
|
||||||
// Add to your module or executable
|
},
|
||||||
exe.root_module.addImport("units", zig_units.module("zig_units"));
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
### 2. Wire it up in `build.zig`
|
||||||
|
|
||||||
## Quick Start: Using Predefined Quantities
|
|
||||||
|
|
||||||
`units.Base` provides a clean way to instantiate common physical types without manually defining dimensions.
|
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
const units = @import("units");
|
|
||||||
|
|
||||||
pub fn main() !void {
|
pub fn build(b: *std.Build) void {
|
||||||
// Instantiate types for f32 backing
|
const target = b.standardTargetOptions(.{});
|
||||||
const Meter = units.Base.Meter.Of(f32);
|
const dimal = b.dependency("dimal", .{}).module("dimal");
|
||||||
const Second = units.Base.Second.Of(f32);
|
|
||||||
|
|
||||||
const dist = Meter{ .value = 10.0 };
|
const exe = b.addExecutable(.{
|
||||||
const time = Second{ .value = 2.0 };
|
.name = "my_project",
|
||||||
|
.root_module = b.createModule(.{
|
||||||
// Arithmetic is type-safe and creates the correct resulting dimension
|
.root_source_file = b.path("src/main.zig"),
|
||||||
const vel = dist.divBy(time); // Type is Velocity (L/T)
|
.target = target,
|
||||||
|
.imports = &.{.{
|
||||||
std.debug.print("Speed: {f}\n", .{vel}); // Output: 5m.s⁻¹
|
.name = "dimal",
|
||||||
|
.module = dimal,
|
||||||
|
}},
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
b.installArtifact(exe);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
### 3. Import in your code
|
||||||
|
|
||||||
### Core Arithmetic Operations
|
|
||||||
|
|
||||||
Dimensional analysis is handled entirely at compile-time. If the math doesn't make physical sense, it won't compile.
|
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const M = units.Base.Meter.Of(f32);
|
const dma = @import("dimal");
|
||||||
const S = units.Base.Second.Of(f32);
|
const Scalar = dma.Scalar;
|
||||||
|
const Dimensions = dma.Dimensions;
|
||||||
const dist = M{ .value = 100.0 };
|
const Scales = dma.Scales;
|
||||||
const time = S{ .value = 5.0 };
|
|
||||||
|
|
||||||
// 1. Addition & Subtraction (Must have same dimensions)
|
|
||||||
const two_dist = dist.add(dist); // 200.0m
|
|
||||||
const zero = dist.sub(dist); // 0.0m
|
|
||||||
|
|
||||||
// 2. Division (Subtracts dimension exponents)
|
|
||||||
// Result: Velocity (L¹ T⁻¹)
|
|
||||||
const vel = dist.divBy(time); // 20.0 m.s⁻¹
|
|
||||||
|
|
||||||
// 3. Multiplication (Adds dimension exponents)
|
|
||||||
// Result: Area (L²)
|
|
||||||
const area = dist.mulBy(dist); // 100.0 m²
|
|
||||||
|
|
||||||
// 4. Chained Operations
|
|
||||||
// Result: Acceleration (L¹ T⁻²)
|
|
||||||
const accel = dist.divBy(time).divBy(time); // 4.0 m.s⁻²
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Defining Custom Quantities
|
## Quick Start
|
||||||
|
|
||||||
You aren't limited to the built-in library. You can define any physical quantity by specifying its **Dimensions**
|
### Defining unit types
|
||||||
(powers of base units) and its **Scale** (SI prefixes).
|
|
||||||
|
|
||||||
### 1. Create a custom dimension
|
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).
|
||||||
Dimensions are defined by 7 base SI units: `L` (Length), `M` (Mass), `T` (Time), `I` (Current), `Tp` (Temp), `N` (Substance), `J` (Intensity).
|
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const Dims = units.Dimensions;
|
const Meter = Scalar(f64, .init(.{ .L = 1 }), .init(.{}));
|
||||||
const Scales = units.Scales;
|
const NanoMeter = Scalar(i64, .init(.{ .L = 1 }), .init(.{ .L = .n }));
|
||||||
|
const KiloMeter = Scalar(f64, .init(.{ .L = 1 }), .init(.{ .L = .k }));
|
||||||
// Frequency is T⁻¹
|
const Second = Scalar(f64, .init(.{ .T = 1 }), .init(.{}));
|
||||||
const FreqDims = Dims.init(.{ .T = -1 });
|
const Velocity = Scalar(f64, .init(.{ .L = 1, .T = -1 }), .init(.{}));
|
||||||
|
const Kmh = Scalar(f64, .init(.{ .L = 1, .T = -1 }), .init(.{ .L = .k, .T = .hour }));
|
||||||
// Force is M¹ L¹ T⁻²
|
|
||||||
const ForceDims = Dims.init(.{ .M = 1, .L = 1, .T = -2 });
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Create a custom Type
|
Or use the pre-built helpers from `dma.Base`:
|
||||||
Combine a numeric type, the dimensions, and a scale.
|
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const Hertz = units.Quantity(f32, FreqDims, Scales.init(.{}));
|
const Acceleration = dma.Base.Acceleration.Of(f64);
|
||||||
|
const KmhSpeed = dma.Base.Speed.Scaled(f64, Scales.init(.{ .L = .k, .T = .hour }));
|
||||||
// A specialized scale: Millimeters per Second Squared
|
|
||||||
const MmPerSecSq = units.Quantity(f32,
|
|
||||||
Dims.init(.{ .L = 1, .T = -2 }),
|
|
||||||
Scales.init(.{ .L = .m }) // .m = milli
|
|
||||||
);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Kinematics example
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const v0 = Velocity{ .value = 10.0 }; // 10 m/s
|
||||||
|
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.mulBy(time); // → Meter
|
||||||
|
const d2 = accel.mulBy(time.mulBy(time)).scale(0.5); // → Meter
|
||||||
|
const dist = d1.add(d2);
|
||||||
|
|
||||||
|
const v_final = v0.add(accel.mulBy(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"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Working with Vectors
|
||||||
|
|
||||||
|
Every `Scalar` type exposes a `.Vec3` and a generic `.Vec(n)`:
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const Vec3Meter = Meter.Vec3; // or: Vector(3, Meter)
|
||||||
|
|
||||||
|
const pos = Vec3Meter{ .data = .{ 100, 200, 300 } };
|
||||||
|
const t = Second{ .value = 10 };
|
||||||
|
|
||||||
|
const vel = pos.divByScalar(t); // → Vec3 of Velocity (m/s)
|
||||||
|
|
||||||
|
std.debug.print("{d}\n", .{vel}); // (10, 20, 30)m.s⁻¹
|
||||||
|
```
|
||||||
|
|
||||||
|
Vectors support: `add`, `sub`, `mulBy`, `divBy`, `mulByScalar`, `divByScalar`, `negate`, `to`, `length`, `lengthSqr`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Unit Conversions
|
## API Reference
|
||||||
|
|
||||||
The library handles SI prefixes (`k`, `m`, `u`, `n`, etc.) and time aliases (`.min`, `.hour`) automatically.
|
### `Scalar(T, dims, scales)`
|
||||||
When performing arithmetic between different scales, the **finer (smaller) scale wins** to preserve precision.
|
|
||||||
|
|
||||||
```zig
|
| Method | Description |
|
||||||
const KM = units.Base.Meter.Scaled(f32, Scales.init(.{ .L = .k })); // Kilometers
|
|---|---|
|
||||||
const M = units.Base.Meter.Of(f32); // Meters
|
| `.add(rhs)` | Add two quantities of the same dimension. Auto-converts scales. |
|
||||||
|
| `.sub(rhs)` | Subtract. Auto-converts scales. |
|
||||||
|
| `.mulBy(rhs)` | Multiply — dimensions are **summed**. `m * s⁻¹` → `m·s⁻¹`. |
|
||||||
|
| `.divBy(rhs)` | Divide — dimensions are **subtracted**. `m / s` → `m·s⁻¹`. |
|
||||||
|
| `.to(DestType)` | Convert to another unit of the same dimension. Compile error on mismatch. |
|
||||||
|
| `.vec3()` | Wrap the value in a `Vec3` of the same type. |
|
||||||
|
| `.Vec(n)` | Get the `Vector(n, Self)` type. |
|
||||||
|
|
||||||
const d1 = KM{ .value = 1.2 }; // 1.2 km
|
### `dma.Base` — Pre-built quantities
|
||||||
const d2 = M{ .value = 300.0 }; // 300 m
|
|
||||||
|
|
||||||
const total = d1.add(d2); // Result is 1500.0 (Meters)
|
A selection of what's available (call `.Of(T)` for base units, `.Scaled(T, scales)` for custom scales):
|
||||||
const final = total.to(KM); // Explicitly convert back to KM -> 1.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.
|
||||||
|
|
||||||
|
### `Scales` — SI prefixes
|
||||||
|
|
||||||
|
| Tag | Factor |
|
||||||
|
|---|---|
|
||||||
|
| `.P` | 10¹⁵ |
|
||||||
|
| `.T` | 10¹² |
|
||||||
|
| `.G` | 10⁹ |
|
||||||
|
| `.M` | 10⁶ |
|
||||||
|
| `.k` | 10³ |
|
||||||
|
| `.none` | 1 |
|
||||||
|
| `.c` | 10⁻² |
|
||||||
|
| `.m` | 10⁻³ |
|
||||||
|
| `.u` | 10⁻⁶ |
|
||||||
|
| `.n` | 10⁻⁹ |
|
||||||
|
| `.p` | 10⁻¹² |
|
||||||
|
| `.f` | 10⁻¹⁵ |
|
||||||
|
| `.min` | 60 |
|
||||||
|
| `.hour` | 3600 |
|
||||||
|
| `.year` | 31 536 000 |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Physical Vectors (Vec3)
|
## Running Tests and Benchmarks
|
||||||
|
|
||||||
Physical quantities often come in 3D vectors (Position, Velocity, Force). Every `Quantity` type has a `.Vec3` alias built-in.
|
```sh
|
||||||
|
|
||||||
```zig
|
|
||||||
const Vec3M = units.Base.Meter.Of(f32).Vec3;
|
|
||||||
|
|
||||||
const gravity = Vec3M{ .data = .{ 0, -9.81, 0 } };
|
|
||||||
const pos = Vec3M.initDefault(0); // [0, 0, 0]
|
|
||||||
|
|
||||||
// Vectors support standard operations
|
|
||||||
const length = gravity.length(); // Returns f32: 9.81
|
|
||||||
const double = gravity.scale(2.0);
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also create a Vector of any length.
|
|
||||||
Vec3 found in a Quantity is just a convenience.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const M = units.Base.Meter.Of(f32);
|
|
||||||
const Vec10M = units.QuantityVec(10, Meter);
|
|
||||||
|
|
||||||
const gravity = Vec10M.initDefault(1);
|
|
||||||
const length = gravity.length(); // Returns f32: 1.0
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## High Precision & Integer Backing
|
|
||||||
|
|
||||||
While most libraries default to `f32` or `f64`, `zig_units` is mainly designed to support **large-bit integers (`i128`, `i256`)**.
|
|
||||||
|
|
||||||
This is critical for applications like **space simulations**, where floating-point numbers suffer from "jitter" or "flickering"
|
|
||||||
once you travel far from the origin. By using an `i128` with a millimeter scale, you can represent the diameter
|
|
||||||
of the observable universe with millimeter precision—something impossible with `f64`.
|
|
||||||
|
|
||||||
### Avoiding Floating-Point Jitter
|
|
||||||
```zig
|
|
||||||
// Millimeter precision using 128-bit integers
|
|
||||||
const MM = units.Base.Meter.Scaled(i128, units.Scales.init(.{ .L = .m }));
|
|
||||||
const KM = units.Base.Meter.Scaled(i128, units.Scales.init(.{ .L = .k }));
|
|
||||||
|
|
||||||
const solar_system_dist = KM{ .value = 150_000_000 }; // 150 million km
|
|
||||||
const ship_nudge = MM{ .value = 5 }; // 5 mm
|
|
||||||
|
|
||||||
// The library performs exact integer math for conversions.
|
|
||||||
// Resulting type is MM (the finer scale), maintaining perfect precision.
|
|
||||||
const new_pos = solar_system_dist.add(ship_nudge);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Integer-Specific Features
|
|
||||||
* **Exact Conversions:** When converting between integer scales (e.g., `km` to `m`), the library uses fast-path native multiplication.
|
|
||||||
* **Safe Vector Lengths:** `QuantityVec.length()` includes a custom integer square root implementation, allowing you to calculate distances between coordinates without ever casting to a float.
|
|
||||||
* **Zero Drift:** Unlike floats, repeated additions and subtractions of integers never accumulate "epsilon" drift, ensuring your simulation remains deterministic.
|
|
||||||
* **Precision-First Scaling:** When operating on two different scales (e.g., adding `km` and `mm`), the result automatically adopts the finer scale (`mm`). This ensures **zero implicit data loss** during calculation. You only lose precision if you *explicitly* choose to convert back to a coarser scale using `.to()`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## SI Scales Reference
|
|
||||||
|
|
||||||
| Prefix | Enum | Factor |
|
|
||||||
| :--- | :--- | :--- |
|
|
||||||
| **Kilo** | `.k` | 10³ |
|
|
||||||
| **Mega** | `.M` | 10⁶ |
|
|
||||||
| **Giga** | `.G` | 10⁹ |
|
|
||||||
| **Milli** | `.m` | 10⁻³ |
|
|
||||||
| **Micro** | `.u` | 10⁻⁶ |
|
|
||||||
| **Minute**| `.min` | 60 |
|
|
||||||
| **Hour** | `.hour`| 3,600 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## API Summary
|
|
||||||
|
|
||||||
### `Quantity(T, dims, scales)`
|
|
||||||
- `.add(rhs)` / `.sub(rhs)`: Automatic scaling, requires same dimensions.
|
|
||||||
- `.mulBy(rhs)` / `.divBy(rhs)`: Composes dimensions (e.g., $L \times L = L^2$).
|
|
||||||
- `.scale(scalar)`: Multiply by a raw number (preserves dimensions).
|
|
||||||
- `.to(OtherType)`: Safely convert between scales of the same dimension.
|
|
||||||
- `.vec3()`: Create a 3D vector from a scalar.
|
|
||||||
|
|
||||||
### `Dimensions`
|
|
||||||
- `L`: Length (m)
|
|
||||||
- `M`: Mass (g)
|
|
||||||
- `T`: Time (s)
|
|
||||||
- `I`: Current (A)
|
|
||||||
- `Tp`: Temperature (K)
|
|
||||||
- `N`: Amount (mol)
|
|
||||||
- `J`: Intensity (cd)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Testing & Benchmarks
|
|
||||||
|
|
||||||
`zig_units` comes with a comprehensive test suite that verifies dimensional correctness, SI prefix scaling,
|
|
||||||
and vector math accuracy across all numeric types.
|
|
||||||
|
|
||||||
### Running Tests
|
|
||||||
To run the full suite of unit tests and performance benchmarks:
|
|
||||||
```bash
|
|
||||||
zig build test
|
zig build test
|
||||||
|
zig build benchmark
|
||||||
```
|
```
|
||||||
|
|
||||||
### Benchmarks
|
Benchmark results are very welcome — feel free to share yours!
|
||||||
When you run the tests, the library also executes a performance benchmark.
|
|
||||||
This measures the cost of operations (in nanoseconds per operation) across different backing types (`i32` to `f128`) and vector lengths.
|
|
||||||
|
|
||||||
Because all dimensional logic is resolved at **compile-time**, you will see that `Quantity` operations perform at the same speed as raw primitive math.
|
---
|
||||||
|
|
||||||
**Example Benchmark Output:**
|
## Roadmap / Known Limitations
|
||||||
```text
|
|
||||||
Quantity<T> benchmark — 100,000 iterations, 10 samples/cell
|
|
||||||
|
|
||||||
┌───────────────────┬──────┬─────────────────────┬─────────────────────┐
|
- More operations beyond `add`, `sub`, `mulBy`, `divBy` (e.g. `pow`, `sqrt`).
|
||||||
│ Operation │ Type │ ns / op (± delta) │ Throughput (ops/s) │
|
- SIMD acceleration for `Vector` operations.
|
||||||
├───────────────────┼──────┼─────────────────────┼─────────────────────┤
|
- Some paths may still fall back to runtime computation — optimization ongoing.
|
||||||
│ add │ i32 │ 0.18 ns ±0.02 │ 5555555556 │
|
- More test coverage.
|
||||||
│ mulBy │ f64 │ 0.22 ns ±0.01 │ 4545454545 │
|
|
||||||
└───────────────────┴──────┴─────────────────────┴─────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### Verification Examples
|
---
|
||||||
The test suite ensures that:
|
|
||||||
- **Dimension Safety:** Chained operations like `dist.divBy(time).divBy(time)` correctly result in an Acceleration type.
|
## License
|
||||||
- **Scale Accuracy:** Adding `1km + 1mm` results exactly in `1000001mm` without truncation.
|
|
||||||
- **Formatting:** Quantities print correctly with Unicode superscripts (e.g., `9.81m.s⁻²`).
|
See the repository for license details.
|
||||||
- **Vector Math:** Euclidean lengths for both floats and integers are verified against known constants.
|
|
||||||
|
|||||||
@@ -2,40 +2,38 @@ 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(.{ .preferred_optimize_mode = .ReleaseSmall });
|
const optimize = b.standardOptimizeOption(.{});
|
||||||
const exe = b.addExecutable(.{
|
|
||||||
.name = "Zig_Units",
|
// 1. Define the module so other projects can import it
|
||||||
|
_ = b.addModule("dimal", .{
|
||||||
|
.root_source_file = b.path("src/main.zig"),
|
||||||
|
});
|
||||||
|
|
||||||
|
const exe_tests = b.addTest(.{
|
||||||
.root_module = b.createModule(.{
|
.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,
|
.optimize = optimize,
|
||||||
|
}),
|
||||||
|
.test_runner = .{ .path = b.path("test_runner.zig"), .mode = .simple },
|
||||||
|
});
|
||||||
|
|
||||||
|
const run_exe_tests = b.addRunArtifact(exe_tests);
|
||||||
|
const test_step = b.step("test", "Run tests");
|
||||||
|
test_step.dependOn(&run_exe_tests.step);
|
||||||
|
|
||||||
|
const bench_exe = b.addExecutable(.{
|
||||||
|
.name = "benchmark",
|
||||||
|
.root_module = b.createModule(.{
|
||||||
|
.root_source_file = b.path("src/benchmark.zig"),
|
||||||
|
.target = target,
|
||||||
.imports = &.{},
|
.imports = &.{},
|
||||||
}),
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
b.installArtifact(exe);
|
b.installArtifact(bench_exe);
|
||||||
const run_step = b.step("run", "Run the app");
|
|
||||||
|
|
||||||
const run_cmd = b.addRunArtifact(exe);
|
const run_bench = b.addRunArtifact(bench_exe);
|
||||||
run_step.dependOn(&run_cmd.step);
|
const bench_step = b.step("benchmark", "Run the benchmark suite");
|
||||||
|
bench_step.dependOn(&run_bench.step);
|
||||||
run_cmd.step.dependOn(b.getInstallStep());
|
|
||||||
|
|
||||||
if (b.args) |args| {
|
|
||||||
run_cmd.addArgs(args);
|
|
||||||
}
|
|
||||||
|
|
||||||
const exe_tests = b.addTest(.{
|
|
||||||
.root_module = exe.root_module,
|
|
||||||
.test_runner = .{
|
|
||||||
.path = .{ .cwd_relative = "test_runner.zig" },
|
|
||||||
.mode = .simple,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
// A run step that will run the second test executable.
|
|
||||||
const run_exe_tests = b.addRunArtifact(exe_tests);
|
|
||||||
|
|
||||||
const test_step = b.step("test", "Run tests");
|
|
||||||
test_step.dependOn(&run_exe_tests.step);
|
|
||||||
}
|
}
|
||||||
|
|||||||
+5
-73
@@ -1,81 +1,13 @@
|
|||||||
.{
|
.{
|
||||||
// This is the default name used by packages depending on this one. For
|
.name = .dimal,
|
||||||
// example, when a user runs `zig fetch --save <url>`, this field is used
|
.version = "0.1.0",
|
||||||
// as the key in the `dependencies` table. Although the user can choose a
|
.fingerprint = 0x9453b1ff1e52d858,
|
||||||
// different name, most users will stick with this provided value.
|
|
||||||
//
|
|
||||||
// It is redundant to include "zig" in this name because it is already
|
|
||||||
// within the Zig package namespace.
|
|
||||||
.name = .Zig_Units,
|
|
||||||
// This is a [Semantic Version](https://semver.org/).
|
|
||||||
// In a future version of Zig it will be used for package deduplication.
|
|
||||||
.version = "0.0.0",
|
|
||||||
// Together with name, this represents a globally unique package
|
|
||||||
// identifier. This field is generated by the Zig toolchain when the
|
|
||||||
// package is first created, and then *never changes*. This allows
|
|
||||||
// unambiguous detection of one package being an updated version of
|
|
||||||
// another.
|
|
||||||
//
|
|
||||||
// When forking a Zig project, this id should be regenerated (delete the
|
|
||||||
// field and run `zig build`) if the upstream project is still maintained.
|
|
||||||
// Otherwise, the fork is *hostile*, attempting to take control over the
|
|
||||||
// original project's identity. Thus it is recommended to leave the comment
|
|
||||||
// on the following line intact, so that it shows up in code reviews that
|
|
||||||
// modify the field.
|
|
||||||
.fingerprint = 0x934b00cf88f69b22, // Changing this has security and trust implications.
|
|
||||||
// Tracks the earliest Zig version that the package considers to be a
|
|
||||||
// supported use case.
|
|
||||||
.minimum_zig_version = "0.16.0",
|
.minimum_zig_version = "0.16.0",
|
||||||
// This field is optional.
|
.dependencies = .{},
|
||||||
// Each dependency must either provide a `url` and `hash`, or a `path`.
|
|
||||||
// `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
|
|
||||||
// Once all dependencies are fetched, `zig build` no longer requires
|
|
||||||
// internet connectivity.
|
|
||||||
.dependencies = .{
|
|
||||||
// See `zig fetch --save <url>` for a command-line interface for adding dependencies.
|
|
||||||
//.example = .{
|
|
||||||
// // When updating this field to a new URL, be sure to delete the corresponding
|
|
||||||
// // `hash`, otherwise you are communicating that you expect to find the old hash at
|
|
||||||
// // the new URL. If the contents of a URL change this will result in a hash mismatch
|
|
||||||
// // which will prevent zig from using it.
|
|
||||||
// .url = "https://example.com/foo.tar.gz",
|
|
||||||
//
|
|
||||||
// // This is computed from the file contents of the directory of files that is
|
|
||||||
// // obtained after fetching `url` and applying the inclusion rules given by
|
|
||||||
// // `paths`.
|
|
||||||
// //
|
|
||||||
// // This field is the source of truth; packages do not come from a `url`; they
|
|
||||||
// // come from a `hash`. `url` is just one of many possible mirrors for how to
|
|
||||||
// // obtain a package matching this `hash`.
|
|
||||||
// //
|
|
||||||
// // Uses the [multihash](https://multiformats.io/multihash/) format.
|
|
||||||
// .hash = "...",
|
|
||||||
//
|
|
||||||
// // When this is provided, the package is found in a directory relative to the
|
|
||||||
// // build root. In this case the package's hash is irrelevant and therefore not
|
|
||||||
// // computed. This field and `url` are mutually exclusive.
|
|
||||||
// .path = "foo",
|
|
||||||
//
|
|
||||||
// // When this is set to `true`, a package is declared to be lazily
|
|
||||||
// // fetched. This makes the dependency only get fetched if it is
|
|
||||||
// // actually used.
|
|
||||||
// .lazy = false,
|
|
||||||
//},
|
|
||||||
},
|
|
||||||
// Specifies the set of files and directories that are included in this package.
|
|
||||||
// Only files and directories listed here are included in the `hash` that
|
|
||||||
// is computed for this package. Only files listed here will remain on disk
|
|
||||||
// when using the zig package manager. As a rule of thumb, one should list
|
|
||||||
// files required for compilation plus any license(s).
|
|
||||||
// Paths are relative to the build root. Use the empty string (`""`) to refer to
|
|
||||||
// the build root itself.
|
|
||||||
// A directory listed here means that all files within, recursively, are included.
|
|
||||||
.paths = .{
|
.paths = .{
|
||||||
"build.zig",
|
"build.zig",
|
||||||
"build.zig.zon",
|
"build.zig.zon",
|
||||||
"src",
|
"src",
|
||||||
// For example...
|
"test_runner.zig",
|
||||||
//"LICENSE",
|
|
||||||
//"README.md",
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,95 +3,97 @@ const std = @import("std");
|
|||||||
// Adjust these imports to match your actual file names
|
// Adjust these imports to match your actual file names
|
||||||
const Dimensions = @import("Dimensions.zig");
|
const Dimensions = @import("Dimensions.zig");
|
||||||
const Scales = @import("Scales.zig");
|
const Scales = @import("Scales.zig");
|
||||||
const Quantity = @import("Quantity.zig").Quantity;
|
const Scalar = @import("Scalar.zig").Scalar;
|
||||||
|
|
||||||
/// Helper function to create a clean namespace for each physical dimension.
|
/// Helper function to create a clean namespace for each physical dimension.
|
||||||
/// It exposes the raw dimensions, and easy type-creators for Base or Scaled variants.
|
/// It exposes the raw dimensions, and easy type-creators for Base or Scaled variants.
|
||||||
pub fn QtyNamespace(comptime d: anytype) type {
|
pub fn BaseScalar(comptime d: anytype) type {
|
||||||
return struct {
|
return struct {
|
||||||
pub const dims = Dimensions.init(d);
|
pub const dims = Dimensions.init(d);
|
||||||
|
|
||||||
/// Creates a Quantity of this dimension using default scales.
|
/// Creates a Scalar of this dimension using default scales.
|
||||||
/// Example: const V = Quantities.Velocity.Base(f32);
|
/// Example: const V = Quantities.Velocity.Base(f32);
|
||||||
pub fn Of(comptime T: type) type {
|
pub fn Of(comptime T: type) type {
|
||||||
return Quantity(T, dims, Scales.init(.{}));
|
return Scalar(T, dims, Scales.init(.{}));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Creates a Quantity of this dimension using custom scales.
|
/// Creates a Scalar of this dimension using custom scales.
|
||||||
/// Example: const Kmh = Quantities.Velocity.Scaled(f32, Scales.init(.{ .L = .k, .T = .hour }));
|
/// Example: const Kmh = Quantities.Velocity.Scaled(f32, Scales.init(.{ .L = .k, .T = .hour }));
|
||||||
pub fn Scaled(comptime T: type, comptime s: Scales) type {
|
pub fn Scaled(comptime T: type, comptime s: Scales) type {
|
||||||
return Quantity(T, dims, s);
|
return Scalar(T, dims, s);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub const Dimless = BaseScalar(.{});
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Base Quantities
|
// Base Quantities
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const Meter = QtyNamespace(.{ .L = 1 });
|
pub const Meter = BaseScalar(.{ .L = 1 });
|
||||||
pub const Second = QtyNamespace(.{ .T = 1 });
|
pub const Second = BaseScalar(.{ .T = 1 });
|
||||||
pub const Gramm = QtyNamespace(.{ .M = 1 });
|
pub const Gramm = BaseScalar(.{ .M = 1 });
|
||||||
pub const Kelvin = QtyNamespace(.{ .Tr = 1 });
|
pub const Kelvin = BaseScalar(.{ .Tr = 1 });
|
||||||
pub const ElectricCurrent = QtyNamespace(.{ .I = 1 });
|
pub const ElectricCurrent = BaseScalar(.{ .I = 1 });
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Electric
|
// Electric
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const ElectricConductivity = QtyNamespace(.{ .M = -1, .L = -3, .T = 3, .I = 2 });
|
pub const ElectricConductivity = BaseScalar(.{ .M = -1, .L = -3, .T = 3, .I = 2 });
|
||||||
pub const ElectricCharge = QtyNamespace(.{ .T = 1, .I = 1 });
|
pub const ElectricCharge = BaseScalar(.{ .T = 1, .I = 1 });
|
||||||
pub const ElectricPotential = QtyNamespace(.{ .T = -3, .L = 2, .M = 1, .I = -1 });
|
pub const ElectricPotential = BaseScalar(.{ .T = -3, .L = 2, .M = 1, .I = -1 });
|
||||||
pub const ElectricResistance = QtyNamespace(.{ .M = 1, .L = 2, .T = -3, .I = -2 });
|
pub const ElectricResistance = BaseScalar(.{ .M = 1, .L = 2, .T = -3, .I = -2 });
|
||||||
pub const ElectricResistivity = QtyNamespace(.{ .M = 1, .L = 3, .T = -3, .I = -2 });
|
pub const ElectricResistivity = BaseScalar(.{ .M = 1, .L = 3, .T = -3, .I = -2 });
|
||||||
pub const ElectricCapacitance = QtyNamespace(.{ .T = 4, .L = -2, .M = -1, .I = 2 });
|
pub const ElectricCapacitance = BaseScalar(.{ .T = 4, .L = -2, .M = -1, .I = 2 });
|
||||||
pub const ElectricImpedance = ElectricResistance;
|
pub const ElectricImpedance = ElectricResistance;
|
||||||
pub const MagneticFlux = QtyNamespace(.{ .M = 1, .L = 2, .T = -2, .I = -1 });
|
pub const MagneticFlux = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .I = -1 });
|
||||||
pub const MagneticDensity = QtyNamespace(.{ .M = 1, .T = -2, .I = -1 });
|
pub const MagneticDensity = BaseScalar(.{ .M = 1, .T = -2, .I = -1 });
|
||||||
pub const MagneticStrength = QtyNamespace(.{ .L = -1, .I = 1 }); // Fixed typo from MagneticStrengh
|
pub const MagneticStrength = BaseScalar(.{ .L = -1, .I = 1 }); // Fixed typo from MagneticStrengh
|
||||||
pub const MagneticMoment = QtyNamespace(.{ .L = 2, .I = 1 });
|
pub const MagneticMoment = BaseScalar(.{ .L = 2, .I = 1 });
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Movement
|
// Movement
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const Velocity = QtyNamespace(.{ .L = 1, .T = -1 });
|
pub const Speed = BaseScalar(.{ .L = 1, .T = -1 });
|
||||||
pub const Acceleration = QtyNamespace(.{ .L = 1, .T = -2 });
|
pub const Acceleration = BaseScalar(.{ .L = 1, .T = -2 });
|
||||||
pub const Inertia = QtyNamespace(.{ .M = 1, .L = 2 });
|
pub const Inertia = BaseScalar(.{ .M = 1, .L = 2 });
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Forces / Energy
|
// Forces / Energy
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const Force = QtyNamespace(.{ .T = -2, .M = 1, .L = 1 });
|
pub const Force = BaseScalar(.{ .T = -2, .M = 1, .L = 1 });
|
||||||
pub const Pressure = QtyNamespace(.{ .T = -2, .L = -1, .M = 1 });
|
pub const Pressure = BaseScalar(.{ .T = -2, .L = -1, .M = 1 });
|
||||||
pub const Energy = QtyNamespace(.{ .T = -2, .L = 2, .M = 1 });
|
pub const Energy = BaseScalar(.{ .T = -2, .L = 2, .M = 1 });
|
||||||
pub const Power = QtyNamespace(.{ .T = -3, .L = 2, .M = 1 });
|
pub const Power = BaseScalar(.{ .T = -3, .L = 2, .M = 1 });
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Dimension
|
// Dimension
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const Area = QtyNamespace(.{ .L = 2 });
|
pub const Area = BaseScalar(.{ .L = 2 });
|
||||||
pub const Volume = QtyNamespace(.{ .L = 3 });
|
pub const Volume = BaseScalar(.{ .L = 3 });
|
||||||
pub const AreaDensity = QtyNamespace(.{ .M = 1, .L = -2 });
|
pub const AreaDensity = BaseScalar(.{ .M = 1, .L = -2 });
|
||||||
pub const Density = QtyNamespace(.{ .M = 1, .L = -3 });
|
pub const Density = BaseScalar(.{ .M = 1, .L = -3 });
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Thermal
|
// Thermal
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const ThermalHeat = Energy;
|
pub const ThermalHeat = Energy;
|
||||||
pub const ThermalWork = Energy;
|
pub const ThermalWork = Energy;
|
||||||
pub const ThermalCapacity = QtyNamespace(.{ .M = 1, .L = 2, .T = -2, .Tr = -1 });
|
pub const ThermalCapacity = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .Tr = -1 });
|
||||||
pub const ThermalCapacityPerMass = QtyNamespace(.{ .L = 2, .T = -2, .Tr = -1 });
|
pub const ThermalCapacityPerMass = BaseScalar(.{ .L = 2, .T = -2, .Tr = -1 });
|
||||||
pub const ThermalFluxDensity = QtyNamespace(.{ .M = 1, .T = -3 }); // Fixed typo from ThermalluxDensity
|
pub const ThermalFluxDensity = BaseScalar(.{ .M = 1, .T = -3 }); // Fixed typo from ThermalluxDensity
|
||||||
pub const ThermalConductance = QtyNamespace(.{ .M = 1, .L = 2, .T = -3, .Tr = -1 });
|
pub const ThermalConductance = BaseScalar(.{ .M = 1, .L = 2, .T = -3, .Tr = -1 });
|
||||||
pub const ThermalConductivity = QtyNamespace(.{ .M = 1, .L = 1, .T = -3, .Tr = -1 });
|
pub const ThermalConductivity = BaseScalar(.{ .M = 1, .L = 1, .T = -3, .Tr = -1 });
|
||||||
pub const ThermalResistance = QtyNamespace(.{ .M = -1, .L = -2, .T = 3, .Tr = 1 });
|
pub const ThermalResistance = BaseScalar(.{ .M = -1, .L = -2, .T = 3, .Tr = 1 });
|
||||||
pub const ThermalResistivity = QtyNamespace(.{ .M = -1, .L = -1, .T = 3, .Tr = 1 });
|
pub const ThermalResistivity = BaseScalar(.{ .M = -1, .L = -1, .T = 3, .Tr = 1 });
|
||||||
pub const ThermalEntropy = QtyNamespace(.{ .M = 1, .L = 2, .T = -2, .Tr = -1 });
|
pub const ThermalEntropy = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .Tr = -1 });
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Others
|
// Others
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const Frequency = QtyNamespace(.{ .T = -1 });
|
pub const Frequency = BaseScalar(.{ .T = -1 });
|
||||||
pub const Viscosity = QtyNamespace(.{ .M = 1, .L = -1, .T = -1 });
|
pub const Viscosity = BaseScalar(.{ .M = 1, .L = -1, .T = -1 });
|
||||||
pub const SurfaceTension = QtyNamespace(.{ .M = 1, .T = -2 }); // Corrected from MT-2a
|
pub const SurfaceTension = BaseScalar(.{ .M = 1, .T = -2 }); // Corrected from MT-2a
|
||||||
|
|
||||||
test "BaseQuantities - Core dimensions instantiation" {
|
test "BaseQuantities - Core dimensions instantiation" {
|
||||||
// Basic types via generic wrappers
|
// Basic types via generic wrappers
|
||||||
@@ -102,7 +104,7 @@ test "BaseQuantities - Core dimensions instantiation" {
|
|||||||
try std.testing.expectEqual(0, M.dims.get(.T));
|
try std.testing.expectEqual(0, M.dims.get(.T));
|
||||||
|
|
||||||
// Test specific scale variants
|
// Test specific scale variants
|
||||||
const Kmh = Velocity.Scaled(f32, Scales.init(.{ .L = .k, .T = .hour }));
|
const Kmh = Speed.Scaled(f32, Scales.init(.{ .L = .k, .T = .hour }));
|
||||||
const speed = Kmh{ .value = 120.0 };
|
const speed = Kmh{ .value = 120.0 };
|
||||||
try std.testing.expectEqual(120.0, speed.value);
|
try std.testing.expectEqual(120.0, speed.value);
|
||||||
try std.testing.expectEqual(.k, @TypeOf(speed).scales.get(.L));
|
try std.testing.expectEqual(.k, @TypeOf(speed).scales.get(.L));
|
||||||
@@ -116,7 +118,7 @@ test "BaseQuantities - Kinematics equations" {
|
|||||||
// Velocity = Distance / Time
|
// Velocity = Distance / Time
|
||||||
const v = d.divBy(t);
|
const v = d.divBy(t);
|
||||||
try std.testing.expectEqual(25.0, v.value);
|
try std.testing.expectEqual(25.0, v.value);
|
||||||
try std.testing.expect(Velocity.dims.eql(@TypeOf(v).dims));
|
try std.testing.expect(Speed.dims.eql(@TypeOf(v).dims));
|
||||||
|
|
||||||
// Acceleration = Velocity / Time
|
// Acceleration = Velocity / Time
|
||||||
const a = v.divBy(t);
|
const a = v.divBy(t);
|
||||||
@@ -1,652 +0,0 @@
|
|||||||
const std = @import("std");
|
|
||||||
const hlp = @import("helper.zig");
|
|
||||||
|
|
||||||
const QuantityVec = @import("QuantityVec.zig").QuantityVec;
|
|
||||||
const Scales = @import("Scales.zig");
|
|
||||||
const UnitScale = Scales.UnitScale;
|
|
||||||
const Dimensions = @import("Dimensions.zig");
|
|
||||||
const Dimension = Dimensions.Dimension;
|
|
||||||
|
|
||||||
pub fn Quantity(comptime T: type, comptime d: Dimensions, comptime s: Scales) type {
|
|
||||||
@setEvalBranchQuota(100_000);
|
|
||||||
return struct {
|
|
||||||
value: T,
|
|
||||||
|
|
||||||
const Self = @This();
|
|
||||||
pub const Vec3: type = QuantityVec(3, Self);
|
|
||||||
pub const ValueType: type = T;
|
|
||||||
|
|
||||||
pub const dims: Dimensions = d;
|
|
||||||
pub const scales = s;
|
|
||||||
|
|
||||||
pub inline fn add(self: Self, rhs: anytype) Quantity(
|
|
||||||
T,
|
|
||||||
dims,
|
|
||||||
scales.min(@TypeOf(rhs).scales),
|
|
||||||
) {
|
|
||||||
if (comptime !dims.eql(@TypeOf(rhs).dims))
|
|
||||||
@compileError("Dimension mismatch in add: " ++ dims.str() ++ " vs " ++ @TypeOf(rhs).dims.str());
|
|
||||||
if (comptime @TypeOf(rhs) == Self)
|
|
||||||
return .{ .value = self.value + rhs.value };
|
|
||||||
|
|
||||||
const TargetType = Quantity(T, dims, scales.min(@TypeOf(rhs).scales));
|
|
||||||
const lhs_val = if (comptime @TypeOf(self) == TargetType) self.value else self.to(TargetType).value;
|
|
||||||
const rhs_val = if (comptime @TypeOf(rhs) == TargetType) rhs.value else rhs.to(TargetType).value;
|
|
||||||
|
|
||||||
return .{ .value = lhs_val + rhs_val };
|
|
||||||
}
|
|
||||||
|
|
||||||
pub inline fn sub(self: Self, rhs: anytype) Quantity(
|
|
||||||
T,
|
|
||||||
dims,
|
|
||||||
scales.min(@TypeOf(rhs).scales),
|
|
||||||
) {
|
|
||||||
if (comptime !dims.eql(@TypeOf(rhs).dims))
|
|
||||||
@compileError("Dimension mismatch in sub: " ++ dims.str() ++ " vs " ++ @TypeOf(rhs).dims.str());
|
|
||||||
if (comptime @TypeOf(rhs) == Self)
|
|
||||||
return .{ .value = self.value - rhs.value };
|
|
||||||
|
|
||||||
const TargetType = Quantity(T, dims, scales.min(@TypeOf(rhs).scales));
|
|
||||||
const lhs_val = if (comptime @TypeOf(self) == TargetType) self.value else self.to(TargetType).value;
|
|
||||||
const rhs_val = if (comptime @TypeOf(rhs) == TargetType) rhs.value else rhs.to(TargetType).value;
|
|
||||||
|
|
||||||
return .{ .value = lhs_val - rhs_val };
|
|
||||||
}
|
|
||||||
|
|
||||||
pub inline fn mulBy(self: Self, rhs: anytype) Quantity(
|
|
||||||
T,
|
|
||||||
dims.add(@TypeOf(rhs).dims),
|
|
||||||
scales.min(@TypeOf(rhs).scales),
|
|
||||||
) {
|
|
||||||
const RhsType = @TypeOf(rhs);
|
|
||||||
const SelfNorm = Quantity(T, dims, scales.min(RhsType.scales));
|
|
||||||
const RhsNorm = Quantity(T, RhsType.dims, scales.min(RhsType.scales));
|
|
||||||
// Only convert the side(s) that actually need it
|
|
||||||
const lhs_val = if (comptime Self == SelfNorm) self.value else self.to(SelfNorm).value;
|
|
||||||
const rhs_val = if (comptime RhsType == RhsNorm) rhs.value else rhs.to(RhsNorm).value;
|
|
||||||
return .{ .value = lhs_val * rhs_val };
|
|
||||||
}
|
|
||||||
|
|
||||||
pub inline fn divBy(self: Self, rhs: anytype) Quantity(
|
|
||||||
T,
|
|
||||||
dims.sub(@TypeOf(rhs).dims),
|
|
||||||
scales.min(@TypeOf(rhs).scales),
|
|
||||||
) {
|
|
||||||
const RhsType = @TypeOf(rhs);
|
|
||||||
const SelfNorm = Quantity(T, dims, scales.min(RhsType.scales));
|
|
||||||
const RhsNorm = Quantity(T, RhsType.dims, scales.min(RhsType.scales));
|
|
||||||
const lhs_val = if (comptime Self == SelfNorm) self.value else self.to(SelfNorm).value;
|
|
||||||
const rhs_val = if (comptime RhsType == RhsNorm) rhs.value else rhs.to(RhsNorm).value;
|
|
||||||
if (comptime @typeInfo(T) == .int) {
|
|
||||||
return .{ .value = @divTrunc(lhs_val, rhs_val) };
|
|
||||||
} else {
|
|
||||||
return .{ .value = lhs_val / rhs_val };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub inline fn scale(self: Self, sc: T) Self {
|
|
||||||
return .{ .value = self.value * sc };
|
|
||||||
}
|
|
||||||
|
|
||||||
pub inline fn to(self: Self, comptime Dest: type) Dest {
|
|
||||||
if (comptime !dims.eql(Dest.dims))
|
|
||||||
@compileError("Dimension mismatch in to: " ++ dims.str() ++ " vs " ++ Dest.dims.str());
|
|
||||||
if (comptime @TypeOf(self) == Dest)
|
|
||||||
return self;
|
|
||||||
|
|
||||||
const DestT = Dest.ValueType;
|
|
||||||
const ratio = comptime (scales.getFactor(dims) / Dest.scales.getFactor(Dest.dims));
|
|
||||||
|
|
||||||
// Fast-path: Native pure-integer exact conversions
|
|
||||||
if (comptime @typeInfo(T) == .int and @typeInfo(DestT) == .int) {
|
|
||||||
if (comptime ratio >= 1.0 and @round(ratio) == ratio) {
|
|
||||||
const mult: DestT = comptime @intFromFloat(ratio);
|
|
||||||
return .{ .value = @as(DestT, @intCast(self.value)) * mult };
|
|
||||||
} else if (comptime ratio < 1.0 and @round(1.0 / ratio) == 1.0 / ratio) {
|
|
||||||
const div: DestT = comptime @intFromFloat(1.0 / ratio);
|
|
||||||
const val = @as(DestT, @intCast(self.value));
|
|
||||||
const half = comptime div / 2;
|
|
||||||
// Native round-to-nearest
|
|
||||||
const rounded = if (val >= 0) @divTrunc(val + half, div) else @divTrunc(val - half, div);
|
|
||||||
return .{ .value = rounded };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fallback preserving native Float types (e.g., f128 shouldn't downcast to f64)
|
|
||||||
if (comptime @typeInfo(DestT) == .float) {
|
|
||||||
const val_f = switch (@typeInfo(T)) {
|
|
||||||
inline .int => @as(DestT, @floatFromInt(self.value)),
|
|
||||||
inline .float => @as(DestT, @floatCast(self.value)),
|
|
||||||
else => unreachable,
|
|
||||||
};
|
|
||||||
return .{ .value = val_f * @as(DestT, @floatCast(ratio)) };
|
|
||||||
} else {
|
|
||||||
const val_f = switch (@typeInfo(T)) {
|
|
||||||
inline .int => @as(f64, @floatFromInt(self.value)),
|
|
||||||
inline .float => @as(f64, @floatCast(self.value)),
|
|
||||||
else => unreachable,
|
|
||||||
};
|
|
||||||
return .{ .value = @intFromFloat(@round(val_f * ratio)) };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn Vec(self: Self, comptime len: comptime_int) QuantityVec(len, Self) {
|
|
||||||
return QuantityVec(len, Self).initDefault(self.value);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn vec3(self: Self) Vec3 {
|
|
||||||
return Vec3.initDefault(self.value);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn format(
|
|
||||||
self: Self,
|
|
||||||
writer: *std.Io.Writer,
|
|
||||||
) !void {
|
|
||||||
try writer.print("{d}", .{self.value});
|
|
||||||
var first = true;
|
|
||||||
inline for (std.enums.values(Dimension)) |bu| {
|
|
||||||
const v = dims.get(bu);
|
|
||||||
if (comptime v == 0) continue;
|
|
||||||
if (!first)
|
|
||||||
try writer.writeAll(".");
|
|
||||||
|
|
||||||
first = false;
|
|
||||||
|
|
||||||
const uscale = scales.get(bu);
|
|
||||||
if (bu == .T and (uscale == .min or uscale == .hour or uscale == .year))
|
|
||||||
try writer.print("{s}", .{uscale.str()})
|
|
||||||
else
|
|
||||||
try writer.print("{s}{s}", .{ uscale.str(), bu.unit() });
|
|
||||||
|
|
||||||
if (v != 1)
|
|
||||||
try hlp.printSuperscript(writer, v);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Generate quantity" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = -3 }));
|
|
||||||
const Second = Quantity(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .n }));
|
|
||||||
|
|
||||||
const distance = Meter{ .value = 10 };
|
|
||||||
const time = Second{ .value = 2 };
|
|
||||||
|
|
||||||
try std.testing.expectEqual(10, distance.value);
|
|
||||||
try std.testing.expectEqual(2, time.value);
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Add" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const distance = Meter{ .value = 10 };
|
|
||||||
const distance2 = Meter{ .value = 20 };
|
|
||||||
|
|
||||||
const added = distance.add(distance2);
|
|
||||||
try std.testing.expectEqual(30, added.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(added).dims.get(.L));
|
|
||||||
std.debug.print("KiloMeter {f} + {f} = {f} OK\n", .{ distance, distance2, added });
|
|
||||||
|
|
||||||
const KiloMeter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const distance3 = KiloMeter{ .value = 2 };
|
|
||||||
const added2 = distance.add(distance3);
|
|
||||||
try std.testing.expectEqual(2010, added2.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(added2).dims.get(.L));
|
|
||||||
std.debug.print("KiloMeter {f} + {f} = {f} OK\n", .{ distance, distance3, added2 });
|
|
||||||
|
|
||||||
const added3 = distance3.add(distance).to(KiloMeter);
|
|
||||||
try std.testing.expectEqual(2, added3.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(added3).dims.get(.L));
|
|
||||||
std.debug.print("KiloMeter {f} + {f} = {f} OK\n", .{ distance3, distance, added3 });
|
|
||||||
|
|
||||||
const KiloMeter_f = Quantity(f64, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const distance4 = KiloMeter_f{ .value = 2 };
|
|
||||||
const added4 = distance4.add(distance).to(KiloMeter_f);
|
|
||||||
try std.testing.expectApproxEqAbs(2.01, added4.value, 0.000001);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(added4).dims.get(.L));
|
|
||||||
std.debug.print("KiloMeter_f {f} + {f} = {f} OK\n", .{ distance4, distance, added4 });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Sub" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const KiloMeter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const KiloMeter_f = Quantity(f64, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
|
|
||||||
const a = Meter{ .value = 500 };
|
|
||||||
const b = Meter{ .value = 200 };
|
|
||||||
const diff = a.sub(b);
|
|
||||||
try std.testing.expectEqual(300, diff.value);
|
|
||||||
std.debug.print("Sub: {f} - {f} = {f} OK\n", .{ a, b, diff });
|
|
||||||
|
|
||||||
const km = KiloMeter{ .value = 1 };
|
|
||||||
const diff2 = a.sub(km);
|
|
||||||
std.debug.print("Sub cross-scale: {f} - {f} = {f}\n", .{ a, km, diff2 });
|
|
||||||
|
|
||||||
const km_f = KiloMeter_f{ .value = 2.5 };
|
|
||||||
const m_f = Meter{ .value = 500 };
|
|
||||||
const diff3 = km_f.sub(m_f);
|
|
||||||
try std.testing.expectApproxEqAbs(2000, diff3.value, 1e-4);
|
|
||||||
std.debug.print("Sub float cross-scale: {f} - {f} = {f} OK\n", .{ km_f, m_f, diff3 });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "MulBy" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Second = Quantity(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const d = Meter{ .value = 3.0 };
|
|
||||||
const t = Second{ .value = 4.0 };
|
|
||||||
|
|
||||||
const area_time = d.mulBy(t);
|
|
||||||
try std.testing.expectEqual(12, area_time.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
|
||||||
std.debug.print("MulBy: {f} * {f} = {f} OK\n", .{ d, t, area_time });
|
|
||||||
|
|
||||||
const d2 = Meter{ .value = 5.0 };
|
|
||||||
const area = d.mulBy(d2);
|
|
||||||
try std.testing.expectEqual(15, area.value);
|
|
||||||
try std.testing.expectEqual(2, @TypeOf(area).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(0, @TypeOf(area).dims.get(.T));
|
|
||||||
std.debug.print("MulBy: {f} * {f} = {f} OK\n", .{ d, d2, area });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "MulBy with scale" {
|
|
||||||
const KiloMeter = Quantity(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const KiloGram = Quantity(f32, Dimensions.init(.{ .M = 1 }), Scales.init(.{ .M = .k }));
|
|
||||||
|
|
||||||
const dist = KiloMeter{ .value = 2.0 };
|
|
||||||
const mass = KiloGram{ .value = 3.0 };
|
|
||||||
const prod = dist.mulBy(mass);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(prod).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(prod).dims.get(.M));
|
|
||||||
std.debug.print("MulBy scaled: {f} * {f} = {f} OK\n", .{ dist, mass, prod });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "MulBy with type change" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const Second = Quantity(f64, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
const KmSec = Quantity(i64, Dimensions.init(.{ .L = 1, .T = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const KmSec_f = Quantity(f32, Dimensions.init(.{ .L = 1, .T = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
|
|
||||||
const d = Meter{ .value = 3.0 };
|
|
||||||
const t = Second{ .value = 4.0 };
|
|
||||||
|
|
||||||
const area_time = d.mulBy(t).to(KmSec);
|
|
||||||
const area_time_f = d.mulBy(t).to(KmSec_f);
|
|
||||||
try std.testing.expectEqual(12, area_time.value);
|
|
||||||
try std.testing.expectApproxEqAbs(12, area_time_f.value, 0.0001);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
|
||||||
std.debug.print("MulBy: {f} * {f} = {f} OK\n", .{ d, t, area_time });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "MulBy small" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .n }));
|
|
||||||
const Second = Quantity(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const d = Meter{ .value = 3.0 };
|
|
||||||
const t = Second{ .value = 4.0 };
|
|
||||||
|
|
||||||
const area_time = d.mulBy(t);
|
|
||||||
try std.testing.expectEqual(12, area_time.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
|
||||||
std.debug.print("MulBy: {f} * {f} = {f} OK\n", .{ d, t, area_time });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Scale" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Second = Quantity(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const d = Meter{ .value = 7 };
|
|
||||||
const scaled = d.scale(3);
|
|
||||||
try std.testing.expectEqual(21, scaled.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(scaled).dims.get(.L));
|
|
||||||
std.debug.print("Scale int: {f} * 3 = {f} OK\n", .{ d, scaled });
|
|
||||||
|
|
||||||
const t = Second{ .value = 1.5 };
|
|
||||||
const scaled_f = t.scale(4.0);
|
|
||||||
try std.testing.expectApproxEqAbs(@as(f32, 6.0), scaled_f.value, 1e-4);
|
|
||||||
std.debug.print("Scale float: {f} * 4 = {f} OK\n", .{ t, scaled_f });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Chained: velocity and acceleration" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Second = Quantity(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const dist = Meter{ .value = 100.0 };
|
|
||||||
const t1 = Second{ .value = 5.0 };
|
|
||||||
const velocity = dist.divBy(t1);
|
|
||||||
try std.testing.expectEqual(20, velocity.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(velocity).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(-1, @TypeOf(velocity).dims.get(.T));
|
|
||||||
|
|
||||||
const t2 = Second{ .value = 4.0 };
|
|
||||||
const accel = velocity.divBy(t2);
|
|
||||||
try std.testing.expectEqual(5, accel.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(accel).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(-2, @TypeOf(accel).dims.get(.T));
|
|
||||||
|
|
||||||
std.debug.print("Velocity: {f}, Acceleration: {f} OK\n", .{ velocity, accel });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "DivBy integer exact" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Second = Quantity(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const dist = Meter{ .value = 120 };
|
|
||||||
const time = Second{ .value = 4 };
|
|
||||||
const vel = dist.divBy(time);
|
|
||||||
|
|
||||||
try std.testing.expectEqual(30, vel.value);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(vel).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(-1, @TypeOf(vel).dims.get(.T));
|
|
||||||
std.debug.print("DivBy int: {f} / {f} = {f} OK\n", .{ dist, time, vel });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Conversion chain: km -> m -> cm" {
|
|
||||||
const KiloMeter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const CentiMeter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .c }));
|
|
||||||
|
|
||||||
const km = KiloMeter{ .value = 15 };
|
|
||||||
const m = km.to(Meter);
|
|
||||||
const cm = m.to(CentiMeter);
|
|
||||||
|
|
||||||
try std.testing.expectEqual(15_000, m.value);
|
|
||||||
try std.testing.expectEqual(1_500_000, cm.value);
|
|
||||||
std.debug.print("Chain: {f} -> {f} -> {f} OK\n", .{ km, m, cm });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Conversion: hours -> minutes -> seconds" {
|
|
||||||
const Hour = Quantity(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .hour }));
|
|
||||||
const Minute = Quantity(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .min }));
|
|
||||||
const Second = Quantity(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const h = Hour{ .value = 1.0 };
|
|
||||||
const min = h.to(Minute);
|
|
||||||
const sec = min.to(Second);
|
|
||||||
|
|
||||||
try std.testing.expectEqual(60, min.value);
|
|
||||||
try std.testing.expectEqual(3600, sec.value);
|
|
||||||
std.debug.print("Time chain: {f} -> {f} -> {f} OK\n", .{ h, min, sec });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Negative values" {
|
|
||||||
const Meter = Quantity(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const a = Meter{ .value = 5 };
|
|
||||||
const b = Meter{ .value = 20 };
|
|
||||||
const diff = a.sub(b);
|
|
||||||
try std.testing.expectEqual(-15, diff.value);
|
|
||||||
std.debug.print("Negative sub: {f} - {f} = {f} OK\n", .{ a, b, diff });
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Format Quantity" {
|
|
||||||
const MeterPerSecondSq = Quantity(
|
|
||||||
f32,
|
|
||||||
Dimensions.init(.{ .L = 1, .T = -2 }),
|
|
||||||
Scales.init(.{ .T = .n }),
|
|
||||||
);
|
|
||||||
const KgMeterPerSecond = Quantity(
|
|
||||||
f32,
|
|
||||||
Dimensions.init(.{ .M = 1, .L = 1, .T = -1 }),
|
|
||||||
Scales.init(.{ .M = .k }),
|
|
||||||
);
|
|
||||||
|
|
||||||
const accel = MeterPerSecondSq{ .value = 9.81 };
|
|
||||||
const momentum = KgMeterPerSecond{ .value = 42.0 };
|
|
||||||
|
|
||||||
std.debug.print("Acceleration: {f}\n", .{accel});
|
|
||||||
std.debug.print("Momentum: {f}\n", .{momentum});
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Benchmark" {
|
|
||||||
const Io = std.Io;
|
|
||||||
const ITERS: usize = 100_000;
|
|
||||||
const SAMPLES: usize = 10; // Number of samples for stats
|
|
||||||
|
|
||||||
var gsink: f64 = 0;
|
|
||||||
const io = std.testing.io;
|
|
||||||
|
|
||||||
// Standard Zig 0.16 timestamp retrieval
|
|
||||||
const getTime = struct {
|
|
||||||
fn f(i: Io) Io.Timestamp {
|
|
||||||
return Io.Clock.awake.now(i);
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
const fold = struct {
|
|
||||||
fn f(comptime TT: type, s: *f64, v: TT) void {
|
|
||||||
s.* += if (comptime @typeInfo(TT) == .float)
|
|
||||||
@as(f64, @floatCast(v))
|
|
||||||
else
|
|
||||||
@as(f64, @floatFromInt(v));
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
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 Stats = struct {
|
|
||||||
median: f64,
|
|
||||||
delta: f64,
|
|
||||||
ops_per_sec: f64,
|
|
||||||
};
|
|
||||||
|
|
||||||
const computeStats = struct {
|
|
||||||
fn f(samples: []f64, iters: usize) Stats {
|
|
||||||
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];
|
|
||||||
|
|
||||||
const low = samples[0];
|
|
||||||
const high = samples[samples.len - 1];
|
|
||||||
const delta_ns = (high - low) / 2.0;
|
|
||||||
|
|
||||||
const ns_per_op = median_ns / @as(f64, @floatFromInt(iters));
|
|
||||||
return .{
|
|
||||||
.median = ns_per_op,
|
|
||||||
.delta = (delta_ns / @as(f64, @floatFromInt(iters))),
|
|
||||||
.ops_per_sec = 1_000_000_000.0 / ns_per_op,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
std.debug.print(
|
|
||||||
\\
|
|
||||||
\\ Quantity<T> benchmark — {d} iterations, {d} samples/cell
|
|
||||||
\\
|
|
||||||
\\┌───────────────────┬──────┬─────────────────────┬─────────────────────┐
|
|
||||||
\\│ Operation │ Type │ ns / op (± delta) │ Throughput (ops/s) │
|
|
||||||
\\├───────────────────┼──────┼─────────────────────┼─────────────────────┤
|
|
||||||
\\
|
|
||||||
, .{ ITERS, SAMPLES });
|
|
||||||
|
|
||||||
const Types = .{ i16, i32, i64, i128, i256, f32, f64, f128 };
|
|
||||||
const TNames = .{ "i16", "i32", "i64", "i128", "i256", "f32", "f64", "f128" };
|
|
||||||
const Ops = .{ "add", "sub", "mulBy", "divBy", "scale", "to" };
|
|
||||||
|
|
||||||
var results_matrix: [Ops.len][Types.len]f64 = undefined;
|
|
||||||
|
|
||||||
comptime var tidx: usize = 0;
|
|
||||||
inline for (Types, TNames) |T, tname| {
|
|
||||||
const M = Quantity(T, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const KM = Quantity(T, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const S = Quantity(T, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, oidx| {
|
|
||||||
var samples: [SAMPLES]f64 = undefined;
|
|
||||||
|
|
||||||
for (0..SAMPLES) |s_idx| {
|
|
||||||
var sink: T = 0;
|
|
||||||
const t_start = getTime(io);
|
|
||||||
|
|
||||||
for (0..ITERS) |i| {
|
|
||||||
const r = if (comptime std.mem.eql(u8, op_name, "add"))
|
|
||||||
(M{ .value = getVal(T, i, 63) }).add(M{ .value = getVal(T, i +% 7, 63) })
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
|
||||||
(M{ .value = getVal(T, i +% 10, 63) }).sub(M{ .value = getVal(T, i, 63) })
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
|
||||||
(M{ .value = getVal(T, i, 63) }).mulBy(M{ .value = getVal(T, i +% 1, 63) })
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "divBy"))
|
|
||||||
(M{ .value = getVal(T, i +% 10, 63) }).divBy(S{ .value = getVal(T, i, 63) })
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "scale"))
|
|
||||||
(M{ .value = getVal(T, i, 63) }).scale(getVal(T, i +% 2, 63))
|
|
||||||
else
|
|
||||||
(KM{ .value = getVal(T, i, 15) }).to(M);
|
|
||||||
|
|
||||||
if (comptime @typeInfo(T) == .float) sink += r.value else sink ^= r.value;
|
|
||||||
}
|
|
||||||
|
|
||||||
const t_end = getTime(io);
|
|
||||||
samples[s_idx] = @as(f64, @floatFromInt(t_start.durationTo(t_end).toNanoseconds()));
|
|
||||||
fold(T, &gsink, sink);
|
|
||||||
}
|
|
||||||
|
|
||||||
const stats = computeStats(&samples, ITERS);
|
|
||||||
results_matrix[oidx][tidx] = stats.median;
|
|
||||||
|
|
||||||
std.debug.print("│ {s:<17} │ {s:<4} │ {d:>8.2} ns ±{d:<6.2} │ {d:>19.0} │\n", .{ op_name, tname, stats.median, stats.delta, stats.ops_per_sec });
|
|
||||||
}
|
|
||||||
|
|
||||||
if (comptime tidx < Types.len - 1) {
|
|
||||||
std.debug.print("├───────────────────┼──────┼─────────────────────┼─────────────────────┤\n", .{});
|
|
||||||
}
|
|
||||||
tidx += 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Median Summary Table
|
|
||||||
std.debug.print("└───────────────────┴──────┴─────────────────────┴─────────────────────┘\n\n", .{});
|
|
||||||
std.debug.print("Median Summary (ns/op):\n", .{});
|
|
||||||
|
|
||||||
std.debug.print("┌──────────────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┐\n", .{});
|
|
||||||
std.debug.print("│ Operation │ i16 │ i32 │ i64 │ i128 │ i256 │ f32 │ f64 │ f128 │\n", .{});
|
|
||||||
std.debug.print("├──────────────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┤\n", .{});
|
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, oidx| {
|
|
||||||
std.debug.print("│ {s:<11} │", .{op_name});
|
|
||||||
var i: usize = 0;
|
|
||||||
while (i < Types.len) : (i += 1) {
|
|
||||||
std.debug.print("{d:>6.1} │", .{results_matrix[oidx][i]});
|
|
||||||
}
|
|
||||||
std.debug.print("\n", .{});
|
|
||||||
}
|
|
||||||
|
|
||||||
std.debug.print("└──────────────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┘\n", .{});
|
|
||||||
|
|
||||||
std.debug.print("\nAnti-optimisation sink: {d:.4}\n", .{gsink});
|
|
||||||
try std.testing.expect(gsink != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Overhead Analysis: Quantity vs Native" {
|
|
||||||
const Io = std.Io;
|
|
||||||
const ITERS: usize = 100_000;
|
|
||||||
const SAMPLES: usize = 5;
|
|
||||||
const io = std.testing.io;
|
|
||||||
|
|
||||||
const getTime = struct {
|
|
||||||
fn f(i: Io) Io.Timestamp {
|
|
||||||
return Io.Clock.awake.now(i);
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
const fold = struct {
|
|
||||||
fn f(comptime TT: type, s: *f64, v: TT) void {
|
|
||||||
s.* += if (comptime @typeInfo(TT) == .float)
|
|
||||||
@as(f64, @floatCast(v))
|
|
||||||
else
|
|
||||||
@as(f64, @floatFromInt(v));
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
// Helper to safely get a value of type T from a loop index
|
|
||||||
const getValT = struct {
|
|
||||||
fn f(comptime TT: type, i: usize) TT {
|
|
||||||
const v = (i % 100) + 1;
|
|
||||||
return if (comptime @typeInfo(TT) == .float) @floatFromInt(v) else @intCast(v);
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
const Types = .{ i32, i64, i128, f32, f64 };
|
|
||||||
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
|
||||||
const Ops = .{ "add", "mulBy", "divBy" };
|
|
||||||
|
|
||||||
var gsink: f64 = 0;
|
|
||||||
|
|
||||||
std.debug.print(
|
|
||||||
\\
|
|
||||||
\\ Quantity vs Native Overhead Analysis
|
|
||||||
\\
|
|
||||||
\\┌───────────┬──────┬───────────┬───────────┬───────────┐
|
|
||||||
\\│ Operation │ Type │ Native │ Quantity │ Slowdown │
|
|
||||||
\\├───────────┼──────┼───────────┼───────────┼───────────┤
|
|
||||||
\\
|
|
||||||
, .{});
|
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, j| {
|
|
||||||
inline for (Types, 0..) |T, tidx| {
|
|
||||||
var native_total_ns: f64 = 0;
|
|
||||||
var quantity_total_ns: f64 = 0;
|
|
||||||
|
|
||||||
const M = Quantity(T, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const S = Quantity(T, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
for (0..SAMPLES) |_| {
|
|
||||||
// --- 1. Benchmark Native ---
|
|
||||||
var n_sink: T = 0;
|
|
||||||
const n_start = getTime(io);
|
|
||||||
for (0..ITERS) |i| {
|
|
||||||
const a = getValT(T, i);
|
|
||||||
const b = getValT(T, 2);
|
|
||||||
const r = if (comptime std.mem.eql(u8, op_name, "add"))
|
|
||||||
a + b
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
|
||||||
a * b
|
|
||||||
else if (comptime @typeInfo(T) == .int) @divTrunc(a, b) else a / b;
|
|
||||||
|
|
||||||
if (comptime @typeInfo(T) == .float) n_sink += r else n_sink ^= r;
|
|
||||||
}
|
|
||||||
const n_end = getTime(io);
|
|
||||||
native_total_ns += @as(f64, @floatFromInt(n_start.durationTo(n_end).toNanoseconds()));
|
|
||||||
fold(T, &gsink, n_sink);
|
|
||||||
|
|
||||||
// --- 2. Benchmark Quantity ---
|
|
||||||
var q_sink: T = 0;
|
|
||||||
const q_start = getTime(io);
|
|
||||||
for (0..ITERS) |i| {
|
|
||||||
const qa = M{ .value = getValT(T, i) };
|
|
||||||
const qb = if (comptime std.mem.eql(u8, op_name, "divBy")) S{ .value = getValT(T, 2) } else M{ .value = getValT(T, 2) };
|
|
||||||
|
|
||||||
const r = if (comptime std.mem.eql(u8, op_name, "add"))
|
|
||||||
qa.add(qb)
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
|
||||||
qa.mulBy(qb)
|
|
||||||
else
|
|
||||||
qa.divBy(qb);
|
|
||||||
|
|
||||||
if (comptime @typeInfo(T) == .float) q_sink += r.value else q_sink ^= r.value;
|
|
||||||
}
|
|
||||||
const q_end = getTime(io);
|
|
||||||
quantity_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
|
||||||
fold(T, &gsink, q_sink);
|
|
||||||
}
|
|
||||||
|
|
||||||
const avg_n = (native_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
|
||||||
const avg_q = (quantity_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
|
||||||
const slowdown = avg_q / avg_n;
|
|
||||||
|
|
||||||
std.debug.print("│ {s:<9} │ {s:<4} │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>8.2}x │\n", .{
|
|
||||||
op_name, TNames[tidx], avg_n, avg_q, slowdown,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
if (j != Ops.len - 1) std.debug.print("├───────────┼──────┼───────────┼───────────┼───────────┤\n", .{});
|
|
||||||
}
|
|
||||||
|
|
||||||
std.debug.print("└───────────┴──────┴───────────┴───────────┴───────────┘\n", .{});
|
|
||||||
try std.testing.expect(gsink != 0);
|
|
||||||
}
|
|
||||||
@@ -1,427 +0,0 @@
|
|||||||
const std = @import("std");
|
|
||||||
const hlp = @import("helper.zig");
|
|
||||||
|
|
||||||
const Quantity = @import("Quantity.zig").Quantity;
|
|
||||||
const Scales = @import("Scales.zig");
|
|
||||||
const UnitScale = Scales.UnitScale;
|
|
||||||
const Dimensions = @import("Dimensions.zig");
|
|
||||||
const Dimension = Dimensions.Dimension;
|
|
||||||
|
|
||||||
pub fn QuantityVec(comptime len: usize, comptime Q: type) type {
|
|
||||||
const T = Q.ValueType;
|
|
||||||
const d: Dimensions = Q.dims;
|
|
||||||
const s: Scales = Q.scales;
|
|
||||||
|
|
||||||
return struct {
|
|
||||||
data: [len]T,
|
|
||||||
|
|
||||||
const Self = @This();
|
|
||||||
pub const QuantityType = Q;
|
|
||||||
pub const ValueType = T;
|
|
||||||
pub const dims: Dimensions = d;
|
|
||||||
pub const scales = s;
|
|
||||||
|
|
||||||
pub const zero = initDefault(0);
|
|
||||||
pub const one = initDefault(1);
|
|
||||||
|
|
||||||
pub fn initDefault(v: T) Self {
|
|
||||||
var data: [len]T = undefined;
|
|
||||||
for (&data) |*item| item.* = v;
|
|
||||||
return .{ .data = data };
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn add(self: Self, rhs: anytype) QuantityVec(len, Quantity(T, d, s.min(@TypeOf(rhs).scales))) {
|
|
||||||
const Tr = @TypeOf(rhs);
|
|
||||||
var res: QuantityVec(len, Quantity(T, d, s.min(Tr.scales))) = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
const q = (Q{ .value = v }).add(Tr.QuantityType{ .value = rhs.data[i] });
|
|
||||||
res.data[i] = q.value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn sub(self: Self, rhs: anytype) QuantityVec(len, Quantity(T, d, s.min(@TypeOf(rhs).scales))) {
|
|
||||||
const Tr = @TypeOf(rhs);
|
|
||||||
var res: QuantityVec(len, Quantity(T, d, s.min(Tr.scales))) = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
const q = (Q{ .value = v }).sub(Tr.QuantityType{ .value = rhs.data[i] });
|
|
||||||
res.data[i] = q.value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn divBy(
|
|
||||||
self: Self,
|
|
||||||
rhs: anytype,
|
|
||||||
) QuantityVec(len, Quantity(T, d.sub(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
|
|
||||||
const Tr = @TypeOf(rhs);
|
|
||||||
var res: QuantityVec(len, Quantity(T, d.sub(Tr.dims), s.min(Tr.scales))) = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
const q = (Q{ .value = v }).divBy(Tr.QuantityType{ .value = rhs.data[i] });
|
|
||||||
res.data[i] = q.value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn mulBy(
|
|
||||||
self: Self,
|
|
||||||
rhs: anytype,
|
|
||||||
) QuantityVec(len, Quantity(T, d.add(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
|
|
||||||
const Tr = @TypeOf(rhs);
|
|
||||||
var res: QuantityVec(len, Quantity(T, d.add(Tr.dims), s.min(Tr.scales))) = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
const q = (Q{ .value = v }).mulBy(Tr.QuantityType{ .value = rhs.data[i] });
|
|
||||||
res.data[i] = q.value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn divByScalar(
|
|
||||||
self: Self,
|
|
||||||
scalar: anytype,
|
|
||||||
) QuantityVec(len, Quantity(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) {
|
|
||||||
var res: QuantityVec(len, Quantity(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
const q = Q{ .value = v };
|
|
||||||
res.data[i] = q.divBy(scalar).value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn mulByScalar(
|
|
||||||
self: Self,
|
|
||||||
scalar: anytype,
|
|
||||||
) QuantityVec(len, Quantity(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) {
|
|
||||||
var res: QuantityVec(len, Quantity(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
const q = Q{ .value = v };
|
|
||||||
res.data[i] = q.mulBy(scalar).value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn negate(self: Self) Self {
|
|
||||||
var res: Self = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
res.data[i] = -v;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn scale(self: Self, rhs: T) Self {
|
|
||||||
var res: Self = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
res.data[i] = (Q{ .value = v }).scale(rhs).value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn to(self: Self, comptime DestQ: type) QuantityVec(len, DestQ) {
|
|
||||||
var res: QuantityVec(len, DestQ) = undefined;
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
res.data[i] = (Q{ .value = v }).to(DestQ).value;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn lengthSqr(self: Self) T {
|
|
||||||
var sum: T = 0;
|
|
||||||
for (self.data) |v| {
|
|
||||||
sum += v * v;
|
|
||||||
}
|
|
||||||
return sum;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn length(self: Self) T {
|
|
||||||
const len_sq = self.lengthSqr();
|
|
||||||
|
|
||||||
if (comptime @typeInfo(T) == .int) {
|
|
||||||
// Construct the unsigned equivalent of T at comptime (e.g., i32 -> u32)
|
|
||||||
const UnsignedT = @Int(.unsigned, @typeInfo(T).int.bits);
|
|
||||||
|
|
||||||
// len_sq is always positive, so @intCast is perfectly safe
|
|
||||||
const u_len_sq = @as(UnsignedT, @intCast(len_sq));
|
|
||||||
return @as(T, @intCast(std.math.sqrt(u_len_sq)));
|
|
||||||
} else {
|
|
||||||
return @sqrt(len_sq);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn format(self: Self, writer: *std.Io.Writer) !void {
|
|
||||||
try writer.writeAll("(");
|
|
||||||
for (self.data, 0..) |v, i| {
|
|
||||||
if (i > 0) try writer.writeAll(", ");
|
|
||||||
try writer.print("{d:.2}", .{v});
|
|
||||||
}
|
|
||||||
try writer.writeAll(")");
|
|
||||||
var first = true;
|
|
||||||
inline for (std.enums.values(Dimension)) |bu| {
|
|
||||||
const v = dims.get(bu);
|
|
||||||
if (v == 0) continue;
|
|
||||||
if (!first) try writer.writeAll(".");
|
|
||||||
first = false;
|
|
||||||
try writer.print("{s}{s}", .{ scales.get(bu).str(), bu.unit() });
|
|
||||||
if (v != 1) try hlp.printSuperscript(writer, v);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Format VectorX" {
|
|
||||||
const MeterPerSecondSq = Quantity(
|
|
||||||
f32,
|
|
||||||
Dimensions.init(.{ .L = 1, .T = -2 }),
|
|
||||||
Scales.init(.{ .T = .n }),
|
|
||||||
);
|
|
||||||
const KgMeterPerSecond = Quantity(
|
|
||||||
f32,
|
|
||||||
Dimensions.init(.{ .M = 1, .L = 1, .T = -1 }),
|
|
||||||
Scales.init(.{ .M = .k }),
|
|
||||||
);
|
|
||||||
|
|
||||||
const accel = MeterPerSecondSq.Vec3.initDefault(9.81);
|
|
||||||
const momentum = KgMeterPerSecond.Vec3{ .data = .{ 43, 0, 11 } };
|
|
||||||
|
|
||||||
std.debug.print("Acceleration: {f}\n", .{accel});
|
|
||||||
std.debug.print("Momentum: {f}\n", .{momentum});
|
|
||||||
}
|
|
||||||
|
|
||||||
test "VecX Init and Basic Arithmetic" {
|
|
||||||
const Meter = Quantity(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Vec3M = Meter.Vec3;
|
|
||||||
|
|
||||||
// Test zero, one, initDefault
|
|
||||||
const v_zero = Vec3M.zero;
|
|
||||||
try std.testing.expectEqual(0, v_zero.data[0]);
|
|
||||||
try std.testing.expectEqual(0, v_zero.data[1]);
|
|
||||||
try std.testing.expectEqual(0, v_zero.data[2]);
|
|
||||||
|
|
||||||
const v_one = Vec3M.one;
|
|
||||||
try std.testing.expectEqual(1, v_one.data[0]);
|
|
||||||
try std.testing.expectEqual(1, v_one.data[1]);
|
|
||||||
try std.testing.expectEqual(1, v_one.data[2]);
|
|
||||||
|
|
||||||
const v_def = Vec3M.initDefault(5);
|
|
||||||
try std.testing.expectEqual(5, v_def.data[0]);
|
|
||||||
try std.testing.expectEqual(5, v_def.data[1]);
|
|
||||||
try std.testing.expectEqual(5, v_def.data[2]);
|
|
||||||
|
|
||||||
// Test add and sub
|
|
||||||
const v1 = Vec3M{ .data = .{ 10, 20, 30 } };
|
|
||||||
const v2 = Vec3M{ .data = .{ 2, 4, 6 } };
|
|
||||||
|
|
||||||
const added = v1.add(v2);
|
|
||||||
try std.testing.expectEqual(12, added.data[0]);
|
|
||||||
try std.testing.expectEqual(24, added.data[1]);
|
|
||||||
try std.testing.expectEqual(36, added.data[2]);
|
|
||||||
|
|
||||||
const subbed = v1.sub(v2);
|
|
||||||
try std.testing.expectEqual(8, subbed.data[0]);
|
|
||||||
try std.testing.expectEqual(16, subbed.data[1]);
|
|
||||||
try std.testing.expectEqual(24, subbed.data[2]);
|
|
||||||
|
|
||||||
// Test negate
|
|
||||||
const neg = v1.negate();
|
|
||||||
try std.testing.expectEqual(-10, neg.data[0]);
|
|
||||||
try std.testing.expectEqual(-20, neg.data[1]);
|
|
||||||
try std.testing.expectEqual(-30, neg.data[2]);
|
|
||||||
}
|
|
||||||
|
|
||||||
test "VecX Kinematics (Scalar Mul/Div)" {
|
|
||||||
const Meter = Quantity(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Second = Quantity(i32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
const Vec3M = Meter.Vec3;
|
|
||||||
|
|
||||||
const pos = Vec3M{ .data = .{ 100, 200, 300 } };
|
|
||||||
const time = Second{ .value = 10 };
|
|
||||||
|
|
||||||
// Vector divided by scalar Quantity (Velocity = Position / Time)
|
|
||||||
const vel = pos.divByScalar(time);
|
|
||||||
try std.testing.expectEqual(10, vel.data[0]);
|
|
||||||
try std.testing.expectEqual(20, vel.data[1]);
|
|
||||||
try std.testing.expectEqual(30, vel.data[2]);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(vel).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(-1, @TypeOf(vel).dims.get(.T));
|
|
||||||
|
|
||||||
// Vector multiplied by scalar Quantity (Position = Velocity * Time)
|
|
||||||
const new_pos = vel.mulByScalar(time);
|
|
||||||
try std.testing.expectEqual(100, new_pos.data[0]);
|
|
||||||
try std.testing.expectEqual(200, new_pos.data[1]);
|
|
||||||
try std.testing.expectEqual(300, new_pos.data[2]);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(new_pos).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(0, @TypeOf(new_pos).dims.get(.T));
|
|
||||||
}
|
|
||||||
|
|
||||||
test "VecX Element-wise Math and Scaling" {
|
|
||||||
const Meter = Quantity(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Vec3M = Meter.Vec3;
|
|
||||||
|
|
||||||
const v1 = Vec3M{ .data = .{ 10, 20, 30 } };
|
|
||||||
const v2 = Vec3M{ .data = .{ 2, 5, 10 } };
|
|
||||||
|
|
||||||
// Element-wise division
|
|
||||||
const div = v1.divBy(v2);
|
|
||||||
try std.testing.expectEqual(5, div.data[0]);
|
|
||||||
try std.testing.expectEqual(4, div.data[1]);
|
|
||||||
try std.testing.expectEqual(3, div.data[2]);
|
|
||||||
try std.testing.expectEqual(0, @TypeOf(div).dims.get(.L)); // M / M = Dimensionless
|
|
||||||
|
|
||||||
// Scale by primitive
|
|
||||||
const scaled = v1.scale(2);
|
|
||||||
try std.testing.expectEqual(20, scaled.data[0]);
|
|
||||||
try std.testing.expectEqual(40, scaled.data[1]);
|
|
||||||
try std.testing.expectEqual(60, scaled.data[2]);
|
|
||||||
}
|
|
||||||
|
|
||||||
test "VecX Conversions" {
|
|
||||||
const KiloMeter = Quantity(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
|
||||||
const Meter = Quantity(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
const v_km = KiloMeter.Vec3{ .data = .{ 1, 2, 3 } };
|
|
||||||
const v_m = v_km.to(Meter);
|
|
||||||
|
|
||||||
try std.testing.expectEqual(1000, v_m.data[0]);
|
|
||||||
try std.testing.expectEqual(2000, v_m.data[1]);
|
|
||||||
try std.testing.expectEqual(3000, v_m.data[2]);
|
|
||||||
|
|
||||||
// Type checking the result
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(v_m).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(UnitScale.none, @TypeOf(v_m).scales.get(.L));
|
|
||||||
}
|
|
||||||
|
|
||||||
test "VecX Length" {
|
|
||||||
const MeterInt = Quantity(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const MeterFloat = Quantity(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
|
|
||||||
// Integer length (using your custom isqrt)
|
|
||||||
// 3-4-5 triangle on XY plane
|
|
||||||
const v_int = MeterInt.Vec3{ .data = .{ 3, 4, 0 } };
|
|
||||||
try std.testing.expectEqual(25, v_int.lengthSqr());
|
|
||||||
try std.testing.expectEqual(5, v_int.length());
|
|
||||||
|
|
||||||
// Float length
|
|
||||||
const v_float = MeterFloat.Vec3{ .data = .{ 3.0, 4.0, 0.0 } };
|
|
||||||
try std.testing.expectApproxEqAbs(@as(f32, 25.0), v_float.lengthSqr(), 1e-4);
|
|
||||||
try std.testing.expectApproxEqAbs(@as(f32, 5.0), v_float.length(), 1e-4);
|
|
||||||
}
|
|
||||||
|
|
||||||
test "Benchmark QuantityVec ops" {
|
|
||||||
const Io = std.Io;
|
|
||||||
const ITERS: usize = 10_000;
|
|
||||||
const SAMPLES: usize = 10;
|
|
||||||
var gsink: f64 = 0;
|
|
||||||
|
|
||||||
// In Zig 0.14+, we use the testing IO for clock access in tests
|
|
||||||
const io = std.testing.io;
|
|
||||||
|
|
||||||
const getTime = struct {
|
|
||||||
fn f(i: Io) Io.Timestamp {
|
|
||||||
return Io.Clock.awake.now(i);
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
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 fold = struct {
|
|
||||||
fn f(comptime TT: type, s: *f64, v: TT) void {
|
|
||||||
s.* += if (comptime @typeInfo(TT) == .float)
|
|
||||||
@as(f64, @floatCast(v))
|
|
||||||
else
|
|
||||||
@as(f64, @floatFromInt(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;
|
|
||||||
|
|
||||||
std.debug.print(
|
|
||||||
\\
|
|
||||||
\\ QuantityVec<N, T> benchmark — {d} iterations, {d} samples/cell
|
|
||||||
\\ (Results in ns/op)
|
|
||||||
\\
|
|
||||||
\\┌─────────────┬──────┬─────────┬─────────┬─────────┐
|
|
||||||
\\│ Operation │ Type │ Len=3 │ Len=4 │ Len=16 │
|
|
||||||
\\├─────────────┼──────┼─────────┼─────────┼─────────┤
|
|
||||||
\\
|
|
||||||
, .{ ITERS, SAMPLES });
|
|
||||||
|
|
||||||
const Types = .{ i32, i64, i128, f32, f64 };
|
|
||||||
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
|
||||||
const Lengths = .{ 3, 4, 16 };
|
|
||||||
const Ops = .{ "add", "scale", "mulByScalar", "length" };
|
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, o_idx| {
|
|
||||||
inline for (Types, TNames) |T, tname| {
|
|
||||||
std.debug.print("│ {s:<11} │ {s:<4} │", .{ op_name, tname });
|
|
||||||
|
|
||||||
inline for (Lengths) |len| {
|
|
||||||
const Q_base = Quantity(T, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
|
||||||
const Q_time = Quantity(T, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
|
||||||
const V = QuantityVec(len, Q_base);
|
|
||||||
|
|
||||||
var samples: [SAMPLES]f64 = undefined;
|
|
||||||
|
|
||||||
for (0..SAMPLES) |s_idx| {
|
|
||||||
var sink: T = 0;
|
|
||||||
|
|
||||||
const t_start = getTime(io);
|
|
||||||
for (0..ITERS) |i| {
|
|
||||||
const v1 = V.initDefault(getVal(T, i, 63));
|
|
||||||
|
|
||||||
if (comptime std.mem.eql(u8, op_name, "add")) {
|
|
||||||
const v2 = V.initDefault(getVal(T, i +% 7, 63));
|
|
||||||
const res = v1.add(v2);
|
|
||||||
for (res.data) |val| {
|
|
||||||
if (comptime @typeInfo(T) == .float) sink += val else sink ^= val;
|
|
||||||
}
|
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "scale")) {
|
|
||||||
const sc = getVal(T, i +% 2, 63);
|
|
||||||
const res = v1.scale(sc);
|
|
||||||
for (res.data) |val| {
|
|
||||||
if (comptime @typeInfo(T) == .float) sink += val else sink ^= val;
|
|
||||||
}
|
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "mulByScalar")) {
|
|
||||||
const s_val = Q_time{ .value = getVal(T, i +% 2, 63) };
|
|
||||||
const res = v1.mulByScalar(s_val);
|
|
||||||
for (res.data) |val| {
|
|
||||||
if (comptime @typeInfo(T) == .float) sink += val else sink ^= val;
|
|
||||||
}
|
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "length")) {
|
|
||||||
const r = v1.length();
|
|
||||||
if (comptime @typeInfo(T) == .float) sink += r else sink ^= r;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const t_end = getTime(io);
|
|
||||||
|
|
||||||
samples[s_idx] = @as(f64, @floatFromInt(t_start.durationTo(t_end).toNanoseconds()));
|
|
||||||
fold(T, &gsink, sink);
|
|
||||||
}
|
|
||||||
|
|
||||||
const median_ns_per_op = computeStats(&samples, ITERS);
|
|
||||||
std.debug.print(" {d:>7.1} │", .{median_ns_per_op});
|
|
||||||
}
|
|
||||||
std.debug.print("\n", .{});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (o_idx < Ops.len - 1) {
|
|
||||||
std.debug.print("├─────────────┼──────┼─────────┼─────────┼─────────┤\n", .{});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
std.debug.print("└─────────────┴──────┴─────────┴─────────┴─────────┘\n", .{});
|
|
||||||
std.debug.print("\nAnti-optimisation sink: {d:.4}\n", .{gsink});
|
|
||||||
try std.testing.expect(gsink != 0);
|
|
||||||
}
|
|
||||||
+396
@@ -0,0 +1,396 @@
|
|||||||
|
const std = @import("std");
|
||||||
|
const hlp = @import("helper.zig");
|
||||||
|
|
||||||
|
const Vector = @import("Vector.zig").Vector;
|
||||||
|
const Scales = @import("Scales.zig");
|
||||||
|
const UnitScale = Scales.UnitScale;
|
||||||
|
const Dimensions = @import("Dimensions.zig");
|
||||||
|
const Dimension = Dimensions.Dimension;
|
||||||
|
|
||||||
|
pub fn Scalar(comptime T: type, comptime d: Dimensions, comptime s: Scales) type {
|
||||||
|
@setEvalBranchQuota(10_000_000);
|
||||||
|
return struct {
|
||||||
|
value: T,
|
||||||
|
|
||||||
|
const Self = @This();
|
||||||
|
pub const Vec3: type = Vector(3, Self);
|
||||||
|
pub const ValueType: type = T;
|
||||||
|
|
||||||
|
pub const dims: Dimensions = d;
|
||||||
|
pub const scales = s;
|
||||||
|
|
||||||
|
pub inline fn add(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims,
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
if (comptime !dims.eql(@TypeOf(rhs).dims))
|
||||||
|
@compileError("Dimension mismatch in add: " ++ dims.str() ++ " vs " ++ @TypeOf(rhs).dims.str());
|
||||||
|
if (comptime @TypeOf(rhs) == Self)
|
||||||
|
return .{ .value = self.value + rhs.value };
|
||||||
|
|
||||||
|
const TargetType = Scalar(T, dims, scales.min(@TypeOf(rhs).scales));
|
||||||
|
const lhs_val = if (comptime @TypeOf(self) == TargetType) self.value else self.to(TargetType).value;
|
||||||
|
const rhs_val = if (comptime @TypeOf(rhs) == TargetType) rhs.value else rhs.to(TargetType).value;
|
||||||
|
|
||||||
|
return .{ .value = lhs_val + rhs_val };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn sub(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims,
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
if (comptime !dims.eql(@TypeOf(rhs).dims))
|
||||||
|
@compileError("Dimension mismatch in sub: " ++ dims.str() ++ " vs " ++ @TypeOf(rhs).dims.str());
|
||||||
|
if (comptime @TypeOf(rhs) == Self)
|
||||||
|
return .{ .value = self.value - rhs.value };
|
||||||
|
|
||||||
|
const TargetType = Scalar(T, dims, scales.min(@TypeOf(rhs).scales));
|
||||||
|
const lhs_val = if (comptime @TypeOf(self) == TargetType) self.value else self.to(TargetType).value;
|
||||||
|
const rhs_val = if (comptime @TypeOf(rhs) == TargetType) rhs.value else rhs.to(TargetType).value;
|
||||||
|
|
||||||
|
return .{ .value = lhs_val - rhs_val };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn mulBy(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims.add(@TypeOf(rhs).dims),
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
const RhsType = @TypeOf(rhs);
|
||||||
|
const SelfNorm = Scalar(T, dims, scales.min(RhsType.scales));
|
||||||
|
const RhsNorm = Scalar(T, RhsType.dims, scales.min(RhsType.scales));
|
||||||
|
if (comptime Self == SelfNorm and RhsType == RhsNorm)
|
||||||
|
return .{ .value = self.value * rhs.value };
|
||||||
|
|
||||||
|
const lhs_val = if (comptime Self == SelfNorm) self.value else self.to(SelfNorm).value;
|
||||||
|
const rhs_val = if (comptime RhsType == RhsNorm) rhs.value else rhs.to(RhsNorm).value;
|
||||||
|
return .{ .value = lhs_val * rhs_val };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn divBy(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims.sub(@TypeOf(rhs).dims),
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
const RhsType = @TypeOf(rhs);
|
||||||
|
const SelfNorm = Scalar(T, dims, scales.min(RhsType.scales));
|
||||||
|
const RhsNorm = Scalar(T, RhsType.dims, scales.min(RhsType.scales));
|
||||||
|
const lhs_val = if (comptime Self == SelfNorm) self.value else self.to(SelfNorm).value;
|
||||||
|
const rhs_val = if (comptime RhsType == RhsNorm) rhs.value else rhs.to(RhsNorm).value;
|
||||||
|
if (comptime @typeInfo(T) == .int) {
|
||||||
|
return .{ .value = @divTrunc(lhs_val, rhs_val) };
|
||||||
|
} else {
|
||||||
|
return .{ .value = lhs_val / rhs_val };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn to(self: Self, comptime Dest: type) Dest {
|
||||||
|
if (comptime !dims.eql(Dest.dims))
|
||||||
|
@compileError("Dimension mismatch in to: " ++ dims.str() ++ " vs " ++ Dest.dims.str());
|
||||||
|
if (comptime @TypeOf(self) == Dest)
|
||||||
|
return self;
|
||||||
|
|
||||||
|
const DestT = Dest.ValueType;
|
||||||
|
const ratio = comptime (scales.getFactor(dims) / Dest.scales.getFactor(Dest.dims));
|
||||||
|
|
||||||
|
// Fast-path: Native pure-integer exact conversions
|
||||||
|
if (comptime @typeInfo(T) == .int and @typeInfo(DestT) == .int) {
|
||||||
|
if (comptime ratio >= 1.0 and @round(ratio) == ratio) {
|
||||||
|
const mult: DestT = comptime @intFromFloat(ratio);
|
||||||
|
return .{ .value = @as(DestT, @intCast(self.value)) * mult };
|
||||||
|
} else if (comptime ratio < 1.0 and @round(1.0 / ratio) == 1.0 / ratio) {
|
||||||
|
const div: DestT = comptime @intFromFloat(1.0 / ratio);
|
||||||
|
const val = @as(DestT, @intCast(self.value));
|
||||||
|
const half = comptime div / 2;
|
||||||
|
// Native round-to-nearest
|
||||||
|
const rounded = if (val >= 0) @divTrunc(val + half, div) else @divTrunc(val - half, div);
|
||||||
|
return .{ .value = rounded };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback preserving native Float types (e.g., f128 shouldn't downcast to f64)
|
||||||
|
if (comptime @typeInfo(DestT) == .float) {
|
||||||
|
const val_f = switch (@typeInfo(T)) {
|
||||||
|
inline .int => @as(DestT, @floatFromInt(self.value)),
|
||||||
|
inline .float => @as(DestT, @floatCast(self.value)),
|
||||||
|
else => unreachable,
|
||||||
|
};
|
||||||
|
return .{ .value = val_f * @as(DestT, @floatCast(ratio)) };
|
||||||
|
} else {
|
||||||
|
const val_f = switch (@typeInfo(T)) {
|
||||||
|
inline .int => @as(f64, @floatFromInt(self.value)),
|
||||||
|
inline .float => @as(f64, @floatCast(self.value)),
|
||||||
|
else => unreachable,
|
||||||
|
};
|
||||||
|
return .{ .value = @intFromFloat(@round(val_f * ratio)) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn Vec(self: Self, comptime len: comptime_int) Vector(len, Self) {
|
||||||
|
return Vector(len, Self).initDefault(self.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn vec3(self: Self) Vec3 {
|
||||||
|
return Vec3.initDefault(self.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn formatNumber(
|
||||||
|
self: Self,
|
||||||
|
writer: *std.Io.Writer,
|
||||||
|
options: std.fmt.Number,
|
||||||
|
) !void {
|
||||||
|
switch (@typeInfo(T)) {
|
||||||
|
.float, .comptime_float => try writer.printFloat(self.value, options),
|
||||||
|
.int, .comptime_int => try writer.printInt(self.value, 10, .lower, .{
|
||||||
|
.width = options.width,
|
||||||
|
.alignment = options.alignment,
|
||||||
|
.fill = options.fill,
|
||||||
|
.precision = options.precision,
|
||||||
|
}),
|
||||||
|
else => unreachable,
|
||||||
|
}
|
||||||
|
var first = true;
|
||||||
|
inline for (std.enums.values(Dimension)) |bu| {
|
||||||
|
const v = dims.get(bu);
|
||||||
|
if (comptime v == 0) continue;
|
||||||
|
if (!first)
|
||||||
|
try writer.writeAll(".");
|
||||||
|
|
||||||
|
first = false;
|
||||||
|
|
||||||
|
const uscale = scales.get(bu);
|
||||||
|
if (bu == .T and (uscale == .min or uscale == .hour or uscale == .year))
|
||||||
|
try writer.print("{s}", .{uscale.str()})
|
||||||
|
else
|
||||||
|
try writer.print("{s}{s}", .{ uscale.str(), bu.unit() });
|
||||||
|
|
||||||
|
if (v != 1)
|
||||||
|
try hlp.printSuperscript(writer, v);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Generate quantity" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = -3 }));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .n }));
|
||||||
|
|
||||||
|
const distance = Meter{ .value = 10 };
|
||||||
|
const time = Second{ .value = 2 };
|
||||||
|
|
||||||
|
try std.testing.expectEqual(10, distance.value);
|
||||||
|
try std.testing.expectEqual(2, time.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Add" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const distance = Meter{ .value = 10 };
|
||||||
|
const distance2 = Meter{ .value = 20 };
|
||||||
|
|
||||||
|
const added = distance.add(distance2);
|
||||||
|
try std.testing.expectEqual(30, added.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added).dims.get(.L));
|
||||||
|
|
||||||
|
const KiloMeter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const distance3 = KiloMeter{ .value = 2 };
|
||||||
|
const added2 = distance.add(distance3);
|
||||||
|
try std.testing.expectEqual(2010, added2.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added2).dims.get(.L));
|
||||||
|
|
||||||
|
const added3 = distance3.add(distance).to(KiloMeter);
|
||||||
|
try std.testing.expectEqual(2, added3.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added3).dims.get(.L));
|
||||||
|
|
||||||
|
const KiloMeter_f = Scalar(f64, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const distance4 = KiloMeter_f{ .value = 2 };
|
||||||
|
const added4 = distance4.add(distance).to(KiloMeter_f);
|
||||||
|
try std.testing.expectApproxEqAbs(2.01, added4.value, 0.000001);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added4).dims.get(.L));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Sub" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const KiloMeter_f = Scalar(f64, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
|
||||||
|
const a = Meter{ .value = 500 };
|
||||||
|
const b = Meter{ .value = 200 };
|
||||||
|
const diff = a.sub(b);
|
||||||
|
try std.testing.expectEqual(300, diff.value);
|
||||||
|
const diff2 = b.sub(a);
|
||||||
|
try std.testing.expectEqual(-300, diff2.value);
|
||||||
|
|
||||||
|
const km_f = KiloMeter_f{ .value = 2.5 };
|
||||||
|
const m_f = Meter{ .value = 500 };
|
||||||
|
const diff3 = km_f.sub(m_f);
|
||||||
|
try std.testing.expectApproxEqAbs(2000, diff3.value, 1e-4);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 3.0 };
|
||||||
|
const t = Second{ .value = 4.0 };
|
||||||
|
|
||||||
|
const area_time = d.mulBy(t);
|
||||||
|
try std.testing.expectEqual(12, area_time.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
||||||
|
|
||||||
|
const d2 = Meter{ .value = 5.0 };
|
||||||
|
const area = d.mulBy(d2);
|
||||||
|
try std.testing.expectEqual(15, area.value);
|
||||||
|
try std.testing.expectEqual(2, @TypeOf(area).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(0, @TypeOf(area).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy with scale" {
|
||||||
|
const KiloMeter = Scalar(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const KiloGram = Scalar(f32, Dimensions.init(.{ .M = 1 }), Scales.init(.{ .M = .k }));
|
||||||
|
|
||||||
|
const dist = KiloMeter{ .value = 2.0 };
|
||||||
|
const mass = KiloGram{ .value = 3.0 };
|
||||||
|
const prod = dist.mulBy(mass);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(prod).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(prod).dims.get(.M));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy with type change" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const Second = Scalar(f64, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
const KmSec = Scalar(i64, Dimensions.init(.{ .L = 1, .T = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const KmSec_f = Scalar(f32, Dimensions.init(.{ .L = 1, .T = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 3.0 };
|
||||||
|
const t = Second{ .value = 4.0 };
|
||||||
|
|
||||||
|
const area_time = d.mulBy(t).to(KmSec);
|
||||||
|
const area_time_f = d.mulBy(t).to(KmSec_f);
|
||||||
|
try std.testing.expectEqual(12, area_time.value);
|
||||||
|
try std.testing.expectApproxEqAbs(12, area_time_f.value, 0.0001);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy small" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .n }));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 3.0 };
|
||||||
|
const t = Second{ .value = 4.0 };
|
||||||
|
|
||||||
|
const area_time = d.mulBy(t);
|
||||||
|
try std.testing.expectEqual(12, area_time.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy dimensionless" {
|
||||||
|
const DimLess = Scalar(i128, Dimensions.init(.{}), Scales.init(.{}));
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 7 };
|
||||||
|
const scaled = d.mulBy(DimLess{ .value = 3 });
|
||||||
|
try std.testing.expectEqual(21, scaled.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(scaled).dims.get(.L));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Chained: velocity and acceleration" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const dist = Meter{ .value = 100.0 };
|
||||||
|
const t1 = Second{ .value = 5.0 };
|
||||||
|
const velocity = dist.divBy(t1);
|
||||||
|
try std.testing.expectEqual(20, velocity.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(velocity).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-1, @TypeOf(velocity).dims.get(.T));
|
||||||
|
|
||||||
|
const t2 = Second{ .value = 4.0 };
|
||||||
|
const accel = velocity.divBy(t2);
|
||||||
|
try std.testing.expectEqual(5, accel.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(accel).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-2, @TypeOf(accel).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "DivBy integer exact" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const dist = Meter{ .value = 120 };
|
||||||
|
const time = Second{ .value = 4 };
|
||||||
|
const vel = dist.divBy(time);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(30, vel.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(vel).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-1, @TypeOf(vel).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Conversion chain: km -> m -> cm" {
|
||||||
|
const KiloMeter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const CentiMeter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .c }));
|
||||||
|
|
||||||
|
const km = KiloMeter{ .value = 15 };
|
||||||
|
const m = km.to(Meter);
|
||||||
|
const cm = m.to(CentiMeter);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(15_000, m.value);
|
||||||
|
try std.testing.expectEqual(1_500_000, cm.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Conversion: hours -> minutes -> seconds" {
|
||||||
|
const Hour = Scalar(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .hour }));
|
||||||
|
const Minute = Scalar(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .min }));
|
||||||
|
const Second = Scalar(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const h = Hour{ .value = 1.0 };
|
||||||
|
const min = h.to(Minute);
|
||||||
|
const sec = min.to(Second);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(60, min.value);
|
||||||
|
try std.testing.expectEqual(3600, sec.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Negative values" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const a = Meter{ .value = 5 };
|
||||||
|
const b = Meter{ .value = 20 };
|
||||||
|
const diff = a.sub(b);
|
||||||
|
try std.testing.expectEqual(-15, diff.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Format Scalar" {
|
||||||
|
const MeterPerSecondSq = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .L = 1, .T = -2 }),
|
||||||
|
Scales.init(.{ .T = .n }),
|
||||||
|
);
|
||||||
|
const KgMeterPerSecond = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .M = 1, .L = 1, .T = -1 }),
|
||||||
|
Scales.init(.{ .M = .k }),
|
||||||
|
);
|
||||||
|
const Meter = Scalar(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const m = Meter{ .value = 1.23456 };
|
||||||
|
const accel = MeterPerSecondSq{ .value = 9.81 };
|
||||||
|
const momentum = KgMeterPerSecond{ .value = 42.0 };
|
||||||
|
|
||||||
|
var buf: [64]u8 = undefined;
|
||||||
|
var res = try std.fmt.bufPrint(&buf, "{d:.2}", .{m});
|
||||||
|
try std.testing.expectEqualStrings("1.23m", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d}", .{accel});
|
||||||
|
try std.testing.expectEqualStrings("9.81m.ns⁻²", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d}", .{momentum});
|
||||||
|
try std.testing.expectEqualStrings("42m.kg.s⁻¹", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d:_>10.1}", .{m});
|
||||||
|
try std.testing.expectEqualStrings("_______1.2m", res);
|
||||||
|
}
|
||||||
+7
-7
@@ -3,7 +3,7 @@ const hlp = @import("helper.zig");
|
|||||||
const Dimensions = @import("Dimensions.zig");
|
const Dimensions = @import("Dimensions.zig");
|
||||||
const Dimension = @import("Dimensions.zig").Dimension;
|
const Dimension = @import("Dimensions.zig").Dimension;
|
||||||
|
|
||||||
pub const UnitScale = enum(i32) {
|
pub const UnitScale = enum(isize) {
|
||||||
P = 15,
|
P = 15,
|
||||||
T = 12,
|
T = 12,
|
||||||
G = 9,
|
G = 9,
|
||||||
@@ -28,7 +28,7 @@ pub const UnitScale = enum(i32) {
|
|||||||
// Undefined
|
// Undefined
|
||||||
_,
|
_,
|
||||||
|
|
||||||
pub fn str(self: @This()) []const u8 {
|
pub inline fn str(self: @This()) []const u8 {
|
||||||
var buf: [16]u8 = undefined;
|
var buf: [16]u8 = undefined;
|
||||||
return switch (self) {
|
return switch (self) {
|
||||||
inline .none => "",
|
inline .none => "",
|
||||||
@@ -38,7 +38,7 @@ pub const UnitScale = enum(i32) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Helper to get the actual scaling factor
|
/// Helper to get the actual scaling factor
|
||||||
pub fn getFactor(self: @This()) f64 {
|
pub inline fn getFactor(self: @This()) comptime_float {
|
||||||
return switch (self) {
|
return switch (self) {
|
||||||
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))),
|
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))),
|
||||||
inline else => @floatFromInt(@intFromEnum(self)),
|
inline else => @floatFromInt(@intFromEnum(self)),
|
||||||
@@ -46,10 +46,10 @@ pub const UnitScale = enum(i32) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Helper to get the actual scaling factor in i32
|
/// Helper to get the actual scaling factor in i32
|
||||||
pub fn getFactorInt(self: @This()) i32 {
|
pub inline fn getFactorInt(self: @This()) comptime_int {
|
||||||
return switch (self) {
|
return switch (self) {
|
||||||
inline .P, .T, .G, .M, .k, .h, .da, .none, .d, .c, .m, .u, .n, .p, .f => std.math.powi(i32, 10.0, @intFromEnum(self)) catch 0,
|
inline .P, .T, .G, .M, .k, .h, .da, .none, .d, .c, .m, .u, .n, .p, .f => comptime std.math.powi(i32, 10.0, @intFromEnum(self)) catch 0,
|
||||||
inline else => @intFromEnum(self),
|
inline else => comptime @intFromEnum(self),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@@ -89,7 +89,7 @@ pub fn min(comptime s1: Scales, comptime s2: Scales) Scales {
|
|||||||
return out;
|
return out;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn getFactor(comptime s: Scales, comptime d: Dimensions) f64 {
|
pub inline fn getFactor(comptime s: Scales, comptime d: Dimensions) comptime_float {
|
||||||
comptime var factor: f64 = 1.0;
|
comptime var factor: f64 = 1.0;
|
||||||
inline for (std.enums.values(Dimension)) |dim| {
|
inline for (std.enums.values(Dimension)) |dim| {
|
||||||
const power = d.get(dim);
|
const power = d.get(dim);
|
||||||
|
|||||||
+318
@@ -0,0 +1,318 @@
|
|||||||
|
const std = @import("std");
|
||||||
|
const hlp = @import("helper.zig");
|
||||||
|
|
||||||
|
const Scalar = @import("Scalar.zig").Scalar;
|
||||||
|
const Scales = @import("Scales.zig");
|
||||||
|
const UnitScale = Scales.UnitScale;
|
||||||
|
const Dimensions = @import("Dimensions.zig");
|
||||||
|
const Dimension = Dimensions.Dimension;
|
||||||
|
|
||||||
|
pub fn Vector(comptime len: usize, comptime Q: type) type {
|
||||||
|
const T = Q.ValueType;
|
||||||
|
const d: Dimensions = Q.dims;
|
||||||
|
const s: Scales = Q.scales;
|
||||||
|
|
||||||
|
return struct {
|
||||||
|
data: [len]T,
|
||||||
|
|
||||||
|
const Self = @This();
|
||||||
|
pub const ScalarType = Q;
|
||||||
|
pub const ValueType = T;
|
||||||
|
pub const dims: Dimensions = d;
|
||||||
|
pub const scales = s;
|
||||||
|
|
||||||
|
pub const zero = initDefault(0);
|
||||||
|
pub const one = initDefault(1);
|
||||||
|
|
||||||
|
pub fn initDefault(v: T) Self {
|
||||||
|
var data: [len]T = undefined;
|
||||||
|
inline for (&data) |*item| item.* = v;
|
||||||
|
return .{ .data = data };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn add(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).add(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn sub(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).sub(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn divBy(
|
||||||
|
self: Self,
|
||||||
|
rhs: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.sub(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d.sub(Tr.dims), s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).divBy(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn mulBy(
|
||||||
|
self: Self,
|
||||||
|
rhs: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.add(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d.add(Tr.dims), s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).mulBy(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn divByScalar(
|
||||||
|
self: Self,
|
||||||
|
scalar: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) {
|
||||||
|
var res: Vector(len, Scalar(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = Q{ .value = v };
|
||||||
|
res.data[i] = q.divBy(scalar).value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn mulByScalar(
|
||||||
|
self: Self,
|
||||||
|
scalar: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) {
|
||||||
|
var res: Vector(len, Scalar(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = Q{ .value = v };
|
||||||
|
res.data[i] = q.mulBy(scalar).value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn negate(self: Self) Self {
|
||||||
|
var res: Self = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
res.data[i] = -v;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn to(self: Self, comptime DestQ: type) Vector(len, DestQ) {
|
||||||
|
var res: Vector(len, DestQ) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
res.data[i] = (Q{ .value = v }).to(DestQ).value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn lengthSqr(self: Self) T {
|
||||||
|
var sum: T = 0;
|
||||||
|
inline for (self.data) |v| {
|
||||||
|
sum += v * v;
|
||||||
|
}
|
||||||
|
return sum;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn length(self: Self) T {
|
||||||
|
const len_sq = self.lengthSqr();
|
||||||
|
|
||||||
|
if (comptime @typeInfo(T) == .int) {
|
||||||
|
// Construct the unsigned equivalent of T at comptime (e.g., i32 -> u32)
|
||||||
|
const UnsignedT = @Int(.unsigned, @typeInfo(T).int.bits);
|
||||||
|
|
||||||
|
// len_sq is always positive, so @intCast is perfectly safe
|
||||||
|
const u_len_sq = @as(UnsignedT, @intCast(len_sq));
|
||||||
|
return @as(T, @intCast(std.math.sqrt(u_len_sq)));
|
||||||
|
} else {
|
||||||
|
return @sqrt(len_sq);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn formatNumber(
|
||||||
|
self: Self,
|
||||||
|
writer: *std.Io.Writer,
|
||||||
|
options: std.fmt.Number,
|
||||||
|
) !void {
|
||||||
|
try writer.writeAll("(");
|
||||||
|
for (self.data, 0..) |v, i| {
|
||||||
|
if (i > 0) try writer.writeAll(", ");
|
||||||
|
switch (@typeInfo(T)) {
|
||||||
|
.float, .comptime_float => try writer.printFloat(v, options),
|
||||||
|
.int, .comptime_int => try writer.printInt(v, 10, .lower, .{
|
||||||
|
.width = options.width,
|
||||||
|
.alignment = options.alignment,
|
||||||
|
.fill = options.fill,
|
||||||
|
.precision = options.precision,
|
||||||
|
}),
|
||||||
|
else => unreachable,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
try writer.writeAll(")");
|
||||||
|
var first = true;
|
||||||
|
inline for (std.enums.values(Dimension)) |bu| {
|
||||||
|
const v = dims.get(bu);
|
||||||
|
if (comptime v == 0) continue;
|
||||||
|
if (!first)
|
||||||
|
try writer.writeAll(".");
|
||||||
|
|
||||||
|
first = false;
|
||||||
|
|
||||||
|
const uscale = scales.get(bu);
|
||||||
|
if (bu == .T and (uscale == .min or uscale == .hour or uscale == .year))
|
||||||
|
try writer.print("{s}", .{uscale.str()})
|
||||||
|
else
|
||||||
|
try writer.print("{s}{s}", .{ uscale.str(), bu.unit() });
|
||||||
|
|
||||||
|
if (v != 1)
|
||||||
|
try hlp.printSuperscript(writer, v);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Format VectorX" {
|
||||||
|
const MeterPerSecondSq = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .L = 1, .T = -2 }),
|
||||||
|
Scales.init(.{ .T = .n }),
|
||||||
|
);
|
||||||
|
const KgMeterPerSecond = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .M = 1, .L = 1, .T = -1 }),
|
||||||
|
Scales.init(.{ .M = .k }),
|
||||||
|
);
|
||||||
|
|
||||||
|
const accel = MeterPerSecondSq.Vec3.initDefault(9.81);
|
||||||
|
const momentum = KgMeterPerSecond.Vec3{ .data = .{ 43, 0, 11 } };
|
||||||
|
|
||||||
|
var buf: [64]u8 = undefined;
|
||||||
|
var res = try std.fmt.bufPrint(&buf, "{d}", .{accel});
|
||||||
|
try std.testing.expectEqualStrings("(9.81, 9.81, 9.81)m.ns⁻²", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d:.2}", .{momentum});
|
||||||
|
try std.testing.expectEqualStrings("(43.00, 0.00, 11.00)m.kg.s⁻¹", res);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Init and Basic Arithmetic" {
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Vec3M = Meter.Vec3;
|
||||||
|
|
||||||
|
// Test zero, one, initDefault
|
||||||
|
const v_zero = Vec3M.zero;
|
||||||
|
try std.testing.expectEqual(0, v_zero.data[0]);
|
||||||
|
try std.testing.expectEqual(0, v_zero.data[1]);
|
||||||
|
try std.testing.expectEqual(0, v_zero.data[2]);
|
||||||
|
|
||||||
|
const v_one = Vec3M.one;
|
||||||
|
try std.testing.expectEqual(1, v_one.data[0]);
|
||||||
|
try std.testing.expectEqual(1, v_one.data[1]);
|
||||||
|
try std.testing.expectEqual(1, v_one.data[2]);
|
||||||
|
|
||||||
|
const v_def = Vec3M.initDefault(5);
|
||||||
|
try std.testing.expectEqual(5, v_def.data[0]);
|
||||||
|
try std.testing.expectEqual(5, v_def.data[1]);
|
||||||
|
try std.testing.expectEqual(5, v_def.data[2]);
|
||||||
|
|
||||||
|
// Test add and sub
|
||||||
|
const v1 = Vec3M{ .data = .{ 10, 20, 30 } };
|
||||||
|
const v2 = Vec3M{ .data = .{ 2, 4, 6 } };
|
||||||
|
|
||||||
|
const added = v1.add(v2);
|
||||||
|
try std.testing.expectEqual(12, added.data[0]);
|
||||||
|
try std.testing.expectEqual(24, added.data[1]);
|
||||||
|
try std.testing.expectEqual(36, added.data[2]);
|
||||||
|
|
||||||
|
const subbed = v1.sub(v2);
|
||||||
|
try std.testing.expectEqual(8, subbed.data[0]);
|
||||||
|
try std.testing.expectEqual(16, subbed.data[1]);
|
||||||
|
try std.testing.expectEqual(24, subbed.data[2]);
|
||||||
|
|
||||||
|
// Test negate
|
||||||
|
const neg = v1.negate();
|
||||||
|
try std.testing.expectEqual(-10, neg.data[0]);
|
||||||
|
try std.testing.expectEqual(-20, neg.data[1]);
|
||||||
|
try std.testing.expectEqual(-30, neg.data[2]);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Kinematics (Scalar Mul/Div)" {
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(i32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
const Vec3M = Meter.Vec3;
|
||||||
|
|
||||||
|
const pos = Vec3M{ .data = .{ 100, 200, 300 } };
|
||||||
|
const time = Second{ .value = 10 };
|
||||||
|
|
||||||
|
// Vector divided by scalar (Velocity = Position / Time)
|
||||||
|
const vel = pos.divByScalar(time);
|
||||||
|
try std.testing.expectEqual(10, vel.data[0]);
|
||||||
|
try std.testing.expectEqual(20, vel.data[1]);
|
||||||
|
try std.testing.expectEqual(30, vel.data[2]);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(vel).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-1, @TypeOf(vel).dims.get(.T));
|
||||||
|
|
||||||
|
// Vector multiplied by scalar (Position = Velocity * Time)
|
||||||
|
const new_pos = vel.mulByScalar(time);
|
||||||
|
try std.testing.expectEqual(100, new_pos.data[0]);
|
||||||
|
try std.testing.expectEqual(200, new_pos.data[1]);
|
||||||
|
try std.testing.expectEqual(300, new_pos.data[2]);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(new_pos).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(0, @TypeOf(new_pos).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Element-wise Math and Scaling" {
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Vec3M = Meter.Vec3;
|
||||||
|
|
||||||
|
const v1 = Vec3M{ .data = .{ 10, 20, 30 } };
|
||||||
|
const v2 = Vec3M{ .data = .{ 2, 5, 10 } };
|
||||||
|
|
||||||
|
// Element-wise division
|
||||||
|
const div = v1.divBy(v2);
|
||||||
|
try std.testing.expectEqual(5, div.data[0]);
|
||||||
|
try std.testing.expectEqual(4, div.data[1]);
|
||||||
|
try std.testing.expectEqual(3, div.data[2]);
|
||||||
|
try std.testing.expectEqual(0, @TypeOf(div).dims.get(.L)); // M / M = Dimensionless
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Conversions" {
|
||||||
|
const KiloMeter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const v_km = KiloMeter.Vec3{ .data = .{ 1, 2, 3 } };
|
||||||
|
const v_m = v_km.to(Meter);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(1000, v_m.data[0]);
|
||||||
|
try std.testing.expectEqual(2000, v_m.data[1]);
|
||||||
|
try std.testing.expectEqual(3000, v_m.data[2]);
|
||||||
|
|
||||||
|
// Type checking the result
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(v_m).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(UnitScale.none, @TypeOf(v_m).scales.get(.L));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Length" {
|
||||||
|
const MeterInt = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const MeterFloat = Scalar(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
// Integer length (using your custom isqrt)
|
||||||
|
// 3-4-5 triangle on XY plane
|
||||||
|
const v_int = MeterInt.Vec3{ .data = .{ 3, 4, 0 } };
|
||||||
|
try std.testing.expectEqual(25, v_int.lengthSqr());
|
||||||
|
try std.testing.expectEqual(5, v_int.length());
|
||||||
|
|
||||||
|
// Float length
|
||||||
|
const v_float = MeterFloat.Vec3{ .data = .{ 3.0, 4.0, 0.0 } };
|
||||||
|
try std.testing.expectApproxEqAbs(@as(f32, 25.0), v_float.lengthSqr(), 1e-4);
|
||||||
|
try std.testing.expectApproxEqAbs(@as(f32, 5.0), v_float.length(), 1e-4);
|
||||||
|
}
|
||||||
@@ -0,0 +1,429 @@
|
|||||||
|
const std = @import("std");
|
||||||
|
const Io = std.Io;
|
||||||
|
const Scalar = @import("Scalar.zig").Scalar;
|
||||||
|
const Vector = @import("Vector.zig").Vector;
|
||||||
|
|
||||||
|
var io: Io = undefined;
|
||||||
|
pub fn main(init: std.process.Init) !void {
|
||||||
|
var stdout_buf: [4096]u8 = undefined;
|
||||||
|
var stdout_writer: std.Io.File.Writer = .init(.stdout(), init.io, &stdout_buf);
|
||||||
|
try stdout_writer.interface.print("Starting Benchmarks...", .{});
|
||||||
|
|
||||||
|
io = init.io;
|
||||||
|
|
||||||
|
try bench_Scalar(&stdout_writer.interface);
|
||||||
|
try stdout_writer.flush();
|
||||||
|
try bench_vsNative(&stdout_writer.interface);
|
||||||
|
try stdout_writer.flush();
|
||||||
|
try bench_crossTypeVsNative(&stdout_writer.interface);
|
||||||
|
try stdout_writer.flush();
|
||||||
|
try bench_Vector(&stdout_writer.interface);
|
||||||
|
try stdout_writer.flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
fn getTime() Io.Timestamp {
|
||||||
|
return Io.Clock.awake.now(io);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn fold(comptime TT: type, s: *f64, v: TT) void {
|
||||||
|
s.* += if (comptime @typeInfo(TT) == .float)
|
||||||
|
@as(f64, @floatCast(v))
|
||||||
|
else
|
||||||
|
@as(f64, @floatFromInt(v));
|
||||||
|
}
|
||||||
|
|
||||||
|
fn bench_Scalar(writer: *std.Io.Writer) !void {
|
||||||
|
const ITERS: usize = 100_000;
|
||||||
|
const SAMPLES: usize = 10;
|
||||||
|
|
||||||
|
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 Stats = struct {
|
||||||
|
median: f64,
|
||||||
|
delta: f64,
|
||||||
|
ops_per_sec: f64,
|
||||||
|
};
|
||||||
|
|
||||||
|
const computeStats = struct {
|
||||||
|
fn f(samples: []f64, iters: usize) Stats {
|
||||||
|
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];
|
||||||
|
|
||||||
|
const low = samples[0];
|
||||||
|
const high = samples[samples.len - 1];
|
||||||
|
const delta_ns = (high - low) / 2.0;
|
||||||
|
|
||||||
|
const ns_per_op = median_ns / @as(f64, @floatFromInt(iters));
|
||||||
|
return .{
|
||||||
|
.median = ns_per_op,
|
||||||
|
.delta = (delta_ns / @as(f64, @floatFromInt(iters))),
|
||||||
|
.ops_per_sec = 1_000_000_000.0 / ns_per_op,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}.f;
|
||||||
|
|
||||||
|
try writer.print(
|
||||||
|
\\
|
||||||
|
\\ Scalar<T> benchmark — {d} iterations, {d} samples/cell
|
||||||
|
\\
|
||||||
|
\\┌───────────────────┬──────┬─────────────────────┬─────────────────────┐
|
||||||
|
\\│ Operation │ Type │ ns / op (± delta) │ Throughput (ops/s) │
|
||||||
|
\\├───────────────────┼──────┼─────────────────────┼─────────────────────┤
|
||||||
|
\\
|
||||||
|
, .{ ITERS, SAMPLES });
|
||||||
|
|
||||||
|
const Types = .{ i16, i32, i64, i128, i256, f32, f64, f128 };
|
||||||
|
const TNames = .{ "i16", "i32", "i64", "i128", "i256", "f32", "f64", "f128" };
|
||||||
|
const Ops = .{ "add", "sub", "mulBy", "divBy", "to" };
|
||||||
|
|
||||||
|
var results_matrix: [Ops.len][Types.len]f64 = undefined;
|
||||||
|
|
||||||
|
comptime var tidx: usize = 0;
|
||||||
|
inline for (Types, TNames) |T, tname| {
|
||||||
|
const M = Scalar(T, .init(.{ .L = 1 }), .init(.{}));
|
||||||
|
const KM = Scalar(T, .init(.{ .L = 1 }), .init(.{ .L = .k }));
|
||||||
|
const S = Scalar(T, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
|
||||||
|
inline for (Ops, 0..) |op_name, oidx| {
|
||||||
|
var samples: [SAMPLES]f64 = undefined;
|
||||||
|
|
||||||
|
for (0..SAMPLES) |s_idx| {
|
||||||
|
const t_start = getTime();
|
||||||
|
|
||||||
|
for (0..ITERS) |i| {
|
||||||
|
std.mem.doNotOptimizeAway(
|
||||||
|
{
|
||||||
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
|
(M{ .value = getVal(T, i, 63) }).add(M{ .value = getVal(T, i +% 7, 63) })
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
||||||
|
(M{ .value = getVal(T, i +% 10, 63) }).sub(M{ .value = getVal(T, i, 63) })
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
|
(M{ .value = getVal(T, i, 63) }).mulBy(M{ .value = getVal(T, i +% 1, 63) })
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "divBy"))
|
||||||
|
(M{ .value = getVal(T, i +% 10, 63) }).divBy(S{ .value = getVal(T, i, 63) })
|
||||||
|
else
|
||||||
|
(KM{ .value = getVal(T, i, 15) }).to(M);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const t_end = getTime();
|
||||||
|
samples[s_idx] = @as(f64, @floatFromInt(t_start.durationTo(t_end).toNanoseconds()));
|
||||||
|
}
|
||||||
|
|
||||||
|
const stats = computeStats(&samples, ITERS);
|
||||||
|
results_matrix[oidx][tidx] = stats.median;
|
||||||
|
|
||||||
|
try writer.print("│ {s:<17} │ {s:<4} │ {d:>8.2} ns ±{d:<6.2} │ {d:>19.0} │\n", .{ op_name, tname, stats.median, stats.delta, stats.ops_per_sec });
|
||||||
|
}
|
||||||
|
|
||||||
|
if (comptime tidx < Types.len - 1) {
|
||||||
|
try writer.print("├───────────────────┼──────┼─────────────────────┼─────────────────────┤\n", .{});
|
||||||
|
}
|
||||||
|
tidx += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Median Summary Table
|
||||||
|
try writer.print("└───────────────────┴──────┴─────────────────────┴─────────────────────┘\n\n", .{});
|
||||||
|
try writer.print("Median Summary (ns/op):\n", .{});
|
||||||
|
|
||||||
|
try writer.print("┌──────────────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┐\n", .{});
|
||||||
|
try writer.print("│ Operation │ i16 │ i32 │ i64 │ i128 │ i256 │ f32 │ f64 │ f128 │\n", .{});
|
||||||
|
try writer.print("├──────────────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┤\n", .{});
|
||||||
|
|
||||||
|
inline for (Ops, 0..) |op_name, oidx| {
|
||||||
|
try writer.print("│ {s:<11} │", .{op_name});
|
||||||
|
var i: usize = 0;
|
||||||
|
while (i < Types.len) : (i += 1)
|
||||||
|
try writer.print("{d:>6.1} │", .{results_matrix[oidx][i]});
|
||||||
|
|
||||||
|
try writer.print("\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
|
try writer.print("└──────────────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┘\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn bench_vsNative(writer: *std.Io.Writer) !void {
|
||||||
|
const ITERS: usize = 100_000;
|
||||||
|
const SAMPLES: usize = 5;
|
||||||
|
|
||||||
|
// Helper to safely get a value of type T from a loop index
|
||||||
|
const getValT = struct {
|
||||||
|
fn f(comptime TT: type, i: usize) TT {
|
||||||
|
const v = (i % 100) + 1;
|
||||||
|
return if (comptime @typeInfo(TT) == .float) @floatFromInt(v) else @intCast(v);
|
||||||
|
}
|
||||||
|
}.f;
|
||||||
|
|
||||||
|
const Types = .{ i32, i64, i128, f32, f64 };
|
||||||
|
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
||||||
|
const Ops = .{ "add", "mulBy", "divBy" };
|
||||||
|
|
||||||
|
try writer.print(
|
||||||
|
\\
|
||||||
|
\\ Scalar vs Native Overhead Analysis
|
||||||
|
\\
|
||||||
|
\\┌───────────┬──────┬───────────┬───────────┬───────────┐
|
||||||
|
\\│ Operation │ Type │ Native │ Scalar │ Slowdown │
|
||||||
|
\\├───────────┼──────┼───────────┼───────────┼───────────┤
|
||||||
|
\\
|
||||||
|
, .{});
|
||||||
|
|
||||||
|
inline for (Ops, 0..) |op_name, j| {
|
||||||
|
inline for (Types, 0..) |T, tidx| {
|
||||||
|
var native_total_ns: f64 = 0;
|
||||||
|
var quantity_total_ns: f64 = 0;
|
||||||
|
|
||||||
|
const M = Scalar(T, .init(.{ .L = 1 }), .init(.{}));
|
||||||
|
const S = Scalar(T, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
|
||||||
|
std.mem.doNotOptimizeAway({
|
||||||
|
for (0..SAMPLES) |_| {
|
||||||
|
// --- 1. Benchmark Native ---
|
||||||
|
const n_start = getTime();
|
||||||
|
for (0..ITERS) |i| {
|
||||||
|
const a = getValT(T, i);
|
||||||
|
const b = getValT(T, 2);
|
||||||
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
|
a + b
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
|
a * b
|
||||||
|
else if (comptime @typeInfo(T) == .int) @divTrunc(a, b) else a / b;
|
||||||
|
}
|
||||||
|
const n_end = getTime();
|
||||||
|
native_total_ns += @as(f64, @floatFromInt(n_start.durationTo(n_end).toNanoseconds()));
|
||||||
|
|
||||||
|
// --- 2. Benchmark Scalar ---
|
||||||
|
const q_start = getTime();
|
||||||
|
for (0..ITERS) |i| {
|
||||||
|
const qa = M{ .value = getValT(T, i) };
|
||||||
|
const qb = if (comptime std.mem.eql(u8, op_name, "divBy")) S{ .value = getValT(T, 2) } else M{ .value = getValT(T, 2) };
|
||||||
|
|
||||||
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
|
qa.add(qb)
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
|
qa.mulBy(qb)
|
||||||
|
else
|
||||||
|
qa.divBy(qb);
|
||||||
|
}
|
||||||
|
const q_end = getTime();
|
||||||
|
quantity_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const avg_n = (native_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
|
const avg_q = (quantity_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
|
const slowdown = avg_q / avg_n;
|
||||||
|
|
||||||
|
try writer.print("│ {s:<9} │ {s:<4} │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>8.2}x │\n", .{
|
||||||
|
op_name, TNames[tidx], avg_n, avg_q, slowdown,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if (j != Ops.len - 1) try writer.print("├───────────┼──────┼───────────┼───────────┼───────────┤\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
|
try writer.print("└───────────┴──────┴───────────┴───────────┴───────────┘\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
||||||
|
const ITERS: usize = 100_000;
|
||||||
|
const SAMPLES: usize = 5;
|
||||||
|
|
||||||
|
const getValT = struct {
|
||||||
|
fn f(comptime TT: type, i: usize) TT {
|
||||||
|
// Keep values safe and non-zero to avoid division by zero or overflows during cross-casting
|
||||||
|
const v = (i % 50) + 1;
|
||||||
|
return if (comptime @typeInfo(TT) == .float) @floatFromInt(v) else @intCast(v);
|
||||||
|
}
|
||||||
|
}.f;
|
||||||
|
|
||||||
|
// Helper for the Native baseline: explicitly casting T2 to T1 before the operation
|
||||||
|
const castTo = struct {
|
||||||
|
fn f(comptime DestT: type, comptime SrcT: type, val: SrcT) DestT {
|
||||||
|
if (comptime DestT == SrcT) return val;
|
||||||
|
const src_info = @typeInfo(SrcT);
|
||||||
|
const dest_info = @typeInfo(DestT);
|
||||||
|
|
||||||
|
if (dest_info == .int and src_info == .int) return @intCast(val);
|
||||||
|
if (dest_info == .float and src_info == .int) return @floatFromInt(val);
|
||||||
|
if (dest_info == .int and src_info == .float) return @intFromFloat(val);
|
||||||
|
if (dest_info == .float and src_info == .float) return @floatCast(val);
|
||||||
|
unreachable;
|
||||||
|
}
|
||||||
|
}.f;
|
||||||
|
|
||||||
|
const Types = .{ i16, i64, i128, f32, f64 };
|
||||||
|
const TNames = .{ "i16", "i64", "i128", "f32", "f64" };
|
||||||
|
const Ops = .{ "add", "mulBy", "divBy" };
|
||||||
|
|
||||||
|
try writer.print(
|
||||||
|
\\
|
||||||
|
\\ Cross-Type Overhead Analysis: Scalar vs Native
|
||||||
|
\\
|
||||||
|
\\┌─────────┬──────┬──────┬───────────┬───────────┬───────────┐
|
||||||
|
\\│ Op │ T1 │ T2 │ Native │ Scalar │ Slowdown │
|
||||||
|
\\├─────────┼──────┼──────┼───────────┼───────────┼───────────┤
|
||||||
|
\\
|
||||||
|
, .{});
|
||||||
|
|
||||||
|
inline for (Ops, 0..) |op_name, j| {
|
||||||
|
inline for (Types, 0..) |T1, t1_idx| {
|
||||||
|
inline for (Types, 0..) |T2, t2_idx| {
|
||||||
|
var native_total_ns: f64 = 0;
|
||||||
|
var quantity_total_ns: f64 = 0;
|
||||||
|
|
||||||
|
const M1 = Scalar(T1, .init(.{ .L = 1 }), .init(.{}));
|
||||||
|
const M2 = Scalar(T2, .init(.{ .L = 1 }), .init(.{}));
|
||||||
|
const S2 = Scalar(T2, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
|
||||||
|
std.mem.doNotOptimizeAway({
|
||||||
|
for (0..SAMPLES) |_| {
|
||||||
|
// --- 1. Benchmark Native (Cast T2 to T1, then math) ---
|
||||||
|
const n_start = getTime();
|
||||||
|
for (0..ITERS) |i| {
|
||||||
|
const a = getValT(T1, i);
|
||||||
|
const b_raw = getValT(T2, 2);
|
||||||
|
const b = castTo(T1, T2, b_raw);
|
||||||
|
|
||||||
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
|
a + b
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
|
a * b
|
||||||
|
else if (comptime @typeInfo(T1) == .int)
|
||||||
|
@divTrunc(a, b)
|
||||||
|
else
|
||||||
|
a / b;
|
||||||
|
}
|
||||||
|
const n_end = getTime();
|
||||||
|
native_total_ns += @as(f64, @floatFromInt(n_start.durationTo(n_end).toNanoseconds()));
|
||||||
|
|
||||||
|
// --- 2. Benchmark Scalar ---
|
||||||
|
const q_start = getTime();
|
||||||
|
for (0..ITERS) |i| {
|
||||||
|
const qa = M1{ .value = getValT(T1, i) };
|
||||||
|
const qb = if (comptime std.mem.eql(u8, op_name, "divBy"))
|
||||||
|
S2{ .value = getValT(T2, 2) }
|
||||||
|
else
|
||||||
|
M2{ .value = getValT(T2, 2) };
|
||||||
|
|
||||||
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
|
qa.add(qb)
|
||||||
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
|
qa.mulBy(qb)
|
||||||
|
else
|
||||||
|
qa.divBy(qb);
|
||||||
|
}
|
||||||
|
const q_end = getTime();
|
||||||
|
quantity_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
||||||
|
}
|
||||||
|
|
||||||
|
const avg_n = (native_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
|
const avg_q = (quantity_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
|
const slowdown = avg_q / avg_n;
|
||||||
|
|
||||||
|
try writer.print("│ {s:<7} │ {s:<4} │ {s:<4} │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>8.2}x │\n", .{
|
||||||
|
op_name, TNames[t1_idx], TNames[t2_idx], avg_n, avg_q, slowdown,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (j != Ops.len - 1) {
|
||||||
|
try writer.print("├─────────┼──────┼──────┼───────────┼───────────┼───────────┤\n", .{});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try writer.print("└─────────┴──────┴──────┴───────────┴───────────┴───────────┘\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn bench_Vector(writer: *std.Io.Writer) !void {
|
||||||
|
const ITERS: usize = 10_000;
|
||||||
|
const SAMPLES: usize = 10;
|
||||||
|
|
||||||
|
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(
|
||||||
|
\\
|
||||||
|
\\ Vector<N, T> benchmark — {d} iterations, {d} samples/cell
|
||||||
|
\\ (Results in ns/op)
|
||||||
|
\\
|
||||||
|
\\┌─────────────┬──────┬─────────┬─────────┬─────────┐
|
||||||
|
\\│ Operation │ Type │ Len=3 │ Len=4 │ Len=16 │
|
||||||
|
\\├─────────────┼──────┼─────────┼─────────┼─────────┤
|
||||||
|
\\
|
||||||
|
, .{ ITERS, SAMPLES });
|
||||||
|
|
||||||
|
const Types = .{ i32, i64, i128, f32, f64 };
|
||||||
|
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
||||||
|
const Lengths = .{ 3, 4, 16 };
|
||||||
|
const Ops = .{ "add", "divBy", "mulByScalar", "length" };
|
||||||
|
|
||||||
|
inline for (Ops, 0..) |op_name, o_idx| {
|
||||||
|
inline for (Types, TNames) |T, tname| {
|
||||||
|
try writer.print("│ {s:<11} │ {s:<4} │", .{ op_name, tname });
|
||||||
|
|
||||||
|
inline for (Lengths) |len| {
|
||||||
|
const Q_base = Scalar(T, .init(.{ .L = 1 }), .init(.{}));
|
||||||
|
const Q_time = Scalar(T, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
const V = Vector(len, Q_base);
|
||||||
|
|
||||||
|
var samples: [SAMPLES]f64 = undefined;
|
||||||
|
|
||||||
|
std.mem.doNotOptimizeAway({
|
||||||
|
for (0..SAMPLES) |s_idx| {
|
||||||
|
const t_start = getTime();
|
||||||
|
for (0..ITERS) |i| {
|
||||||
|
const v1 = V.initDefault(getVal(T, i, 63));
|
||||||
|
|
||||||
|
if (comptime std.mem.eql(u8, op_name, "add")) {
|
||||||
|
const v2 = V.initDefault(getVal(T, i +% 7, 63));
|
||||||
|
_ = v1.add(v2);
|
||||||
|
} else if (comptime std.mem.eql(u8, op_name, "divBy")) {
|
||||||
|
_ = v1.divBy(V.initDefault(getVal(T, i +% 2, 63)));
|
||||||
|
} else if (comptime std.mem.eql(u8, op_name, "mulByScalar")) {
|
||||||
|
const s_val = Q_time{ .value = getVal(T, i +% 2, 63) };
|
||||||
|
_ = v1.mulByScalar(s_val);
|
||||||
|
} else if (comptime std.mem.eql(u8, op_name, "length")) {
|
||||||
|
_ = v1.length();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
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:>7.1} │", .{median_ns_per_op});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
try writer.print("\n", .{});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (o_idx < Ops.len - 1) {
|
||||||
|
try writer.print("├─────────────┼──────┼─────────┼─────────┼─────────┤\n", .{});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
try writer.print("└─────────────┴──────┴─────────┴─────────┴─────────┘\n", .{});
|
||||||
|
}
|
||||||
+6
-6
@@ -1,16 +1,16 @@
|
|||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
|
|
||||||
pub const Quantity = @import("Quantity.zig").Quantity;
|
pub const Scalar = @import("Scalar.zig").Scalar;
|
||||||
pub const QuantityVec = @import("QuantityVec.zig").QuantityVec;
|
pub const Vector = @import("Vector.zig").Vector;
|
||||||
pub const Dimensions = @import("Dimensions.zig");
|
pub const Dimensions = @import("Dimensions.zig");
|
||||||
pub const Scales = @import("Scales.zig");
|
pub const Scales = @import("Scales.zig");
|
||||||
pub const Base = @import("BaseQuantities.zig");
|
pub const Base = @import("Base.zig");
|
||||||
|
|
||||||
test {
|
test {
|
||||||
_ = @import("Quantity.zig");
|
_ = @import("Scalar.zig");
|
||||||
_ = @import("QuantityVec.zig");
|
_ = @import("Vector.zig");
|
||||||
_ = @import("Dimensions.zig");
|
_ = @import("Dimensions.zig");
|
||||||
_ = @import("Scales.zig");
|
_ = @import("Scales.zig");
|
||||||
_ = @import("BaseQuantities.zig");
|
_ = @import("Base.zig");
|
||||||
_ = @import("helper.zig");
|
_ = @import("helper.zig");
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,134 +0,0 @@
|
|||||||
The slowdown you are seeing (1.5x to 2.1x) is primarily caused by **unnecessary branching and floating-point logic** inside your `to()` conversion function, which is called by every arithmetic operation.
|
|
||||||
|
|
||||||
Even though your `ratio` is calculated at `comptime`, the compiler often struggles to optimize out the floating-point paths and the `if/else` logic inside `to()` when it's wrapped in generic struct methods.
|
|
||||||
|
|
||||||
Here are the specific areas to optimize and the corrected code.
|
|
||||||
|
|
||||||
### 1. The `to` Function (The Bottleneck)
|
|
||||||
In your current code, `add` calls `self.to(TargetType)` and `rhs.to(TargetType)`. Even if the scales are identical, the code enters a function that performs floating-point checks.
|
|
||||||
|
|
||||||
**Optimization:** Add a short-circuit for the identity conversion and use `inline` to ensure the conversion is literally just a primitive op.
|
|
||||||
|
|
||||||
### 2. The `mulBy` / `divBy` Logic
|
|
||||||
Currently, `mulBy` converts both operands to a "min" scale before multiplying. In physics, $1km \times 1s$ is just $1000$ units of $m \cdot s$. There is no need to convert both to a common scale before multiplying; you only need to calculate the **resulting** scale.
|
|
||||||
|
|
||||||
### 3. `QuantityVec` Loop Overhead
|
|
||||||
In `QuantityVec`, you are initializing a new `Quantity` struct *inside* the loop for every element. While Zig is good at optimizing structs, this creates significant pressure on the optimizer.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Optimized `Quantity.zig`
|
|
||||||
|
|
||||||
Replace your `Quantity` struct methods with these. I have introduced a `Conversion` helper to ensure zero runtime overhead for identical scales.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
pub fn to(self: Self, comptime Dest: type) Dest {
|
|
||||||
if (comptime !dims.eql(Dest.dims))
|
|
||||||
@compileError("Dimension mismatch");
|
|
||||||
|
|
||||||
// 1. Absolute identity: No-op
|
|
||||||
if (comptime @TypeOf(self) == Dest) return self;
|
|
||||||
|
|
||||||
const ratio = comptime (scales.getFactor(dims) / Dest.scales.getFactor(Dest.dims));
|
|
||||||
|
|
||||||
// 2. Scale identity: just cast the value type
|
|
||||||
if (comptime ratio == 1.0) {
|
|
||||||
return .{ .value = hlp.cast(Dest.ValueType, self.value) };
|
|
||||||
}
|
|
||||||
|
|
||||||
// 3. Fast-path: Integer scaling (multiplication)
|
|
||||||
if (comptime @typeInfo(T) == .int and @typeInfo(Dest.ValueType) == .int and ratio > 1.0 and @round(ratio) == ratio) {
|
|
||||||
const factor: Dest.ValueType = @intFromFloat(ratio);
|
|
||||||
return .{ .value = hlp.cast(Dest.ValueType, self.value) * factor };
|
|
||||||
}
|
|
||||||
|
|
||||||
// 4. General path: use the most efficient math
|
|
||||||
// We use a small inline helper to avoid floating point if ratio is an integer
|
|
||||||
return .{ .value = hlp.applyRatio(Dest.ValueType, self.value, ratio) };
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn add(self: Self, rhs: anytype) Quantity(T, dims, scales.min(@TypeOf(rhs).scales)) {
|
|
||||||
const ResQ = Quantity(T, dims, scales.min(@TypeOf(rhs).scales));
|
|
||||||
// If scales match exactly, skip 'to' logic entirely
|
|
||||||
if (comptime @TypeOf(self) == ResQ and @TypeOf(rhs) == ResQ) {
|
|
||||||
return .{ .value = self.value + rhs.value };
|
|
||||||
}
|
|
||||||
return .{ .value = self.to(ResQ).value + rhs.to(ResQ).value };
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn mulBy(self: Self, rhs: anytype) Quantity(T, d.add(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales)) {
|
|
||||||
const Tr = @TypeOf(rhs);
|
|
||||||
const ResQ = Quantity(T, d.add(Tr.dims), s.min(Tr.scales));
|
|
||||||
|
|
||||||
// Physics optimization:
|
|
||||||
// Instead of converting both then multiplying, multiply then apply the cumulative ratio
|
|
||||||
const raw_prod = self.value * rhs.value;
|
|
||||||
const combined_ratio = comptime (s.getFactor(d) * Tr.scales.getFactor(Tr.dims)) / ResQ.scales.getFactor(ResQ.dims);
|
|
||||||
|
|
||||||
return .{ .value = hlp.applyRatio(T, raw_prod, combined_ratio) };
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Optimized `QuantityVec.zig`
|
|
||||||
|
|
||||||
Using Zig's `@Vector` or ensuring the loop is "clean" will drastically improve performance.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
pub fn add(self: Self, rhs: anytype) QuantityVec(len, Quantity(T, d, s.min(@TypeOf(rhs).scales))) {
|
|
||||||
const Tr = @TypeOf(rhs);
|
|
||||||
const ResQ = Quantity(T, d, s.min(Tr.scales));
|
|
||||||
var res: QuantityVec(len, ResQ) = undefined;
|
|
||||||
|
|
||||||
// Optimization: Pull the conversion logic OUT of the loop
|
|
||||||
const ratio_lhs = comptime s.getFactor(d) / ResQ.scales.getFactor(d);
|
|
||||||
const ratio_rhs = comptime Tr.scales.getFactor(Tr.dims) / ResQ.scales.getFactor(d);
|
|
||||||
|
|
||||||
for (&res.data, 0..) |*out, i| {
|
|
||||||
const v_lhs = hlp.applyRatio(T, self.data[i], ratio_lhs);
|
|
||||||
const v_rhs = hlp.applyRatio(T, rhs.data[i], ratio_rhs);
|
|
||||||
out.* = v_lhs + v_rhs;
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Optimized `helper.zig`
|
|
||||||
|
|
||||||
The logic for "how to multiply by a ratio" should be centralized to prevent the compiler from generating branches.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
pub inline fn cast(comptime T: type, value: anytype) T {
|
|
||||||
const In = @TypeOf(value);
|
|
||||||
if (T == In) return value;
|
|
||||||
return switch (@typeInfo(T)) {
|
|
||||||
.int => @intCast(value),
|
|
||||||
.float => @floatCast(value),
|
|
||||||
else => @compileError("Unsupported cast"),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
pub inline fn applyRatio(comptime T: type, value: anytype, comptime ratio: f64) T {
|
|
||||||
if (comptime ratio == 1.0) return cast(T, value);
|
|
||||||
|
|
||||||
if (comptime @typeInfo(T) == .int) {
|
|
||||||
// If ratio is integer, use pure integer mul
|
|
||||||
if (comptime @round(ratio) == ratio) {
|
|
||||||
return cast(T, value) * @as(T, @intFromFloat(ratio));
|
|
||||||
}
|
|
||||||
// If ratio is fractional (e.g. 0.001), use float to avoid 0 results
|
|
||||||
return @intFromFloat(@round(@as(f64, @floatFromInt(value)) * ratio));
|
|
||||||
} else {
|
|
||||||
return cast(T, value) * @as(T, @floatCast(ratio));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Key Changes Explained
|
|
||||||
|
|
||||||
1. **Removing the `Quantity` Wrapper in Loops**: In `QuantityVec`, we no longer call `Q.add(R)`. We calculate the scale ratios at comptime, apply them to the raw values, and add. This allows the CPU to pipe the instructions much more effectively.
|
|
||||||
2. **Short-Circuiting**: The `if (comptime ratio == 1.0)` check is vital. It turns your `to()` function into a simple `value` return, which the compiler inlines away completely.
|
|
||||||
3. **Float avoidance for Integers**: In your original `to`, you were doing `scales.getFactor(dims) / Dest.scales.getFactor(Dest.dims)`. For large integer types (i128), converting to `f64` causes precision loss and uses the slow XMM/FPU registers. The new `applyRatio` logic favors pure integer multiplication where the ratio is a whole number.
|
|
||||||
4. **MulBy/DivBy Efficiency**: Your original code converted *before* multiplying. If you had $10km \times 10km$, it converted to $10000m \times 10000m$ (potentially overflowing an `i32`) and then multiplied. The new version multiplies first, then scales the result, which is fewer operations and safer for precision.
|
|
||||||
|
|
||||||
### Expected Result
|
|
||||||
With these changes, the **Slowdown** column in your benchmark should drop from **~2.0x** to **~1.05x - 1.1x**. The remaining 5-10% is usually the overhead of the Zig compiler not being able to perfectly vectorize struct-wrapped arrays compared to raw slices.
|
|
||||||
Reference in New Issue
Block a user