Skip to content

add keepat! for in-place logical filtering#39528

Closed
MasonProtter wants to merge 8 commits intoJuliaLang:masterfrom
MasonProtter:filter_mask
Closed

add keepat! for in-place logical filtering#39528
MasonProtter wants to merge 8 commits intoJuliaLang:masterfrom
MasonProtter:filter_mask

Conversation

@MasonProtter
Copy link
Copy Markdown
Contributor

@MasonProtter MasonProtter commented Feb 5, 2021

Closes #39470

@kshyatt kshyatt added the iteration Involves iteration or the iteration protocol label Feb 6, 2021
@kshyatt
Copy link
Copy Markdown
Member

kshyatt commented Feb 6, 2021

Could doc strings be added for this? Otherwise lgtm

@kshyatt kshyatt added arrays [a, r, r, a, y, s] needs docs Documentation for this change is required labels Feb 6, 2021
@kshyatt kshyatt requested review from kshyatt and rfourquet February 6, 2021 16:28
kshyatt
kshyatt previously requested changes Feb 6, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@kshyatt kshyatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With docs this should be good to go I think

@MasonProtter
Copy link
Copy Markdown
Contributor Author

MasonProtter commented Feb 6, 2021

Done! I also added a NEWS.md entry. Let me know if the descriptions need tweaking.

@MasonProtter MasonProtter mentioned this pull request Feb 7, 2021
Draft
vtjnash
vtjnash reviewed Apr 16, 2021
View reviewed changes
vtjnash
vtjnash reviewed Apr 16, 2021
View reviewed changes
vtjnash
vtjnash approved these changes Apr 16, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@vtjnash vtjnash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a reference to this into doc/src/base/arrays.md

@vtjnash vtjnash added forgetmenot and removed needs docs Documentation for this change is required labels Apr 16, 2021
MasonProtter and others added 3 commits April 16, 2021 14:33
@MasonProtter @vtjnash
Update base/array.jl
d5c7c96 
Co-authored-by: Jameson Nash <vtjnash@gmail.com>
@MasonProtter @vtjnash
Update base/array.jl
46c8533 
Co-authored-by: Jameson Nash <vtjnash@gmail.com>
@MasonProtter
Merge branch 'master' into filter_mask
f696bda
@MasonProtter
Copy link
Copy Markdown
Contributor Author

MasonProtter commented Apr 16, 2021 •
edited
Loading

I can add this to doc/src/base/arrays.md, but maybe it'd fit better in doc/src/base/collections.md as that is where filter! is?

@vtjnash
Copy link
Copy Markdown
Member

vtjnash commented Apr 16, 2021

yeah, that sounds good

@vtjnash vtjnash added merge me PR is reviewed. Merge when all tests are passing and removed forgetmenot labels Apr 16, 2021
vtjnash
vtjnash reviewed Apr 19, 2021
View reviewed changes
base/array.jl
"""
function mask!(a::AbstractVector, m::AbstractVector{Bool})
j = firstindex(a)
for i in eachindex(a, m)
Copy link
Copy Markdown
Member

@vtjnash vtjnash Apr 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q for anyone: is eachindex and nextind / iterate guaranteed to be in the same visit order?

Copy link
Copy Markdown
Member

@vtjnash vtjnash Apr 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mbauman @timholy @JeffBezanson?

@rfourquet
Copy link
Copy Markdown
Member

rfourquet commented Apr 22, 2021

Shouldn't we unify the names with keepat! from #36229? For consistency with deleteat! which accepts either a mask or indices. I think mask! wouldn't work as a name for the keepat! functionality, would keepat! work as a name for the mask! functionality?

@musm
Copy link
Copy Markdown
Contributor

musm commented Apr 28, 2021

Shouldn't we unify the names with keepat! from #36229? For consistency with deleteat! which accepts either a mask or indices. I think mask! wouldn't work as a name for the keepat! functionality, would keepat! work as a name for the mask! functionality?

Good point to bring this up. Are these two PRs stalled on bikeshedding a name?

@simeonschaub simeonschaub added triage This should be discussed on a triage call and removed merge me PR is reviewed. Merge when all tests are passing labels Apr 28, 2021
@simeonschaub
Copy link
Copy Markdown
Member

simeonschaub commented Apr 28, 2021

Removing merge me label and marking for triage since it looks like there still has to be a definite decision made on the name.

@oxinabox
Copy link
Copy Markdown
Contributor

oxinabox commented May 27, 2021 •
edited
Loading

Is the reason we want this just because deleteat!(xs, .!mask) is to expensive because flipping the mask?

@oscardssmith
Copy link
Copy Markdown
Member

oscardssmith commented May 27, 2021

triage says keepat!

@oscardssmith oscardssmith added forgetmenot and removed triage This should be discussed on a triage call labels May 27, 2021
@vtjnash vtjnash changed the title add mask! for in-place logical filtering add keepat! for in-place logical filtering May 27, 2021
@MasonProtter
Copy link
Copy Markdown
Contributor Author

MasonProtter commented May 27, 2021

Okay, I'll amend the PR with the new name, sorry I couldn't make the Triage call.

@rfourquet
Copy link
Copy Markdown
Member

rfourquet commented Jun 7, 2021

@MasonProtter did you close this by inadvertently?

@StefanKarpinski
Copy link
Copy Markdown
Member

StefanKarpinski commented Jun 17, 2021

Reopened in case. Can close again if it was on purpose.

@MasonProtter
Copy link
Copy Markdown
Contributor Author

MasonProtter commented Jun 17, 2021

I closed this because #36229 was merged, which is the exact same thing, right? I didn’t realize they were doing the same thing until yours was merged @rfourquet or I wouldn’t have opened this one in the first place.

@vtjnash vtjnash reopened this Jun 18, 2021
@vtjnash
Copy link
Copy Markdown
Member

vtjnash commented Jun 18, 2021

I believe they do different, but complimentary things

@rfourquet
Copy link
Copy Markdown
Member

rfourquet commented Jun 18, 2021

Yes IIRC, the method from the other PR was receiving indices, while this one here receives a boolean mask.

@MasonProtter
Copy link
Copy Markdown
Contributor Author

MasonProtter commented Jun 18, 2021 •
edited
Loading

🤦 well im glad you paid closer attention than I did!

Should these be methods of the same function, or different functions?

@oscardssmith
Copy link
Copy Markdown
Member

oscardssmith commented Jun 18, 2021

Triage decided on different methods a few weeks ago when we discussed this. The reason is that deleteat has methods for both.

@rashidrafeek rashidrafeek mentioned this pull request Sep 1, 2021
Closed
@bkamins
Copy link
Copy Markdown
Member

bkamins commented Sep 7, 2021

will this get 1.7 label? I would like to add keepat! to JuliaLang/Compat.jl#750 and it would be great to know what contract it will support in 1.7. Thank you!

@JeffBezanson JeffBezanson mentioned this pull request Sep 22, 2021
Merged
@MasonProtter
Copy link
Copy Markdown
Contributor Author

MasonProtter commented Nov 12, 2021

Superseded by #42351

@MasonProtter MasonProtter deleted the filter_mask branch October 30, 2024 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vtjnash vtjnash vtjnash approved these changes

@kshyatt kshyatt kshyatt left review comments

@rfourquet rfourquet Awaiting requested review from rfourquet

Assignees

No one assigned

Labels

arrays [a, r, r, a, y, s] iteration Involves iteration or the iteration protocol

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Inplace mask of vector

10 participants

@MasonProtter @kshyatt @vtjnash @rfourquet @musm @simeonschaub @oxinabox @oscardssmith @StefanKarpinski @bkamins