Commit f5c27dd11a

Robin Voetter <robin@voetter.nl>
2021-09-23 04:08:27
big ints: 2s complement signed or
1 parent 3b09262
Changed files (2)
lib
std
lib/std/math/big/int.zig
@@ -552,21 +552,29 @@ pub const Mutable = struct {
         r.positive = a.positive;
     }
 
-    /// r = a | b
+    /// r = a | b under 2s complement semantics.
     /// r may alias with a or b.
     ///
     /// a and b are zero-extended to the longer of a or b.
     ///
     /// Asserts that r has enough limbs to store the result. Upper bound is `math.max(a.limbs.len, b.limbs.len)`.
     pub fn bitOr(r: *Mutable, a: Const, b: Const) void {
-        if (a.limbs.len > b.limbs.len) {
-            llor(r.limbs[0..], a.limbs[0..a.limbs.len], b.limbs[0..b.limbs.len]);
-            r.len = a.limbs.len;
+        // Trivial cases, llsignedor does not support zero.
+        if (a.eqZero()) {
+            r.copy(b);
+            return;
+        } else if (b.eqZero()) {
+            r.copy(a);
+            return;
+        }
+
+        if (a.limbs.len >= b.limbs.len) {
+            r.positive = llsignedor(r.limbs, a.limbs, a.positive, b.limbs, b.positive);
+            r.normalize(a.limbs.len);
         } else {
-            llor(r.limbs[0..], b.limbs[0..b.limbs.len], a.limbs[0..a.limbs.len]);
-            r.len = b.limbs.len;
+            r.positive = llsignedor(r.limbs, b.limbs, b.positive, a.limbs, a.positive);
+            r.normalize(b.limbs.len);
         }
-        r.positive = a.positive or b.positive;
     }
 
     /// r = a & b
@@ -2236,17 +2244,119 @@ fn llshr(r: []Limb, a: []const Limb, shift: usize) void {
     }
 }
 
-fn llor(r: []Limb, a: []const Limb, b: []const Limb) void {
+fn llsignedor(r: []Limb, a: []const Limb, a_positive: bool, b: []const Limb, b_positive: bool) bool {
     @setRuntimeSafety(debug_safety);
     assert(r.len >= a.len);
     assert(a.len >= b.len);
 
-    var i: usize = 0;
-    while (i < b.len) : (i += 1) {
-        r[i] = a[i] | b[i];
-    }
-    while (i < a.len) : (i += 1) {
-        r[i] = a[i];
+    if (a_positive and b_positive) {
+        // Trivial case, result is positive.,
+        var i: usize = 0;
+        while (i < b.len) : (i += 1) {
+            r[i] = a[i] | b[i];
+        }
+        while (i < a.len) : (i += 1) {
+            r[i] = a[i];
+        }
+
+        return true;
+    } else if (!a_positive and b_positive) {
+        // r = (--a) | b
+        //   = ~(-a - 1) | b
+        //   = ~(-a - 1) | ~~b
+        //   = ~((-a - 1) & ~b)
+        //   = -(((-a - 1) & ~b) + 1)
+        // result is negative.
+
+        var i: usize = 0;
+        var a_borrow: u1 = 1;
+        var r_carry: u1 = 1;
+
+        while (i < b.len) : (i += 1) {
+            var a_limb: Limb = undefined;
+            a_borrow = @boolToInt(@subWithOverflow(Limb, a[i], a_borrow, &a_limb));
+
+            r[i] = a_limb & ~b[i];
+            r_carry = @boolToInt(@addWithOverflow(Limb, r[i], r_carry, &r[i]));
+        }
+
+        // With b = 0, we get (-a - 1) & ~0 = -a - 1.
+        while (i < a.len) : (i += 1) {
+            a_borrow = @boolToInt(@subWithOverflow(Limb, a[i], a_borrow, &r[i]));
+            r_carry = @boolToInt(@addWithOverflow(Limb, r[i], r_carry, &r[i]));
+        }
+
+        assert(a_borrow == 0); // a was 0.
+
+        // Can never overflow because a_borrow would need to equal 1.
+        assert(r_carry == 0);
+
+        return false;
+    } else if (a_positive and !b_positive) {
+        // r = a | (--b)
+        //   = a | ~(-b - 1)
+        //   = ~~a | ~(-b - 1)
+        //   = ~(~a & (-b - 1))
+        //   = -((~a & (-b - 1)) + 1)
+        // result is negative.
+
+        var i: usize = 0;
+        var b_borrow: u1 = 1;
+        var r_carry: u1 = 1;
+
+        while (i < b.len) : (i += 1) {
+            var b_limb: Limb = undefined;
+            b_borrow = @boolToInt(@subWithOverflow(Limb, b[i], b_borrow, &b_limb));
+
+            r[i] = ~a[i] & b_limb;
+            r_carry = @boolToInt(@addWithOverflow(Limb, r[i], r_carry, &r[i]));
+        }
+
+        // b is at least 1, so this should never underflow.
+        assert(b_borrow == 0); // b was 0
+
+        // Can never overflow because in order for b_limb to be maxInt(Limb),
+        // b_borrow would need to equal 1.
+        assert(r_carry == 0);
+
+        // With b = 0 and b_borrow = 0, we get ~a & (-0 - 0) = ~a & 0 = 0.
+        mem.set(Limb, r[i..a.len], 0);
+
+        return false;
+    } else {
+        // r = (--a) | (--b)
+        //   = ~(-a - 1) | ~(-b - 1)
+        //   = ~((-a - 1) & (-b - 1))
+        //   = -(~(~((-a - 1) & (-b - 1))) + 1)
+        //   = -((-a - 1) & (-b - 1) + 1)
+        // result is negative.
+
+        var i: usize = 0;
+        var a_borrow: u1 = 1;
+        var b_borrow: u1 = 1;
+        var r_carry: u1 = 1;
+
+        while (i < b.len) : (i += 1) {
+            var a_limb: Limb = undefined;
+            a_borrow = @boolToInt(@subWithOverflow(Limb, a[i], a_borrow, &a_limb));
+
+            var b_limb: Limb = undefined;
+            b_borrow = @boolToInt(@subWithOverflow(Limb, b[i], b_borrow, &b_limb));
+
+            r[i] = a_limb & b_limb;
+            r_carry = @boolToInt(@addWithOverflow(Limb, r[i], r_carry, &r[i]));
+        }
+
+        // b is at least 1, so this should never underflow.
+        assert(b_borrow == 0); // b was 0
+
+        // Can never overflow because in order for b_limb to be maxInt(Limb),
+        // b_borrow would need to equal 1.
+        assert(r_carry == 0);
+
+        // With b = 0 and b_borrow = 0 we get (-a - 1) & (-0 - 0) = (-a - 1) & 0 = 0.
+        mem.set(Limb, r[i..a.len], 0);
+        return false;
     }
 }
 
lib/std/math/big/int_test.zig
@@ -1476,6 +1476,72 @@ test "big.int bitwise or multi-limb" {
     try testing.expect((try a.to(DoubleLimb)) == (maxInt(Limb) + 1) + maxInt(Limb));
 }
 
+test "big.int bitwise or negative-positive simple" {
+    var a = try Managed.initSet(testing.allocator, -0xffffffff11111111);
+    defer a.deinit();
+    var b = try Managed.initSet(testing.allocator, 0xeeeeeeee22222222);
+    defer b.deinit();
+
+    try a.bitOr(a, b);
+
+    try testing.expect((try a.to(i64)) == -0x1111111111111111);
+}
+
+test "big.int bitwise or negative-positive multi-limb" {
+    var a = try Managed.initSet(testing.allocator, -maxInt(Limb) - 1);
+    defer a.deinit();
+    var b = try Managed.initSet(testing.allocator, 1);
+    defer b.deinit();
+
+    try a.bitOr(a, b);
+
+    try testing.expect((try a.to(SignedDoubleLimb)) == -maxInt(Limb));
+}
+
+test "big.int bitwise or positive-negative simple" {
+    var a = try Managed.initSet(testing.allocator, 0xffffffff11111111);
+    defer a.deinit();
+    var b = try Managed.initSet(testing.allocator, -0xeeeeeeee22222222);
+    defer b.deinit();
+
+    try a.bitOr(a, b);
+
+    try testing.expect((try a.to(i64)) == -0x22222221);
+}
+
+test "big.int bitwise or positive-negative multi-limb" {
+    var a = try Managed.initSet(testing.allocator, maxInt(Limb) + 1);
+    defer a.deinit();
+    var b = try Managed.initSet(testing.allocator, -1);
+    defer b.deinit();
+
+    try a.bitOr(a, b);
+
+    try testing.expect((try a.to(SignedDoubleLimb)) == -1);
+}
+
+test "big.int bitwise or negative-negative simple" {
+    var a = try Managed.initSet(testing.allocator, -0x0fffffff11111111);
+    defer a.deinit();
+    var b = try Managed.initSet(testing.allocator, -0x0eeeeeee22222222);
+    defer b.deinit();
+
+    try a.bitOr(a, b);
+
+    try testing.expect((try a.to(i64)) == -0xeeeeeee00000001);
+}
+
+test "big.int bitwise or negative-negative multi-limb" {
+    var a = try Managed.initSet(testing.allocator, -maxInt(Limb) - 1);
+    defer a.deinit();
+    var b = try Managed.initSet(testing.allocator, -maxInt(Limb));
+    defer b.deinit();
+
+    try a.bitOr(a, b);
+
+    try testing.expect((try a.to(SignedDoubleLimb)) == -maxInt(Limb));
+}
+
 test "big.int var args" {
     var a = try Managed.initSet(testing.allocator, 5);
     defer a.deinit();