@pkmn/engine 0.1.0-dev.15f64810 → 0.1.0-dev.18478e7d

package/src/lib/common/rational.zig

@@ -8,9 +8,27 @@ const expectError = std.testing.expectError;
 
 /// 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 {
+    // 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 o = if (@typeInfo(T) == .float)
+        std.math.pow(T, 2, std.math.floatMantissaBits(T) - 10)
+    else
+        0;
+
+    const Err = switch (@typeInfo(T)) {
+        .int => error{Overflow},
+        .float => error{},
+        else => unreachable,
+    };
+
+    // Zig doesn't allow integers > u128 in an extern struct...
+    return if (@sizeOf(T) <= 16) extern struct {
         const Self = @This();
 
         /// Numerator. Must always be >= 1. Not guaranteed to be reduced in all cases.
@@ -18,21 +36,8 @@ 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)
-            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{},
-            else => unreachable,
-        };
+        pub const Error = Err;
 
         /// Resets the rational back to 1.
         pub fn reset(r: *Self) void {
@@ -43,181 +48,327 @@ pub fn Rational(comptime T: type) type {
         /// Update the rational by multiplying its numerator by p and its denominator by q.
         /// Both p and q must be >= 1, and if computable at comptime must have no common factors.
         pub fn update(r: *Self, p: anytype, q: anytype) Error!void {
-            // std.debug.print("({d}/{d}) * ", .{ p, q }); // DEBUG
-            assert(p >= 1);
-            assert(q >= 1);
-
-            // 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),
-                else => 1,
-            } == 1);
-
-            switch (@typeInfo(T)) {
-                .Int => {
-                    // Greedily attempt to multiply and if it fails, reduce and try again
-                    r.multiplication(p, q) catch |err| switch (err) {
-                        error.Overflow => {
-                            r.reduce();
-                            try r.multiplication(p, q);
-                        },
-                        else => unreachable,
-                    };
-                },
-                .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,
-                        else => @floatFromInt(p),
-                    };
-                    r.q *= switch (@typeInfo(@TypeOf(q))) {
-                        .Float, .ComptimeFloat => q,
-                        else => @floatFromInt(q),
-                    };
-
-                    // We should always be dealing with whole numbers
-                    assert(std.math.modf(r.p).fpart == 0);
-                    assert(std.math.modf(r.q).fpart == 0);
-                },
-                else => unreachable,
-            }
+            return update_(T, o, r, p, q);
         }
 
         /// 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 => {
-                    if (r.q == s.q) {
-                        r.p = std.math.add(T, r.p, s.p) catch |err| switch (err) {
-                            error.Overflow => val: {
-                                r.reduce();
-                                s.reduce();
-                                break :val try std.math.add(T, r.p, s.p);
-                            },
-                            else => unreachable,
-                        };
-                    } else {
-                        r.addition(s.p, s.q) catch |err| switch (err) {
-                            error.Overflow => {
-                                r.reduce();
-                                s.reduce();
-                                try r.addition(s.p, s.q);
-                            },
-                            else => unreachable,
-                        };
-                    }
-                },
-                .Float => {
-                    if (r.q == s.q) {
-                        if (r.p > REDUCE) r.reduce();
-                        if (s.p > REDUCE) s.reduce();
-
-                        r.p += s.p;
-                    } else {
-                        // Always reduce to minimize loss of precision from the multiplications
-                        r.reduce();
-                        s.reduce();
-
-                        r.p = (r.p * s.q) + (r.q * s.p);
-                        r.q *= s.q;
-                    }
-
-                    assert(std.math.modf(r.p).fpart == 0);
-                    assert(std.math.modf(r.q).fpart == 0);
-                },
-                else => unreachable,
-            }
+        pub fn add(r: *Self, s: anytype) Error!void {
+            return add_(T, o, r, s);
         }
 
         /// Multiplies two rationals.
-        pub fn mul(r: *Self, s: *Self) Error!void {
-            switch (@typeInfo(T)) {
-                .Int => {
-                    r.multiplication(s.p, s.q) catch |err| switch (err) {
-                        error.Overflow => {
-                            r.reduce();
-                            s.reduce();
-                            try r.multiplication(s.p, s.q);
-                        },
-                        else => unreachable,
-                    };
-                },
-                .Float => {
-                    if (r.q > REDUCE or r.p > REDUCE) r.reduce();
-                    if (s.q > REDUCE or s.p > REDUCE) s.reduce();
-
-                    r.p *= s.p;
-                    r.q *= s.q;
+        pub fn mul(r: *Self, s: anytype) Error!void {
+            return mul_(T, o, r, s);
+        }
 
-                    assert(std.math.modf(r.p).fpart == 0);
-                    assert(std.math.modf(r.q).fpart == 0);
-                },
-                else => unreachable,
-            }
+        /// Compares two rationals using the identity (a/b) > (c/d) => ad > bc
+        pub fn cmp(r: *Self, s: anytype) Error!std.math.Order {
+            return cmp_(T, o, r, s);
         }
 
         /// Normalize the rational by reducing by the greatest common divisor.
         pub fn reduce(r: *Self) void {
-            const d = gcd(r.p, r.q);
-            if (d == 1) return;
+            reduce_(r);
+        }
+
+        pub fn format(self: Self, writer: *std.Io.Writer) !void {
+            try writer.print("{d}/{d}", .{ self.p, self.q });
+        }
+    } else struct {
+        const Self = @This();
 
-            assert(@mod(r.p, d) == 0);
-            assert(@mod(r.q, d) == 0);
+        /// Numerator. Must always be >= 1. Not guaranteed to be reduced in all cases.
+        p: T = 1,
+        /// Denominator. Must always be >= 1. Not guaranteed to be reduced in all cases.
+        q: T = 1,
 
-            r.p /= d;
-            r.q /= d;
+        /// Possible error returned by operations on the Rational.
+        pub const Error = Err;
 
-            assert(r.p >= 1);
-            assert(r.q >= 1);
+        /// Resets the rational back to 1.
+        pub fn reset(r: *Self) void {
+            r.p = 1;
+            r.q = 1;
         }
 
-        pub fn format(
-            self: Self,
-            comptime fmt: []const u8,
-            opts: std.fmt.FormatOptions,
-            writer: anytype,
-        ) !void {
-            _ = .{ fmt, opts };
-            try writer.print("{d}/{d}", .{ self.p, self.q });
+        /// Update the rational by multiplying its numerator by p and its denominator by q.
+        /// Both p and q must be >= 1, and if computable at comptime must have no common factors.
+        pub fn update(r: *Self, p: anytype, q: anytype) Error!void {
+            return update_(T, o, r, p, q);
+        }
+
+        /// Add two rationals using the identity (a/b) + (c/d) = (ad+bc)/(bd).
+        pub fn add(r: *Self, s: anytype) Error!void {
+            return add_(T, o, r, s);
+        }
+
+        /// Multiplies two rationals.
+        pub fn mul(r: *Self, s: anytype) Error!void {
+            return mul_(T, o, r, s);
         }
 
-        fn multiplication(r: *Self, p: anytype, q: anytype) !void {
-            r.p = try std.math.mul(T, r.p, p);
-            r.q = try std.math.mul(T, r.q, q);
+        /// Compares two rationals using the identity (a/b) > (c/d) => ad > bc
+        pub fn cmp(r: *Self, s: anytype) Error!std.math.Order {
+            return cmp_(T, o, r, s);
         }
 
-        fn addition(r: *Self, p: anytype, q: anytype) !void {
-            // (a/b) + (c/d) = (ad+bc)/(bd)
-            const d = try std.math.mul(T, r.q, q);
-            const n1 = try std.math.mul(T, r.p, q);
-            const n2 = try std.math.mul(T, r.q, p);
+        /// Normalize the rational by reducing by the greatest common divisor.
+        pub fn reduce(r: *Self) void {
+            reduce_(r);
+        }
 
-            r.p = try std.math.add(T, n1, n2);
-            r.q = d;
+        pub fn format(self: Self, writer: *std.Io.Writer) !void {
+            try writer.print("{d}/{d}", .{ self.p, self.q });
         }
     };
 }
 
-// https://en.wikipedia.org/wiki/Euclidean_algorithm
+fn update_(comptime T: type, comptime o: comptime_int, r: anytype, p: anytype, q: anytype) !void {
+    // std.debug.print("({d}/{d}) * ", .{ p, q }); // DEBUG
+    assert(p >= 1);
+    assert(q >= 1);
+
+    // 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))) {
+        .comptime_int, .comptime_float => comptime gcd(p, q),
+        else => 1,
+    } == 1);
+
+    switch (@typeInfo(T)) {
+        .int => {
+            // Greedily attempt to multiply and if it fails, reduce and try again
+            multiplication(T, r, p, q) catch |err| switch (err) {
+                error.Overflow => {
+                    r.reduce();
+                    try multiplication(T, r, p, q);
+                },
+                else => unreachable,
+            };
+        },
+        .float => {
+            // Reduce in situations where we're likely to start losing precision
+            if (r.q > o or r.p > o) r.reduce();
+
+            r.p *= switch (@typeInfo(@TypeOf(p))) {
+                .float, .comptime_float => p,
+                else => @floatFromInt(p),
+            };
+            r.q *= switch (@typeInfo(@TypeOf(q))) {
+                .float, .comptime_float => q,
+                else => @floatFromInt(q),
+            };
+
+            // We should always be dealing with whole numbers
+            assert(std.math.modf(r.p).fpart == 0);
+            assert(std.math.modf(r.q).fpart == 0);
+        },
+        else => unreachable,
+    }
+}
+
+fn add_(comptime T: type, comptime o: comptime_int, r: anytype, s: anytype) !void {
+    switch (@typeInfo(T)) {
+        .int => {
+            if (r.q == s.q) {
+                r.p = std.math.add(T, r.p, s.p) catch |err| switch (err) {
+                    error.Overflow => val: {
+                        r.reduce();
+                        s.reduce();
+                        break :val try std.math.add(T, r.p, s.p);
+                    },
+                    else => unreachable,
+                };
+            } else {
+                addition(T, r, s.p, s.q) catch |err| switch (err) {
+                    error.Overflow => {
+                        r.reduce();
+                        s.reduce();
+                        try addition(T, r, s.p, s.q);
+                    },
+                    else => unreachable,
+                };
+            }
+        },
+        .float => {
+            if (r.q == s.q) {
+                if (r.p > o) r.reduce();
+                if (s.p > o) s.reduce();
+
+                r.p += s.p;
+            } else {
+                // Always reduce to minimize loss of precision from the multiplications
+                r.reduce();
+                s.reduce();
+
+                r.p = (r.p * s.q) + (r.q * s.p);
+                r.q *= s.q;
+            }
+
+            assert(std.math.modf(r.p).fpart == 0);
+            assert(std.math.modf(r.q).fpart == 0);
+        },
+        else => unreachable,
+    }
+}
+
+fn mul_(comptime T: type, comptime o: comptime_int, r: anytype, s: anytype) !void {
+    switch (@typeInfo(T)) {
+        .int => {
+            multiplication(T, r, s.p, s.q) catch |err| switch (err) {
+                error.Overflow => {
+                    r.reduce();
+                    s.reduce();
+                    try multiplication(T, r, s.p, s.q);
+                },
+                else => unreachable,
+            };
+        },
+        .float => {
+            if (r.q > o or r.p > o) r.reduce();
+            if (s.q > o or s.p > o) s.reduce();
+
+            r.p *= s.p;
+            r.q *= s.q;
+
+            assert(std.math.modf(r.p).fpart == 0);
+            assert(std.math.modf(r.q).fpart == 0);
+        },
+        else => unreachable,
+    }
+}
+
+fn cmp_(comptime T: type, comptime o: comptime_int, r: anytype, s: anytype) !std.math.Order {
+    switch (@typeInfo(T)) {
+        .int => {
+            const ad = std.math.mul(T, r.p, s.q) catch |err| switch (err) {
+                error.Overflow => ad: {
+                    r.reduce();
+                    s.reduce();
+                    break :ad try std.math.mul(T, r.p, s.q);
+                },
+                else => unreachable,
+            };
+            const bc = std.math.mul(T, r.q, s.p) catch |err| switch (err) {
+                error.Overflow => bc: {
+                    r.reduce();
+                    s.reduce();
+                    break :bc try std.math.mul(T, r.q, s.p);
+                },
+                else => unreachable,
+            };
+
+            return std.math.order(ad, bc);
+        },
+        .float => {
+            if (r.q > o or r.p > o) r.reduce();
+            if (s.q > o or s.p > o) s.reduce();
+
+            const ad: T = r.p * s.q;
+            const bc: T = r.q * s.p;
+
+            return std.math.order(ad, bc);
+        },
+        else => unreachable,
+    }
+}
+
+fn reduce_(r: anytype) void {
+    const d = gcd(r.p, r.q);
+    if (d == 1) return;
+
+    assert(@mod(r.p, d) == 0);
+    assert(@mod(r.q, d) == 0);
+
+    r.p /= d;
+    r.q /= d;
+
+    assert(r.p >= 1);
+    assert(r.q >= 1);
+}
+
+fn multiplication(comptime T: type, r: anytype, p: anytype, q: anytype) !void {
+    r.p = try std.math.mul(T, r.p, p);
+    r.q = try std.math.mul(T, r.q, q);
+}
+
+fn addition(comptime T: type, r: anytype, p: anytype, q: anytype) !void {
+    // (a/b) + (c/d) = (ad+bc)/(bd)
+    const bd = try std.math.mul(T, r.q, q);
+    const ad = try std.math.mul(T, r.p, q);
+    const bc = try std.math.mul(T, r.q, p);
+
+    r.p = try std.math.add(T, ad, bc);
+    r.q = bd;
+}
+
 fn gcd(p: anytype, q: anytype) @TypeOf(p, q) {
     assert(p >= 1);
     assert(q >= 1);
 
-    var a = p;
-    var b = q;
-    var c: @TypeOf(p, q) = undefined;
+    // 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 => {
+            // 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 = y << @intCast(shift);
+            assert(result > 0);
+            return result;
+        },
+        else => {
+            var a = p;
+            var b = q;
+            var c: T = undefined;
+
+            while (b != 0) {
+                c = b;
+                b = @mod(a, b);
+                a = c;
+            }
 
-    while (b != 0) {
-        c = b;
-        b = @mod(a, b);
-        a = c;
+            assert(a > 0);
+            return a;
+        },
     }
+}
 
-    assert(a > 0);
-    return a;
+test gcd {
+    var prng = std.Random.DefaultPrng.init(std.testing.random_seed);
+    var random = prng.random();
+
+    for (0..1000) |_| {
+        const a = random.int(u32);
+        const b = random.int(u32);
+        if (a == 0 or b == 0) continue;
+
+        try expectEqual(
+            gcd(a, b),
+            @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 {
@@ -229,8 +380,9 @@ fn doTurn(r: anytype) !void {
 }
 
 test Rational {
-    inline for (.{ u64, u128, f64 }) |t| {
-        var r: Rational(t) = .{};
+    inline for (.{ u64, u128, u256, f64 }) |t| {
+        const R = Rational(t);
+        var r: R = .{};
 
         var c: t = 128;
         _ = &c;
@@ -239,7 +391,7 @@ test Rational {
         try doTurn(&r);
 
         r.reduce();
-        try expectEqual(Rational(t){ .p = 75383, .q = 35550920704 }, r);
+        try expectEqual(R{ .p = 75383, .q = 35550920704 }, r);
 
         try r.update(1, 4);
         if (t == u64) {
@@ -247,110 +399,42 @@ test Rational {
         } else {
             try doTurn(&r);
             r.reduce();
-            try expectEqual(Rational(t){ .p = 5682596689, .q = 2527735925804191711232 }, r);
+            try expectEqual(R{ .p = 5682596689, .q = 2527735925804191711232 }, r);
         }
 
         r.reset();
 
-        var s = Rational(t){ .p = 10, .q = 13 };
+        var s = R{ .p = 10, .q = 13 };
         try r.mul(&s);
-        s = Rational(t){ .p = 3, .q = 4 };
+        s = R{ .p = 3, .q = 4 };
         try r.mul(&s);
-        try expectEqual(Rational(t){ .p = 30, .q = 52 }, r);
+        try expectEqual(R{ .p = 30, .q = 52 }, r);
 
-        s = Rational(t){ .p = 1, .q = 3 };
+        s = R{ .p = 1, .q = 3 };
         try r.add(&s);
         r.reduce();
-        try expectEqual(Rational(t){ .p = 71, .q = 78 }, r);
-    }
-}
-
-/// Adapter of std.math.big.Rational to the engines Rational interface.
-pub const BigRational = struct {
-    /// The underlying rational number.
-    val: std.math.big.Rational,
-
-    /// Possible error returned by operations on the rational.
-    pub const Error = error{OutOfMemory};
+        try expectEqual(R{ .p = 71, .q = 78 }, r);
 
-    /// Create a new BigRational wrapper.  A small amount of memory will be allocated on
-    /// initialization. Not default initialized to 1 - you must explicitly `reset` first.
-    pub fn init(alloc: std.mem.Allocator) !BigRational {
-        return .{ .val = try std.math.big.Rational.init(alloc) };
-    }
-
-    /// Frees all memory associated with a rational.
-    pub fn deinit(r: *BigRational) void {
-        r.val.deinit();
-    }
-
-    /// Resets the rational back to 1.
-    pub fn reset(r: *BigRational) !void {
-        try r.val.setInt(1);
-    }
-
-    /// Update the rational by multiplying its numerator by p and its denominator by q.
-    /// Both p and q must be >= 1.
-    pub fn update(r: *BigRational, p: anytype, q: anytype) !void {
-        assert(p >= 1);
-        assert(q >= 1);
+        var u = R{ .p = 3, .q = 5 };
+        var v = R{ .p = 2, .q = 5 };
+        try expectEqual(u.cmp(&v), .gt);
+        v = R{ .p = 4, .q = 5 };
+        try expectEqual(u.cmp(&v), .lt);
 
-        var s = try std.math.big.Rational.init(r.val.p.allocator);
-        defer s.deinit();
-        try s.setRatio(p, q);
-        try r.val.mul(r.val, s);
-    }
+        v = R{ .p = 3, .q = 6 };
+        try expectEqual(u.cmp(&v), .gt);
+        v = R{ .p = 3, .q = 4 };
+        try expectEqual(u.cmp(&v), .lt);
 
-    /// Adds two rationals.
-    pub fn add(r: *BigRational, s: *const BigRational) !void {
-        try r.val.add(r.val, s.val);
-    }
+        v = R{ .p = 3, .q = 5 };
+        try expectEqual(u.cmp(&v), .eq);
 
-    /// Multiplies two rationals.
-    pub fn mul(r: *BigRational, s: *const BigRational) !void {
-        try r.val.mul(r.val, s.val);
+        try doTurn(&u);
+        v = R{ .p = 4567216874, .q = 89124781931235 };
+        if (t == u64) {
+            try expectEqual(u.cmp(&v), error.Overflow);
+        } else {
+            try expectEqual(u.cmp(&v), .lt);
+        }
     }
-};
-
-test BigRational {
-    var r = try BigRational.init(std.testing.allocator);
-    defer r.deinit();
-    var s = try std.math.big.Rational.init(std.testing.allocator);
-    defer s.deinit();
-
-    try r.reset();
-
-    var c: u8 = 128;
-    _ = &c;
-
-    try r.update(c, 256);
-    try doTurn(&r);
-
-    try s.setRatio(75383, 35550920704);
-    try expect((try s.order(r.val)) == .eq);
-
-    try r.update(1, 4);
-    try doTurn(&r);
-
-    try s.setRatio(5682596689, 2527735925804191711232);
-    try expect((try s.order(r.val)) == .eq);
-
-    try r.reset();
-
-    var t = try BigRational.init(std.testing.allocator);
-    defer t.deinit();
-
-    try t.val.setRatio(10, 13);
-    try r.mul(&t);
-    try t.val.setRatio(3, 4);
-    try r.mul(&t);
-
-    try s.setRatio(15, 26);
-    try expect((try s.order(r.val)) == .eq);
-
-    try t.val.setRatio(1, 3);
-    try r.add(&t);
-
-    try s.setRatio(71, 78);
-    try expect((try s.order(r.val)) == .eq);
 }