Rename squeeze -> dropdims #28303
Rename squeeze -> dropdims #28303
Conversation
| 2×2×1 Array{Int64,3}: | ||
| [:, :, 1] = | ||
| 1 3 | ||
| 2 4 | ||
| ``` | ||
| """ | ||
| squeeze(A; dims) = _squeeze(A, dims) | ||
| function _squeeze(A::AbstractArray, dims::Dims) | ||
| dropdims(A; dims) = _dropdims(A, dims) |
There was a problem hiding this comment.
Not strictly related to this PR, but what's the value of having dims be a keyword argument for a simple two arg function? I know they are fast now, but here it doesn't seem needed. The rename makes this a bit more jarring, since we now have dropdims(A,dims=1) which is redundant.
I believe there are other functions where I've noticed this, though can't remember which exactly. I can open an issue if we want.
There was a problem hiding this comment.
It's just for consistency --- all functions that accept a list of dimensions accept them with a dims keyword argument, so it's easier to guess or remember how to call it.
There was a problem hiding this comment.
This was done for consistency. All functions that operate on dimensions now take those as a keyword argument.
There was a problem hiding this comment.
Yes I see now they were all changed. I'm not a huge fan, but I suppose that ship has sailed.
ararslan
added
arrays
This reverts commit cb6f5e2.
`squeeze` was renamed `dropdims` in [#28303](JuliaLang/julia#28303) Fixes JuliaLang#617
`squeeze` was renamed `dropdims` in [#28303](JuliaLang/julia#28303) Fixes JuliaLang#617
`squeeze` was renamed `dropdims` in [#28303](JuliaLang/julia#28303) Fixes JuliaLang#617
* squeeze is now dropdims `squeeze` was renamed `dropdims` in [#28303](JuliaLang/julia#28303) Fixes #617 * Support dropdims for dev versions where squeeze had KW arg Also, remove README information about squeeze support, since dropdims is the preferred replacement. * Export dropdims
And one more of the items discussed on triage.
squeezeis an awkward, non-descriptive function. We can do better. Going by the principle of looking at how the docstring describes it, suggestsrmdimsordropdims. Of thesedropdimsseems clearest. Rename it.