@pkmn/engine 0.1.0-dev.a0167a9d → 0.1.0-dev.a0447192

package/src/lib/common/rational.zig

@@ -6,9 +6,18 @@ const expect = std.testing.expect;
 const expectEqual = std.testing.expectEqual;
 const expectError = std.testing.expectError;
 
+const Int = if (@hasField(std.builtin.Type, "int")) .int else .Int;
+const Float = if (@hasField(std.builtin.Type, "float")) .float else .Float;
+const ComptimeInt =
+    if (@hasField(std.builtin.Type, "comptime_int")) .comptime_int else .ComptimeInt;
+const ComptimeFloat =
+    if (@hasField(std.builtin.Type, "comptime_float")) .comptime_float else .ComptimeFloat;
+
 /// Specialization of a rational number used by the engine to compute probabilties.
 /// For performance reasons the rational is only reduced lazily and thus `reduce` must be
-/// invoked explicitly before reading.
+/// invoked explicitly before reading. Note that this laziness means that this implementation
+/// sometimes overflows in places where an eager reduced implementation would not - to achieve
+/// the same behavior as an eager implementation simply call `reduce` after each operation.
 pub fn Rational(comptime T: type) type {
     return extern struct {
         const Self = @This();
@@ -18,19 +27,19 @@ pub fn Rational(comptime T: type) type {
         /// Denominator. Must always be >= 1. Not guaranteed to be reduced in all cases.
         q: T = 1,
 
-        // With floats we can't rely on an overflow bit to let us know when to reduce, so we instead
-        // start reducing when we get sufficiently close to the limit of the mantissa (in our domain
-        // we expect updates to involve numbers < 2**10, so we should be safe not reducing before we
-        // are 2**10 away from "overflowing" the mantissa)
-        const REDUCE = if (@typeInfo(T) == .Float)
+        // With floats we can't rely on an overflow bit to let us know when to reduce, so we
+        // instead start reducing when we get sufficiently close to the limit of the mantissa
+        // (in our domain we expect updates to involve numbers < 2**10, so we should be safe
+        // not reducing before we are 2**10 away from "overflowing" the mantissa)
+        const REDUCE = if (@typeInfo(T) == Float)
             std.math.pow(T, 2, std.math.floatMantissaBits(T) - 10)
         else
             0;
 
         /// Possible error returned by operations on the Rational.
         pub const Error = switch (@typeInfo(T)) {
-            .Int => error{Overflow},
-            .Float => error{},
+            Int => error{Overflow},
+            Float => error{},
             else => unreachable,
         };
 
@@ -50,12 +59,12 @@ pub fn Rational(comptime T: type) type {
             // If our parameters are not fully reduced they may prematurely
             // cause overflow/loss of precision after the multiplication below
             assert(switch (@typeInfo(@TypeOf(p, q))) {
-                .ComptimeInt, .ComptimeFloat => comptime gcd(p, q),
+                ComptimeInt, ComptimeFloat => comptime gcd(p, q),
                 else => 1,
             } == 1);
 
             switch (@typeInfo(T)) {
-                .Int => {
+                Int => {
                     // Greedily attempt to multiply and if it fails, reduce and try again
                     r.multiplication(p, q) catch |err| switch (err) {
                         error.Overflow => {
@@ -65,16 +74,16 @@ pub fn Rational(comptime T: type) type {
                         else => unreachable,
                     };
                 },
-                .Float => {
+                Float => {
                     // Reduce in situations where we're likely to start losing precision
                     if (r.q > REDUCE or r.p > REDUCE) r.reduce();
 
                     r.p *= switch (@typeInfo(@TypeOf(p))) {
-                        .Float, .ComptimeFloat => p,
+                        Float, ComptimeFloat => p,
                         else => @floatFromInt(p),
                     };
                     r.q *= switch (@typeInfo(@TypeOf(q))) {
-                        .Float, .ComptimeFloat => q,
+                        Float, ComptimeFloat => q,
                         else => @floatFromInt(q),
                     };
 
@@ -89,7 +98,7 @@ pub fn Rational(comptime T: type) type {
         /// Add two rationals using the identity (a/b) + (c/d) = (ad+bc)/(bd).
         pub fn add(r: *Self, s: *Self) Error!void {
             switch (@typeInfo(T)) {
-                .Int => {
+                Int => {
                     if (r.q == s.q) {
                         r.p = std.math.add(T, r.p, s.p) catch |err| switch (err) {
                             error.Overflow => val: {
@@ -110,7 +119,7 @@ pub fn Rational(comptime T: type) type {
                         };
                     }
                 },
-                .Float => {
+                Float => {
                     if (r.q == s.q) {
                         if (r.p > REDUCE) r.reduce();
                         if (s.p > REDUCE) s.reduce();
@@ -135,7 +144,7 @@ pub fn Rational(comptime T: type) type {
         /// Multiplies two rationals.
         pub fn mul(r: *Self, s: *Self) Error!void {
             switch (@typeInfo(T)) {
-                .Int => {
+                Int => {
                     r.multiplication(s.p, s.q) catch |err| switch (err) {
                         error.Overflow => {
                             r.reduce();
@@ -145,7 +154,7 @@ pub fn Rational(comptime T: type) type {
                         else => unreachable,
                     };
                 },
-                .Float => {
+                Float => {
                     if (r.q > REDUCE or r.p > REDUCE) r.reduce();
                     if (s.q > REDUCE or s.p > REDUCE) s.reduce();
 
@@ -201,46 +210,37 @@ pub fn Rational(comptime T: type) type {
     };
 }
 
-// https://lemire.me/blog/greatest-common-divisor-the-extended-euclidean-algorithm-and-speed/
 fn gcd(p: anytype, q: anytype) @TypeOf(p, q) {
     assert(p >= 1);
     assert(q >= 1);
 
-    const T = @TypeOf(p, q);
+    // convert comptime_int to a sized integer within this function so that @ctz will work
+    const T = switch (@TypeOf(p, q)) {
+        comptime_int => std.math.IntFittingRange(@min(p, q), @max(p, q)),
+        else => |U| U,
+    };
+
     switch (@typeInfo(T)) {
-        .Int => {
-            var u: T = undefined;
-            var v: T = undefined;
-            if (p < q) {
-                u = q;
-                v = p;
-            } else {
-                u = p;
-                v = q;
-            }
-            assert(v <= u);
-            u %= v;
-            if (u == 0) return v;
-
-            const zu = @ctz(u);
-            const zv = @ctz(v);
-            const shift = @min(zu, zv);
-            u >>= @intCast(zu);
-            v >>= @intCast(zv);
-
-            while (true) {
-                const diff = u -% v;
-                if (u > v) {
-                    u = v;
-                    v = diff;
-                } else {
-                    v -= u;
-                }
-                if (diff != 0) v >>= @intCast(@ctz(diff));
-                if (v == 0) break;
+        Int => {
+            // std.math.gcd but without some checks because we have a stricter range
+            var x: T = @intCast(p);
+            var y: T = @intCast(q);
+
+            const xz = @ctz(x);
+            const yz = @ctz(y);
+            const shift = @min(xz, yz);
+            x >>= @intCast(xz);
+            y >>= @intCast(yz);
+
+            var diff = y -% x;
+            while (diff != 0) : (diff = y -% x) {
+                const zeros = @ctz(diff);
+                if (x > y) diff = -%diff;
+                y = @min(x, y);
+                x = diff >> @intCast(zeros);
             }
 
-            const result = u << @intCast(shift);
+            const result = y << @intCast(shift);
             assert(result > 0);
             return result;
         },
@@ -263,7 +263,7 @@ fn gcd(p: anytype, q: anytype) @TypeOf(p, q) {
 
 test gcd {
     const seed = if (@hasDecl(std.testing, "random_seed")) std.testing.random_seed else 0x12345678;
-    var prng = std.Random.DefaultPrng.init(seed);
+    var prng = (if (@hasDecl(std, "Random")) std.Random else std.rand).DefaultPrng.init(seed);
     var random = prng.random();
 
     for (0..1000) |_| {
@@ -276,6 +276,8 @@ test gcd {
             @as(u32, @intFromFloat(gcd(@as(f64, @floatFromInt(a)), @as(f64, @floatFromInt(b))))),
         );
     }
+
+    try expectEqual(gcd(300_000, @as(u32, 2_300_000)), 100_000); // NB: @ctz requires an @intCast
 }
 
 fn doTurn(r: anytype) !void {

package/src/lib/common/rng.zig

@@ -74,7 +74,7 @@ pub const PSRNG = extern struct {
 
 test PSRNG {
     var psrng: PSRNG = .{ .src = .{ .seed = 0x0001000200030004 } };
-    try expectEqual(121, psrng.range(u8, 0, 256));
+    try expectEqual(@as(u8, 121), psrng.range(u8, 0, 256));
     try expectEqual(false, psrng.chance(u8, 128, 256)); // 226 < 128
 }
 
@@ -111,9 +111,9 @@ test Gen12 {
         try expectEqual(e, rng.next());
     }
 
-    try expectEqual(16, Gen12.percent(6) + 1);
-    try expectEqual(16, Gen12.percent(7) - 1);
-    try expectEqual(128, Gen12.percent(50) + 1);
+    try expectEqual(@as(u8, 16), Gen12.percent(6) + 1);
+    try expectEqual(@as(u8, 16), Gen12.percent(7) - 1);
+    try expectEqual(@as(u8, 128), Gen12.percent(50) + 1);
 }
 
 // https://pkmn.cc/pokeemerald/src/random.c

package/src/lib/common/util.zig

@@ -1,12 +1,61 @@
 const std = @import("std");
 
+const expect = std.testing.expect;
 const expectEqual = std.testing.expectEqual;
 
+const Pointer = if (@hasField(std.builtin.Type, "pointer")) .pointer else .Pointer;
+
 pub fn PointerType(comptime P: type, comptime C: type) type {
-    return if (@typeInfo(P).Pointer.is_const) *const C else *C;
+    return if (@field(@typeInfo(P), @tagName(Pointer)).is_const) *const C else *C;
 }
 
 test PointerType {
     try expectEqual(*bool, PointerType(*u8, bool));
     try expectEqual(*const f64, PointerType(*const i32, f64));
 }
+
+pub fn isPointerTo(p: anytype, comptime P: type) bool {
+    const info = @typeInfo(@TypeOf(p));
+    return switch (info) {
+        Pointer => @field(info, @tagName(Pointer)).child == P,
+        else => false,
+    };
+}
+
+test isPointerTo {
+    const S = struct {};
+    const s: S = .{};
+    try expect(!isPointerTo(s, S));
+    try expect(isPointerTo(&s, S));
+}
+
+// NOTE: std.mem.bytesAsValue backported from ziglang/zig#18061
+pub fn bytesAsValue(comptime T: type, bytes: anytype) BytesAsValueReturnType(T, @TypeOf(bytes)) {
+    return @as(BytesAsValueReturnType(T, @TypeOf(bytes)), @ptrCast(bytes));
+}
+
+fn BytesAsValueReturnType(comptime T: type, comptime B: type) type {
+    return CopyPtrAttrs(B, .One, T);
+}
+
+fn CopyPtrAttrs(
+    comptime source: type,
+    comptime size: std.builtin.Type.Pointer.Size,
+    comptime child: type,
+) type {
+    const info = @field(@typeInfo(source), @tagName(Pointer));
+    const args = .{
+        .size = size,
+        .is_const = info.is_const,
+        .is_volatile = info.is_volatile,
+        .is_allowzero = info.is_allowzero,
+        .alignment = info.alignment,
+        .address_space = info.address_space,
+        .child = child,
+        .sentinel = null,
+    };
+    return @Type(if (@hasField(std.builtin.Type, "pointer"))
+        .{ .pointer = args }
+    else
+        .{ .Pointer = args });
+}