diff --git a/lib/std/priority_dequeue.zig b/lib/std/priority_dequeue.zig index e2a01696e595948639496dd97ac4307be54b88b9..33cf0eadbb44b3b3099c48a60575b5c298dca187 100644 --- a/lib/std/priority_dequeue.zig +++ b/lib/std/priority_dequeue.zig @@ -21,33 +21,31 @@ pub fn PriorityDequeue(comptime T: type, comptime Context: type, comptime compar items: []T, len: usize, - allocator: Allocator, context: Context, /// Initialize and return a new priority dequeue. - pub fn init(allocator: Allocator, context: Context) Self { + pub fn init(context: Context) Self { return Self{ .items = &[_]T{}, .len = 0, - .allocator = allocator, .context = context, }; } /// Free memory used by the dequeue. - pub fn deinit(self: Self) void { - self.allocator.free(self.items); + pub fn deinit(self: Self, allocator: Allocator) void { + allocator.free(self.items); } /// Insert a new element, maintaining priority. - pub fn add(self: *Self, elem: T) !void { - try self.ensureUnusedCapacity(1); + pub fn add(self: *Self, allocator: Allocator, elem: T) !void { + try self.ensureUnusedCapacity(allocator, 1); addUnchecked(self, elem); } /// Add each element in `items` to the dequeue. - pub fn addSlice(self: *Self, items: []const T) !void { - try self.ensureUnusedCapacity(items.len); + pub fn addSlice(self: *Self, allocator: Allocator, items: []const T) !void { + try self.ensureUnusedCapacity(allocator, items.len); for (items) |e| { self.addUnchecked(e); } @@ -333,14 +331,12 @@ pub fn PriorityDequeue(comptime T: type, comptime Context: type, comptime compar return self.items.len; } - /// Dequeue takes ownership of the passed in slice. The slice must have been - /// allocated with `allocator`. - /// De-initialize with `deinit`. - pub fn fromOwnedSlice(allocator: Allocator, items: []T, context: Context) Self { + /// Dequeue takes ownership of the passed in slice. The slice must be de-initialize + /// with `deinit`. + pub fn fromOwnedSlice(items: []T, context: Context) Self { var queue = Self{ .items = items, .len = items.len, - .allocator = allocator, .context = context, }; @@ -356,29 +352,29 @@ pub fn PriorityDequeue(comptime T: type, comptime Context: type, comptime compar } /// Ensure that the dequeue can fit at least `new_capacity` items. - pub fn ensureTotalCapacity(self: *Self, new_capacity: usize) !void { + pub fn ensureTotalCapacity(self: *Self, allocator: Allocator, new_capacity: usize) !void { var better_capacity = self.capacity(); if (better_capacity >= new_capacity) return; while (true) { better_capacity += better_capacity / 2 + 8; if (better_capacity >= new_capacity) break; } - self.items = try self.allocator.realloc(self.items, better_capacity); + self.items = try allocator.realloc(self.items, better_capacity); } /// Ensure that the dequeue can fit at least `additional_count` **more** items. - pub fn ensureUnusedCapacity(self: *Self, additional_count: usize) !void { - return self.ensureTotalCapacity(self.len + additional_count); + pub fn ensureUnusedCapacity(self: *Self, allocator: Allocator, additional_count: usize) !void { + return self.ensureTotalCapacity(allocator, self.len + additional_count); } /// Reduce allocated capacity to `new_len`. - pub fn shrinkAndFree(self: *Self, new_len: usize) void { + pub fn shrinkAndFree(self: *Self, allocator: Allocator, new_len: usize) void { assert(new_len <= self.items.len); // Cannot shrink to smaller than the current queue size without invalidating the heap property assert(new_len >= self.len); - self.items = self.allocator.realloc(self.items[0..], new_len) catch |e| switch (e) { + self.items = allocator.realloc(self.items[0..], new_len) catch |e| switch (e) { error.OutOfMemory => { // no problem, capacity is still correct then. self.items.len = new_len; return; @@ -468,15 +464,16 @@ fn lessThanComparison(context: void, a: u32, b: u32) Order { const PDQ = PriorityDequeue(u32, void, lessThanComparison); test "add and remove min" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + var queue = PDQ.init({}); + defer queue.deinit(gpa); - try queue.add(54); - try queue.add(12); - try queue.add(7); - try queue.add(23); - try queue.add(25); - try queue.add(13); + try queue.add(gpa, 54); + try queue.add(gpa, 12); + try queue.add(gpa, 7); + try queue.add(gpa, 23); + try queue.add(gpa, 25); + try queue.add(gpa, 13); try expectEqual(@as(u32, 7), queue.removeMin()); try expectEqual(@as(u32, 12), queue.removeMin()); @@ -487,6 +484,8 @@ test "add and remove min" { } test "add and remove min structs" { + const gpa = std.testing.allocator; + const S = struct { size: u32, }; @@ -495,15 +494,15 @@ test "add and remove min structs" { _ = context; return std.math.order(a.size, b.size); } - }.order).init(testing.allocator, {}); - defer queue.deinit(); + }.order).init({}); + defer queue.deinit(gpa); - try queue.add(.{ .size = 54 }); - try queue.add(.{ .size = 12 }); - try queue.add(.{ .size = 7 }); - try queue.add(.{ .size = 23 }); - try queue.add(.{ .size = 25 }); - try queue.add(.{ .size = 13 }); + try queue.add(gpa, .{ .size = 54 }); + try queue.add(gpa, .{ .size = 12 }); + try queue.add(gpa, .{ .size = 7 }); + try queue.add(gpa, .{ .size = 23 }); + try queue.add(gpa, .{ .size = 25 }); + try queue.add(gpa, .{ .size = 13 }); try expectEqual(@as(u32, 7), queue.removeMin().size); try expectEqual(@as(u32, 12), queue.removeMin().size); @@ -514,15 +513,17 @@ test "add and remove min structs" { } test "add and remove max" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(54); - try queue.add(12); - try queue.add(7); - try queue.add(23); - try queue.add(25); - try queue.add(13); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 54); + try queue.add(gpa, 12); + try queue.add(gpa, 7); + try queue.add(gpa, 23); + try queue.add(gpa, 25); + try queue.add(gpa, 13); try expectEqual(@as(u32, 54), queue.removeMax()); try expectEqual(@as(u32, 25), queue.removeMax()); @@ -533,15 +534,17 @@ test "add and remove max" { } test "add and remove same min" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(1); - try queue.add(1); - try queue.add(2); - try queue.add(2); - try queue.add(1); - try queue.add(1); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 1); + try queue.add(gpa, 1); + try queue.add(gpa, 2); + try queue.add(gpa, 2); + try queue.add(gpa, 1); + try queue.add(gpa, 1); try expectEqual(@as(u32, 1), queue.removeMin()); try expectEqual(@as(u32, 1), queue.removeMin()); @@ -552,15 +555,17 @@ test "add and remove same min" { } test "add and remove same max" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(1); - try queue.add(1); - try queue.add(2); - try queue.add(2); - try queue.add(1); - try queue.add(1); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 1); + try queue.add(gpa, 1); + try queue.add(gpa, 2); + try queue.add(gpa, 2); + try queue.add(gpa, 1); + try queue.add(gpa, 1); try expectEqual(@as(u32, 2), queue.removeMax()); try expectEqual(@as(u32, 2), queue.removeMax()); @@ -571,20 +576,24 @@ test "add and remove same max" { } test "removeOrNull empty" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); try expect(queue.removeMinOrNull() == null); try expect(queue.removeMaxOrNull() == null); } test "edge case 3 elements" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(9); - try queue.add(3); - try queue.add(2); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 9); + try queue.add(gpa, 3); + try queue.add(gpa, 2); try expectEqual(@as(u32, 2), queue.removeMin()); try expectEqual(@as(u32, 3), queue.removeMin()); @@ -592,12 +601,14 @@ test "edge case 3 elements" { } test "edge case 3 elements max" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(9); - try queue.add(3); - try queue.add(2); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 9); + try queue.add(gpa, 3); + try queue.add(gpa, 2); try expectEqual(@as(u32, 9), queue.removeMax()); try expectEqual(@as(u32, 3), queue.removeMax()); @@ -605,39 +616,46 @@ test "edge case 3 elements max" { } test "peekMin" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); try expect(queue.peekMin() == null); - try queue.add(9); - try queue.add(3); - try queue.add(2); + try queue.add(gpa, 9); + try queue.add(gpa, 3); + try queue.add(gpa, 2); try expect(queue.peekMin().? == 2); try expect(queue.peekMin().? == 2); } test "peekMax" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); try expect(queue.peekMin() == null); - try queue.add(9); - try queue.add(3); - try queue.add(2); + try queue.add(gpa, 9); + try queue.add(gpa, 3); + try queue.add(gpa, 2); try expect(queue.peekMax().? == 9); try expect(queue.peekMax().? == 9); } test "sift up with odd indices, removeMin" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); + const items = [_]u32{ 15, 7, 21, 14, 13, 22, 12, 6, 7, 25, 5, 24, 11, 16, 15, 24, 2, 1 }; for (items) |e| { - try queue.add(e); + try queue.add(gpa, e); } const sorted_items = [_]u32{ 1, 2, 5, 6, 7, 7, 11, 12, 13, 14, 15, 15, 16, 21, 22, 24, 24, 25 }; @@ -647,11 +665,14 @@ test "sift up with odd indices, removeMin" { } test "sift up with odd indices, removeMax" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); + const items = [_]u32{ 15, 7, 21, 14, 13, 22, 12, 6, 7, 25, 5, 24, 11, 16, 15, 24, 2, 1 }; for (items) |e| { - try queue.add(e); + try queue.add(gpa, e); } const sorted_items = [_]u32{ 25, 24, 24, 22, 21, 16, 15, 15, 14, 13, 12, 11, 7, 7, 6, 5, 2, 1 }; @@ -661,10 +682,13 @@ test "sift up with odd indices, removeMax" { } test "addSlice min" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); + const items = [_]u32{ 15, 7, 21, 14, 13, 22, 12, 6, 7, 25, 5, 24, 11, 16, 15, 24, 2, 1 }; - try queue.addSlice(items[0..]); + try queue.addSlice(gpa, items[0..]); const sorted_items = [_]u32{ 1, 2, 5, 6, 7, 7, 11, 12, 13, 14, 15, 15, 16, 21, 22, 24, 24, 25 }; for (sorted_items) |e| { @@ -673,10 +697,13 @@ test "addSlice min" { } test "addSlice max" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); + const items = [_]u32{ 15, 7, 21, 14, 13, 22, 12, 6, 7, 25, 5, 24, 11, 16, 15, 24, 2, 1 }; - try queue.addSlice(items[0..]); + try queue.addSlice(gpa, items[0..]); const sorted_items = [_]u32{ 25, 24, 24, 22, 21, 16, 15, 15, 14, 13, 12, 11, 7, 7, 6, 5, 2, 1 }; for (sorted_items) |e| { @@ -685,19 +712,26 @@ test "addSlice max" { } test "fromOwnedSlice trivial case 0" { + const gpa = std.testing.allocator; + const items = [0]u32{}; - const queue_items = try testing.allocator.dupe(u32, &items); - var queue = PDQ.fromOwnedSlice(testing.allocator, queue_items[0..], {}); - defer queue.deinit(); + const queue_items = try gpa.dupe(u32, &items); + + var queue = PDQ.fromOwnedSlice(queue_items[0..], {}); + defer queue.deinit(gpa); + try expectEqual(@as(usize, 0), queue.len); try expect(queue.removeMinOrNull() == null); } test "fromOwnedSlice trivial case 1" { + const gpa = std.testing.allocator; + const items = [1]u32{1}; - const queue_items = try testing.allocator.dupe(u32, &items); - var queue = PDQ.fromOwnedSlice(testing.allocator, queue_items[0..], {}); - defer queue.deinit(); + const queue_items = try gpa.dupe(u32, &items); + + var queue = PDQ.fromOwnedSlice(queue_items[0..], {}); + defer queue.deinit(gpa); try expectEqual(@as(usize, 1), queue.len); try expectEqual(items[0], queue.removeMin()); @@ -705,10 +739,13 @@ test "fromOwnedSlice trivial case 1" { } test "fromOwnedSlice" { + const gpa = std.testing.allocator; + const items = [_]u32{ 15, 7, 21, 14, 13, 22, 12, 6, 7, 25, 5, 24, 11, 16, 15, 24, 2, 1 }; - const queue_items = try testing.allocator.dupe(u32, items[0..]); - var queue = PDQ.fromOwnedSlice(testing.allocator, queue_items[0..], {}); - defer queue.deinit(); + const queue_items = try gpa.dupe(u32, items[0..]); + + var queue = PDQ.fromOwnedSlice(queue_items[0..], {}); + defer queue.deinit(gpa); const sorted_items = [_]u32{ 1, 2, 5, 6, 7, 7, 11, 12, 13, 14, 15, 15, 16, 21, 22, 24, 24, 25 }; for (sorted_items) |e| { @@ -717,12 +754,14 @@ test "fromOwnedSlice" { } test "update min queue" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(55); - try queue.add(44); - try queue.add(11); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 55); + try queue.add(gpa, 44); + try queue.add(gpa, 11); try queue.update(55, 5); try queue.update(44, 4); try queue.update(11, 1); @@ -732,13 +771,15 @@ test "update min queue" { } test "update same min queue" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(1); - try queue.add(1); - try queue.add(2); - try queue.add(2); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 1); + try queue.add(gpa, 1); + try queue.add(gpa, 2); + try queue.add(gpa, 2); try queue.update(1, 5); try queue.update(2, 4); try expectEqual(@as(u32, 1), queue.removeMin()); @@ -748,12 +789,14 @@ test "update same min queue" { } test "update max queue" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(55); - try queue.add(44); - try queue.add(11); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 55); + try queue.add(gpa, 44); + try queue.add(gpa, 11); try queue.update(55, 5); try queue.update(44, 1); try queue.update(11, 4); @@ -764,13 +807,15 @@ test "update max queue" { } test "update same max queue" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(1); - try queue.add(1); - try queue.add(2); - try queue.add(2); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 1); + try queue.add(gpa, 1); + try queue.add(gpa, 2); + try queue.add(gpa, 2); try queue.update(1, 5); try queue.update(2, 4); try expectEqual(@as(u32, 5), queue.removeMax()); @@ -780,25 +825,29 @@ test "update same max queue" { } test "update after remove" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(1); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 1); try expectEqual(@as(u32, 1), queue.removeMin()); try expectError(error.ElementNotFound, queue.update(1, 1)); } test "iterator" { - var queue = PDQ.init(testing.allocator, {}); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); var map = std.AutoHashMap(u32, void).init(testing.allocator); defer { - queue.deinit(); + queue.deinit(gpa); map.deinit(); } const items = [_]u32{ 54, 12, 7, 23, 25, 13 }; for (items) |e| { - _ = try queue.add(e); + _ = try queue.add(gpa, e); _ = try map.put(e, {}); } @@ -811,12 +860,14 @@ test "iterator" { } test "remove at index" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.add(3); - try queue.add(2); - try queue.add(1); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.add(gpa, 3); + try queue.add(gpa, 2); + try queue.add(gpa, 1); var it = queue.iterator(); var elem = it.next(); @@ -834,8 +885,10 @@ test "remove at index" { } test "iterator while empty" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; + + var queue = PDQ.init({}); + defer queue.deinit(gpa); var it = queue.iterator(); @@ -843,19 +896,21 @@ test "iterator while empty" { } test "shrinkAndFree" { - var queue = PDQ.init(testing.allocator, {}); - defer queue.deinit(); + const gpa = std.testing.allocator; - try queue.ensureTotalCapacity(4); + var queue = PDQ.init({}); + defer queue.deinit(gpa); + + try queue.ensureTotalCapacity(gpa, 4); try expect(queue.capacity() >= 4); - try queue.add(1); - try queue.add(2); - try queue.add(3); + try queue.add(gpa, 1); + try queue.add(gpa, 2); + try queue.add(gpa, 3); try expect(queue.capacity() >= 4); try expectEqual(@as(usize, 3), queue.len); - queue.shrinkAndFree(3); + queue.shrinkAndFree(gpa, 3); try expectEqual(@as(usize, 3), queue.capacity()); try expectEqual(@as(usize, 3), queue.len); @@ -879,11 +934,12 @@ test "fuzz testing min" { } fn fuzzTestMin(rng: std.Random, comptime queue_size: usize) !void { - const allocator = testing.allocator; - const items = try generateRandomSlice(allocator, rng, queue_size); + const gpa = std.testing.allocator; - var queue = PDQ.fromOwnedSlice(allocator, items, {}); - defer queue.deinit(); + const items = try generateRandomSlice(gpa, rng, queue_size); + + var queue = PDQ.fromOwnedSlice(items, {}); + defer queue.deinit(gpa); var last_removed: ?u32 = null; while (queue.removeMinOrNull()) |next| { @@ -908,11 +964,12 @@ test "fuzz testing max" { } fn fuzzTestMax(rng: std.Random, queue_size: usize) !void { - const allocator = testing.allocator; - const items = try generateRandomSlice(allocator, rng, queue_size); + const gpa = std.testing.allocator; - var queue = PDQ.fromOwnedSlice(testing.allocator, items, {}); - defer queue.deinit(); + const items = try generateRandomSlice(gpa, rng, queue_size); + + var queue = PDQ.fromOwnedSlice(items, {}); + defer queue.deinit(gpa); var last_removed: ?u32 = null; while (queue.removeMaxOrNull()) |next| { @@ -937,11 +994,12 @@ test "fuzz testing min and max" { } fn fuzzTestMinMax(rng: std.Random, queue_size: usize) !void { - const allocator = testing.allocator; - const items = try generateRandomSlice(allocator, rng, queue_size); + const gpa = std.testing.allocator; - var queue = PDQ.fromOwnedSlice(allocator, items, {}); - defer queue.deinit(); + const items = try generateRandomSlice(gpa, rng, queue_size); + + var queue = PDQ.fromOwnedSlice(items, {}); + defer queue.deinit(gpa); var last_min: ?u32 = null; var last_max: ?u32 = null; @@ -983,18 +1041,20 @@ fn contextLessThanComparison(context: []const u32, a: usize, b: usize) Order { const CPDQ = PriorityDequeue(usize, []const u32, contextLessThanComparison); test "add and remove" { + const gpa = std.testing.allocator; + const context = [_]u32{ 5, 3, 4, 2, 2, 8, 0 }; - var queue = CPDQ.init(testing.allocator, context[0..]); - defer queue.deinit(); + var queue = CPDQ.init(context[0..]); + defer queue.deinit(gpa); - try queue.add(0); - try queue.add(1); - try queue.add(2); - try queue.add(3); - try queue.add(4); - try queue.add(5); - try queue.add(6); + try queue.add(gpa, 0); + try queue.add(gpa, 1); + try queue.add(gpa, 2); + try queue.add(gpa, 3); + try queue.add(gpa, 4); + try queue.add(gpa, 5); + try queue.add(gpa, 6); try expectEqual(@as(usize, 6), queue.removeMin()); try expectEqual(@as(usize, 5), queue.removeMax()); try expectEqual(@as(usize, 3), queue.removeMin()); @@ -1007,20 +1067,22 @@ test "add and remove" { var all_cmps_unique = true; test "don't compare a value to a copy of itself" { + const gpa = std.testing.allocator; + var depq = PriorityDequeue(u32, void, struct { fn uniqueLessThan(_: void, a: u32, b: u32) Order { all_cmps_unique = all_cmps_unique and (a != b); return std.math.order(a, b); } - }.uniqueLessThan).init(testing.allocator, {}); - defer depq.deinit(); + }.uniqueLessThan).init({}); + defer depq.deinit(gpa); - try depq.add(1); - try depq.add(2); - try depq.add(3); - try depq.add(4); - try depq.add(5); - try depq.add(6); + try depq.add(gpa, 1); + try depq.add(gpa, 2); + try depq.add(gpa, 3); + try depq.add(gpa, 4); + try depq.add(gpa, 5); + try depq.add(gpa, 6); _ = depq.removeIndex(2); try expectEqual(all_cmps_unique, true);