fix: grow memory when necessary in BaseVec::set.#222
Merged
Conversation
## Problem `BaseVec`, which is the underlying data structure used by `StableVec` and `StableMinHeap` provides a `set` method that allows the caller to change the value of an element at a specified index. The `set` method used the `memory.write` method, which assumed that there is always enough memory to rewrite the element. This assumption would've been fine if other methods like `push` always allocated the maximum amount of space for every element. Currently though, `push` only allocates the amount needed to store the element that's being pushed. ## Solution There are two possible solutions: 1) Modify `push` to always allocate the maximum size of an element. 2) Modify `set` to grow the memory as needed as it's rewriting an element. This commit implements solution #2, which was both simpler and more performant.
ielashi
commented
Jun 7, 2024
|
dsarlis
approved these changes
Jun 7, 2024
This file contains hidden or 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
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.
Problem
BaseVec, which is the underlying data structure used byStableVecandStableMinHeapprovides asetmethod that allows the caller to change the value of an element at a specified index.The
setmethod used thememory.writemethod, which assumed that there is always enough memory to rewrite the element. This assumption would've been fine if other methods likepushalways allocated the maximum amount of space for every element. Currently though,pushonly allocates the amount needed to store the element that's being pushed.Solution
There are two possible solutions:
pushto always allocate the maximum size of an element.setto grow the memory as needed as it's rewriting an element.This commit implements solution 2, which is both simpler and more performant.