Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve sizehint! docstring about shrink arg #52226

Merged
merged 6 commits into from
Dec 11, 2023
Merged

Improve sizehint! docstring about shrink arg #52226

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4d5a34b
Improve `sizehint!` docstring about `shrink` arg
nalimilan Nov 18, 2023
7ad6cbd
Review fixes
nalimilan Nov 21, 2023
11fcb4c
Fix typo
nalimilan Nov 21, 2023
aff1a0b
Apply suggestions from code review
nalimilan Dec 10, 2023
343f51a
Break line
nalimilan Dec 10, 2023
a9c1b5f
Remove duplicate lines
nalimilan Dec 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions base/array.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1434,7 +1434,7 @@ end
"""
sizehint!(s, n; first::Bool=false, shrink::Bool=true) -> s

Suggest that collection `s` reserve capacity for at least `n` elements. That is, if
nalimilan marked this conversation as resolved.
Show resolved Hide resolved
Suggest that collection `s` reserve capacity for `n` elements. That is, if
you expect that you're going to have to push a lot of values onto `s`, you can avoid
the cost of incremental reallocation by doing it once up front; this can improve
performance.
Expand All @@ -1443,6 +1443,10 @@ If `first` is true, then the reserved space is from the start of the collection,
collections. Supplying this keyword may result in an error if the collection is nor ordered
nalimilan marked this conversation as resolved.
Show resolved Hide resolved
or if `pushfirst!` is not supported for this collection.

If `shrink` is `true` (the default), the reserved space may be reduced if it is
nalimilan marked this conversation as resolved.
Show resolved Hide resolved
larger than `n`. Passing `shrink=false` will ensure that the existing space is preserved
even if it is larger than requested.

See also [`resize!`](@ref).

# Notes on the performance model
Expand All @@ -1458,8 +1462,6 @@ For types that support `sizehint!`,

3. `empty!` is nearly costless (and O(1)) for types that support this kind of preallocation.

4. `shrink` controls if the collection can be shrunk.

!!! compat "Julia 1.11"
The `shrink` and `first` arguments were added in Julia 1.11.
"""
Expand Down