adrien/zig-dimal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: adrien/zig-dimal:cc39c1a6f46eb3db4447b0379b7d0dceaa34f244
Branches Tags
adrien/zig-dimal:main
adrien/zig-dimal:0.3.0 adrien/zig-dimal:0.2.2 adrien/zig-dimal:0.2.1 adrien/zig-dimal:0.2.0 adrien/zig-dimal:0.1.1 adrien/zig-dimal:0.1.0
...
compare: adrien/zig-dimal:0.1.0
Branches Tags
adrien/zig-dimal:main
adrien/zig-dimal:0.3.0 adrien/zig-dimal:0.2.2 adrien/zig-dimal:0.2.1 adrien/zig-dimal:0.2.0 adrien/zig-dimal:0.1.1 adrien/zig-dimal:0.1.0
7 Commits
cc39c1a6f4 ... 0.1.0
Author SHA1 Message Date
adrien 49b56bda91 Added int nanometer example in README 2026-04-22 01:20:09 +02:00
adrien 76c69448de Fixed benchmark with removed scale 2026-04-22 01:14:38 +02:00
adrien cb3c41cf4c Better README 2026-04-22 01:07:06 +02:00
adrien 5f42a8c107 Added Dimless to Base 2026-04-22 01:06:52 +02:00
adrien 1719b0de8b Removed scale (just use mulBy + dimless) + added inline to vector fn 2026-04-22 01:05:33 +02:00
adrien 84d0698878 Removed ztracy dep 2026-04-22 00:31:37 +02:00
adrien 11a741f72c Removed useless code 2026-04-22 00:19:07 +02:00
7 changed files with 211 additions and 303 deletions
Expand all files Collapse all files
README.md
+178 -213
View File
@@ -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 time = Second{ .value = 2.0 };
// Arithmetic is type-safe and creates the correct resulting dimension const exe = b.addExecutable(.{
const vel = dist.divBy(time); // Type is Velocity (L/T) .name = "my_project",
.root_module = b.createModule(.{
std.debug.print("Speed: {f}\n", .{vel}); // Output: 5m.s⁻¹ .root_source_file = b.path("src/main.zig"),
.target = target,
.imports = &.{.{
.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.
build.zig
+3 -26
View File
@@ -7,7 +7,8 @@ pub fn build(b: *std.Build) void {
// 1. Define the module so other projects can import it // 1. Define the module so other projects can import it
_ = b.addModule("dimal", .{ _ = b.addModule("dimal", .{
.root_source_file = b.path("src/main.zig"), .root_source_file = b.path("src/main.zig"),
}); // 2. Keep the test setup });
const exe_tests = b.addTest(.{ 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"),
@@ -21,24 +22,6 @@ pub fn build(b: *std.Build) void {
const test_step = b.step("test", "Run tests"); const test_step = b.step("test", "Run tests");
test_step.dependOn(&run_exe_tests.step); test_step.dependOn(&run_exe_tests.step);
const options = .{
.enable_ztracy = b.option(
bool,
"enable_ztracy",
"Enable Tracy profile markers",
) orelse false,
.enable_fibers = b.option(
bool,
"enable_fibers",
"Enable Tracy fiber support",
) orelse false,
.on_demand = b.option(
bool,
"on_demand",
"Build tracy with TRACY_ON_DEMAND",
) orelse false,
};
const bench_exe = b.addExecutable(.{ const bench_exe = b.addExecutable(.{
.name = "benchmark", .name = "benchmark",
.root_module = b.createModule(.{ .root_module = b.createModule(.{
@@ -48,13 +31,7 @@ pub fn build(b: *std.Build) void {
}), }),
}); });
const ztracy = b.dependency("ztracy", .{ b.installArtifact(bench_exe);
.enable_ztracy = options.enable_ztracy,
.enable_fibers = options.enable_fibers,
.on_demand = options.on_demand,
});
bench_exe.root_module.addImport("ztracy", ztracy.module("root"));
bench_exe.root_module.linkLibrary(ztracy.artifact("tracy"));
const run_bench = b.addRunArtifact(bench_exe); const run_bench = b.addRunArtifact(bench_exe);
const bench_step = b.step("benchmark", "Run the benchmark suite"); const bench_step = b.step("benchmark", "Run the benchmark suite");
build.zig.zon
+1 -6
View File
@@ -3,12 +3,7 @@
.version = "0.1.0", .version = "0.1.0",
.fingerprint = 0x9453b1ff1e52d858, .fingerprint = 0x9453b1ff1e52d858,
.minimum_zig_version = "0.16.0", .minimum_zig_version = "0.16.0",
.dependencies = .{ .dependencies = .{},
.ztracy = .{
.url = "git+https://github.com/zig-gamedev/ztracy#d95d2a193b9f97944a17026c9a42b5d0f9a88c94",
.hash = "ztracy-0.14.0-dev-zHJSqzUHGQAmhJybhlwtl1QKevUBw4M5YKZqPfWx2y99",
},
},
.paths = .{ .paths = .{
"build.zig", "build.zig",
"build.zig.zon", "build.zig.zon",
src/Base.zig
+2
View File
@@ -25,6 +25,8 @@ pub fn BaseScalar(comptime d: anytype) type {
}; };
} }
pub const Dimless = BaseScalar(.{});
// ========================================== // ==========================================
// Base Quantities // Base Quantities
// ========================================== // ==========================================
src/Scalar.zig
+4 -12
View File
@@ -8,7 +8,7 @@ const Dimensions = @import("Dimensions.zig");
const Dimension = Dimensions.Dimension; const Dimension = Dimensions.Dimension;
pub fn Scalar(comptime T: type, comptime d: Dimensions, comptime s: Scales) type { pub fn Scalar(comptime T: type, comptime d: Dimensions, comptime s: Scales) type {
@setEvalBranchQuota(100_000); @setEvalBranchQuota(10_000_000);
return struct { return struct {
value: T, value: T,
@@ -86,10 +86,6 @@ pub fn Scalar(comptime T: type, comptime d: Dimensions, comptime s: Scales) type
} }
} }
pub inline fn scale(self: Self, sc: T) Self {
return .{ .value = self.value * sc };
}
pub inline fn to(self: Self, comptime Dest: type) Dest { pub inline fn to(self: Self, comptime Dest: type) Dest {
if (comptime !dims.eql(Dest.dims)) if (comptime !dims.eql(Dest.dims))
@compileError("Dimension mismatch in to: " ++ dims.str() ++ " vs " ++ Dest.dims.str()); @compileError("Dimension mismatch in to: " ++ dims.str() ++ " vs " ++ Dest.dims.str());
@@ -292,18 +288,14 @@ test "MulBy small" {
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T)); try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
} }
test "Scale" { test "MulBy dimensionless" {
const DimLess = Scalar(i128, Dimensions.init(.{}), Scales.init(.{}));
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{})); const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
const d = Meter{ .value = 7 }; const d = Meter{ .value = 7 };
const scaled = d.scale(3); const scaled = d.mulBy(DimLess{ .value = 3 });
try std.testing.expectEqual(21, scaled.value); try std.testing.expectEqual(21, scaled.value);
try std.testing.expectEqual(1, @TypeOf(scaled).dims.get(.L)); try std.testing.expectEqual(1, @TypeOf(scaled).dims.get(.L));
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);
} }
test "Chained: velocity and acceleration" { test "Chained: velocity and acceleration" {
src/Vector.zig
+19 -33
View File
@@ -26,74 +26,74 @@ pub fn Vector(comptime len: usize, comptime Q: type) type {
pub fn initDefault(v: T) Self { pub fn initDefault(v: T) Self {
var data: [len]T = undefined; var data: [len]T = undefined;
for (&data) |*item| item.* = v; inline for (&data) |*item| item.* = v;
return .{ .data = data }; return .{ .data = data };
} }
pub fn add(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) { pub inline fn add(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) {
const Tr = @TypeOf(rhs); const Tr = @TypeOf(rhs);
var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined; var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
const q = (Q{ .value = v }).add(Tr.ScalarType{ .value = rhs.data[i] }); const q = (Q{ .value = v }).add(Tr.ScalarType{ .value = rhs.data[i] });
res.data[i] = q.value; res.data[i] = q.value;
} }
return res; return res;
} }
pub fn sub(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) { pub inline fn sub(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) {
const Tr = @TypeOf(rhs); const Tr = @TypeOf(rhs);
var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined; var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
const q = (Q{ .value = v }).sub(Tr.ScalarType{ .value = rhs.data[i] }); const q = (Q{ .value = v }).sub(Tr.ScalarType{ .value = rhs.data[i] });
res.data[i] = q.value; res.data[i] = q.value;
} }
return res; return res;
} }
pub fn divBy( pub inline fn divBy(
self: Self, self: Self,
rhs: anytype, rhs: anytype,
) Vector(len, Scalar(T, d.sub(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) { ) Vector(len, Scalar(T, d.sub(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
const Tr = @TypeOf(rhs); const Tr = @TypeOf(rhs);
var res: Vector(len, Scalar(T, d.sub(Tr.dims), s.min(Tr.scales))) = undefined; var res: Vector(len, Scalar(T, d.sub(Tr.dims), s.min(Tr.scales))) = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
const q = (Q{ .value = v }).divBy(Tr.ScalarType{ .value = rhs.data[i] }); const q = (Q{ .value = v }).divBy(Tr.ScalarType{ .value = rhs.data[i] });
res.data[i] = q.value; res.data[i] = q.value;
} }
return res; return res;
} }
pub fn mulBy( pub inline fn mulBy(
self: Self, self: Self,
rhs: anytype, rhs: anytype,
) Vector(len, Scalar(T, d.add(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) { ) Vector(len, Scalar(T, d.add(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
const Tr = @TypeOf(rhs); const Tr = @TypeOf(rhs);
var res: Vector(len, Scalar(T, d.add(Tr.dims), s.min(Tr.scales))) = undefined; var res: Vector(len, Scalar(T, d.add(Tr.dims), s.min(Tr.scales))) = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
const q = (Q{ .value = v }).mulBy(Tr.ScalarType{ .value = rhs.data[i] }); const q = (Q{ .value = v }).mulBy(Tr.ScalarType{ .value = rhs.data[i] });
res.data[i] = q.value; res.data[i] = q.value;
} }
return res; return res;
} }
pub fn divByScalar( pub inline fn divByScalar(
self: Self, self: Self,
scalar: anytype, scalar: anytype,
) Vector(len, Scalar(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) { ) 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; var res: Vector(len, Scalar(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
const q = Q{ .value = v }; const q = Q{ .value = v };
res.data[i] = q.divBy(scalar).value; res.data[i] = q.divBy(scalar).value;
} }
return res; return res;
} }
pub fn mulByScalar( pub inline fn mulByScalar(
self: Self, self: Self,
scalar: anytype, scalar: anytype,
) Vector(len, Scalar(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) { ) 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; var res: Vector(len, Scalar(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
const q = Q{ .value = v }; const q = Q{ .value = v };
res.data[i] = q.mulBy(scalar).value; res.data[i] = q.mulBy(scalar).value;
} }
@@ -102,37 +102,29 @@ pub fn Vector(comptime len: usize, comptime Q: type) type {
pub fn negate(self: Self) Self { pub fn negate(self: Self) Self {
var res: Self = undefined; var res: Self = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
res.data[i] = -v; res.data[i] = -v;
} }
return res; return res;
} }
pub fn scale(self: Self, rhs: T) Self { pub inline fn to(self: Self, comptime DestQ: type) Vector(len, DestQ) {
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) Vector(len, DestQ) {
var res: Vector(len, DestQ) = undefined; var res: Vector(len, DestQ) = undefined;
for (self.data, 0..) |v, i| { inline for (self.data, 0..) |v, i| {
res.data[i] = (Q{ .value = v }).to(DestQ).value; res.data[i] = (Q{ .value = v }).to(DestQ).value;
} }
return res; return res;
} }
pub fn lengthSqr(self: Self) T { pub inline fn lengthSqr(self: Self) T {
var sum: T = 0; var sum: T = 0;
for (self.data) |v| { inline for (self.data) |v| {
sum += v * v; sum += v * v;
} }
return sum; return sum;
} }
pub fn length(self: Self) T { pub inline fn length(self: Self) T {
const len_sq = self.lengthSqr(); const len_sq = self.lengthSqr();
if (comptime @typeInfo(T) == .int) { if (comptime @typeInfo(T) == .int) {
@@ -291,12 +283,6 @@ test "VecX Element-wise Math and Scaling" {
try std.testing.expectEqual(4, div.data[1]); try std.testing.expectEqual(4, div.data[1]);
try std.testing.expectEqual(3, div.data[2]); try std.testing.expectEqual(3, div.data[2]);
try std.testing.expectEqual(0, @TypeOf(div).dims.get(.L)); // M / M = Dimensionless 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" { test "VecX Conversions" {
src/benchmark.zig
+4 -13
View File
@@ -1,14 +1,10 @@
const std = @import("std"); const std = @import("std");
const tracy = @import("ztracy");
const Io = std.Io; const Io = std.Io;
const Scalar = @import("Scalar.zig").Scalar; const Scalar = @import("Scalar.zig").Scalar;
const Vector = @import("Vector.zig").Vector; const Vector = @import("Vector.zig").Vector;
var io: Io = undefined; var io: Io = undefined;
pub fn main(init: std.process.Init) !void { pub fn main(init: std.process.Init) !void {
const zone = tracy.ZoneN(@src(), "Main Loop");
defer zone.End();
var stdout_buf: [4096]u8 = undefined; var stdout_buf: [4096]u8 = undefined;
var stdout_writer: std.Io.File.Writer = .init(.stdout(), init.io, &stdout_buf); var stdout_writer: std.Io.File.Writer = .init(.stdout(), init.io, &stdout_buf);
try stdout_writer.interface.print("Starting Benchmarks...", .{}); try stdout_writer.interface.print("Starting Benchmarks...", .{});
@@ -23,8 +19,6 @@ pub fn main(init: std.process.Init) !void {
try stdout_writer.flush(); try stdout_writer.flush();
try bench_Vector(&stdout_writer.interface); try bench_Vector(&stdout_writer.interface);
try stdout_writer.flush(); try stdout_writer.flush();
tracy.FrameMark();
} }
fn getTime() Io.Timestamp { fn getTime() Io.Timestamp {
@@ -86,7 +80,7 @@ fn bench_Scalar(writer: *std.Io.Writer) !void {
const Types = .{ i16, i32, i64, i128, i256, f32, f64, f128 }; const Types = .{ i16, i32, i64, i128, i256, f32, f64, f128 };
const TNames = .{ "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" }; const Ops = .{ "add", "sub", "mulBy", "divBy", "to" };
var results_matrix: [Ops.len][Types.len]f64 = undefined; var results_matrix: [Ops.len][Types.len]f64 = undefined;
@@ -113,8 +107,6 @@ fn bench_Scalar(writer: *std.Io.Writer) !void {
(M{ .value = getVal(T, i, 63) }).mulBy(M{ .value = getVal(T, i +% 1, 63) }) (M{ .value = getVal(T, i, 63) }).mulBy(M{ .value = getVal(T, i +% 1, 63) })
else if (comptime std.mem.eql(u8, op_name, "divBy")) else if (comptime std.mem.eql(u8, op_name, "divBy"))
(M{ .value = getVal(T, i +% 10, 63) }).divBy(S{ .value = getVal(T, i, 63) }) (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 else
(KM{ .value = getVal(T, i, 15) }).to(M); (KM{ .value = getVal(T, i, 15) }).to(M);
}, },
@@ -386,7 +378,7 @@ fn bench_Vector(writer: *std.Io.Writer) !void {
const Types = .{ i32, i64, i128, f32, f64 }; const Types = .{ i32, i64, i128, f32, f64 };
const TNames = .{ "i32", "i64", "i128", "f32", "f64" }; const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
const Lengths = .{ 3, 4, 16 }; const Lengths = .{ 3, 4, 16 };
const Ops = .{ "add", "scale", "mulByScalar", "length" }; const Ops = .{ "add", "divBy", "mulByScalar", "length" };
inline for (Ops, 0..) |op_name, o_idx| { inline for (Ops, 0..) |op_name, o_idx| {
inline for (Types, TNames) |T, tname| { inline for (Types, TNames) |T, tname| {
@@ -408,9 +400,8 @@ fn bench_Vector(writer: *std.Io.Writer) !void {
if (comptime std.mem.eql(u8, op_name, "add")) { if (comptime std.mem.eql(u8, op_name, "add")) {
const v2 = V.initDefault(getVal(T, i +% 7, 63)); const v2 = V.initDefault(getVal(T, i +% 7, 63));
_ = v1.add(v2); _ = v1.add(v2);
} else if (comptime std.mem.eql(u8, op_name, "scale")) { } else if (comptime std.mem.eql(u8, op_name, "divBy")) {
const sc = getVal(T, i +% 2, 63); _ = v1.divBy(V.initDefault(getVal(T, i +% 2, 63)));
_ = v1.scale(sc);
} else if (comptime std.mem.eql(u8, op_name, "mulByScalar")) { } else if (comptime std.mem.eql(u8, op_name, "mulByScalar")) {
const s_val = Q_time{ .value = getVal(T, i +% 2, 63) }; const s_val = Q_time{ .value = getVal(T, i +% 2, 63) };
_ = v1.mulByScalar(s_val); _ = v1.mulByScalar(s_val);