Add removeIdx function to PriorityQueue. #4070
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's awkward to use, but lets me cancel events in an event queue.
daurnimator
added
the
standard library
andrewrk
requested changes
Jan 7, 2020
lib/std/priority_queue.zig
Outdated
Comment on lines
94
to
100
| /// Remove and return element at index. If there aren't enough | ||
| /// elements to remove from idx, returns null. Indices are in | ||
| /// the same order as iterator, which is not necessarily | ||
| /// priority order. | ||
| pub fn removeIdx(self: *Self, idx: usize) !T { | ||
| if (self.len <= idx) | ||
| return Self.Error.BoundsError; |
There was a problem hiding this comment.
The docs says "returns null", but it's an error union. Also, should this be an assertion rather than an error?
There was a problem hiding this comment.
Whoops, caught the docs and code disagreeing. You're probably right about it being an assertion. It saves a branch, and remove doesn't return an error.
| @@ -77,6 +78,8 @@ pub fn PriorityQueue(comptime T: type) type { | |||
| return if (self.len > 0) self.remove() else null; | |||
| } | |||
|
|
|||
| /// Remove and return the highest priority element from the | |||
| /// queue. | |||
| pub fn remove(self: *Self) T { | |||
There was a problem hiding this comment.
Should remove be changed to call removeIdx(0) now?
lib/std/priority_queue.zig
Outdated
| /// elements to remove from idx, returns null. Indices are in | ||
| /// the same order as iterator, which is not necessarily | ||
| /// priority order. | ||
| pub fn removeIdx(self: *Self, idx: usize) !T { |
There was a problem hiding this comment.
We have precedence in the std lib for spelling "Index" out:
zig/lib/std/segmented_list.zig
Line 239 in 9390e8b
There was a problem hiding this comment.
Also a good point.
Rename to removeIndex, change return type and use an assertion, fix the comment, and have remove call removeIndex.
data-man
reviewed
Jan 8, 2020
nmichaels
commented
Jan 8, 2020
nmichaels
commented
Jan 8, 2020
nmichaels
commented
Jan 8, 2020
Co-Authored-By: Dmitry Atamanov <data-man@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's awkward to use, but lets me cancel events in an event queue.