[framework] vector macros wave 3 #18796
Open
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
tnowacki
reviewed
Jul 25, 2024
damirka
force-pushed
the
ds/vector-macros-wave-3
branch
from
3c1503f
to
1f6f169
Compare
tnowacki
reviewed
Jul 29, 2024
| @@ -158,6 +158,40 @@ module std::vector { | |||
| v.pop_back() | |||
| } | |||
|
|
|||
| /// Take all elements of the vector `v` except the first `n` elements. Aborts if `n` is greater | |||
| /// than the length of `v`. Modifies the original vector. | |||
| public fun skip_mut<T>(v: &mut vector<T>, n: u64): vector<T> { | |||
There was a problem hiding this comment.
At first, I thought maybe this was backwards and this should be take_mut, but I think this makes sense: you want to return the desired elements. In short, you want the return values of skip|take to match with (skip|take)_mut
| /// Take all elements of the vector `v` except the first `n` elements. Aborts if `n` is greater | ||
| /// than the length of `v`. Modifies the original vector. | ||
| public fun skip_mut<T>(v: &mut vector<T>, n: u64): vector<T> { | ||
| assert!(n <= v.length()); |
There was a problem hiding this comment.
I think this is the correct choice, but just wanted to double check.
If folks don't want it to assert they should do let len = v.length(); v.skip(n.min(len)), which hopefully makes this more explicit for the person auditing/reading the code
| /// Destroys the original vector after taking the elements. | ||
| public macro fun take_while<$T: drop>($v: vector<$T>, $p: |&$T| -> bool): vector<$T> { | ||
| let mut v = $v; | ||
| take_mut_while!(&mut v, $p) |
There was a problem hiding this comment.
Suggested change
| take_mut_while!(&mut v, $p) | |
| v.take_mut_while!($p) |
| /// and drop the vector. | ||
| public macro fun skip_while<$T: drop>($v: vector<$T>, $p: |&$T| -> bool): vector<$T> { | ||
| let mut v = $v; | ||
| skip_mut_while!(&mut v, $p) |
There was a problem hiding this comment.
Suggested change
| skip_mut_while!(&mut v, $p) | |
| v.skip_mut_while!($p) |
| public macro fun skip_mut_while<$T>($v: &mut vector<$T>, $p: |&$T| -> bool): vector<$T> { | ||
| let v = $v; | ||
| // find first element that does not satisfy the predicate, then skip from there | ||
| v.find_index!(|e| !$p(e)).map!(|c| v.skip_mut(c)).destroy_or!(vector[]) |
There was a problem hiding this comment.
Nit, while slick, it might be nice to avoid the 2 separate iterations over v. Especially since this is library code, small optimizations can be really meaningful
Comment on lines
+869
to
+871
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].skip_while!(|e| *e == 1) == vector[2, 2, 2, 3, 3, 3]); | ||
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].skip_while!(|e| *e == 2) == vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); | ||
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].skip_while!(|e| *e == 3) == vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); |
There was a problem hiding this comment.
Suggested change
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].skip_while!(|e| *e == 1) == vector[2, 2, 2, 3, 3, 3]); | |
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].skip_while!(|e| *e == 2) == vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); | |
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].skip_while!(|e| *e == 3) == vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); | |
| let v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.skip_while!(|_| false), v); | |
| assert_eq!(v.skip_while!(|e| *e == 1), vector[2, 2, 2, 3, 3, 3]); | |
| assert_eq!(v.skip_while!(|e| *e <= 2), vector[3, 3, 3]); | |
| assert_eq!(v.skip_while!(|_| true), vector[]); |
Comment on lines
+861
to
+864
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | ||
| assert!(v.skip_mut_while!(|e| *e == 1) == vector[2, 2, 2, 3, 3, 3]); | ||
| assert!(v.skip_mut_while!(|e| *e == 2) == vector[1, 1, 1]); | ||
| assert!(v.skip_mut_while!(|e| *e == 3) == vector[]); // v = vector[] |
There was a problem hiding this comment.
Suggested change
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert!(v.skip_mut_while!(|e| *e == 1) == vector[2, 2, 2, 3, 3, 3]); | |
| assert!(v.skip_mut_while!(|e| *e == 2) == vector[1, 1, 1]); | |
| assert!(v.skip_mut_while!(|e| *e == 3) == vector[]); // v = vector[] | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.skip_mut_while!(|_| false), vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); | |
| assert_eq!(v, vector[]); | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.skip_mut_while!(|e| *e == 1), vector[2, 2, 2, 3, 3, 3]); | |
| assert_eq!(v, vector[1, 1, 1]); | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.skip_mut_while!(|e| *e <= 2), vector[3, 3, 3]); | |
| assert_eq!(v, vector[1, 1, 1, 2, 2, 2]); | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.skip_mut_while!(|_| true), vector[]); | |
| assert_eq!(v, vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); |
Comment on lines
+854
to
+856
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].take_while!(|e| *e == 1) == vector[1, 1, 1]); | ||
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].take_while!(|e| *e == 2) == vector[]); | ||
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].take_while!(|e| *e == 3) == vector[]); |
There was a problem hiding this comment.
Suggested change
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].take_while!(|e| *e == 1) == vector[1, 1, 1]); | |
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].take_while!(|e| *e == 2) == vector[]); | |
| assert!(vector[1, 1, 1, 2, 2, 2, 3, 3, 3].take_while!(|e| *e == 3) == vector[]); | |
| let v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.take_while!(|_| false), vector[]); | |
| assert_eq!(v.take_while!(|e| *e == 1), vector[1, 1, 1]); | |
| assert_eq!(v.take_while!(|e| *e <= 2), vector[1, 1, 1, 2, 2, 2]); | |
| assert_eq!(v.take_while!(|_| true), v); |
Comment on lines
+843
to
+849
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | ||
| assert!(v.take_mut_while!(|e| *e == 1) == vector[1, 1, 1]); | ||
| assert!(v == vector[2, 2, 2, 3, 3, 3]); | ||
| assert!(v.take_mut_while!(|e| *e == 2) == vector[2, 2, 2]); | ||
| assert!(v == vector[3, 3, 3]); | ||
| assert!(v.take_mut_while!(|e| *e == 3) == vector[3, 3, 3]); | ||
| assert!(v.length() == 0); |
There was a problem hiding this comment.
Suggested change
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert!(v.take_mut_while!(|e| *e == 1) == vector[1, 1, 1]); | |
| assert!(v == vector[2, 2, 2, 3, 3, 3]); | |
| assert!(v.take_mut_while!(|e| *e == 2) == vector[2, 2, 2]); | |
| assert!(v == vector[3, 3, 3]); | |
| assert!(v.take_mut_while!(|e| *e == 3) == vector[3, 3, 3]); | |
| assert!(v.length() == 0); | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.take_mut_while!(|_| false), vector[]); | |
| assert_eq!(v, vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.take_mut_while!(|e| *e == 1), vector[1, 1, 1]); | |
| assert_eq!(v, vector[2, 2, 2, 3, 3, 3]); | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.take_mut_while!(|e| *e <= 2), vector[1, 1, 1, 2, 2, 2]); | |
| assert_eq!(v, vector[3, 3, 3]); | |
| let mut v = vector[1, 1, 1, 2, 2, 2, 3, 3, 3]; | |
| assert_eq!(v.take_mut_while!(|_| true), vector[1, 1, 1, 2, 2, 2, 3, 3, 3]); | |
| assert_eq!(v, vector[]); |
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.
Description
Adds the 3rd wave of macros for vector.
Also fixes a bug introduced in
find_indexwhich consumed the vector.Test plan
How did you test the new or updated feature?
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.