Clarify _buffer_index behavior #22
Merged
Conversation
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
findmyway
approved these changes
Mar 27, 2024
| """ | ||
| _buffer_frame(cb::CircularArrayBuffer, i::Int) | ||
| Return the index of the `i`-th frame in the buffer. |
There was a problem hiding this comment.
Suggested change
| Return the index of the `i`-th frame in the buffer. | |
| Here `i` is assumed to be the last dimension of `cb`. Each `frame` means a slice of the last dimension. Since we use *circular frames* (the `data` buffer) underlying, this function transforms the logical `i`-th frame to the real frame of the internal buffer. |
| return idx - n | ||
| else | ||
| ind | ||
| @info "oops! idx $(idx) > 2n $(2n)" |
There was a problem hiding this comment.
Suggested change
| @info "oops! idx $(idx) > 2n $(2n)" | |
| @warn "oops! idx $(idx) > 2n $(2n)" |
| """ | ||
| _buffer_index(cb::CircularArrayBuffer, i::Int) | ||
| Return the index of the `i`-th element in the buffer. |
There was a problem hiding this comment.
Suggested change
| Return the index of the `i`-th element in the buffer. | |
| Return the index of the `i`-th element in the buffer. Note the `i` is assumed to be the linear indexing of `cb`. |
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.
This pull request clarifies the behavior of the
_buffer_indexfunction in the CircularArrayBuffer module. It adds a new functionwrap_indexto handle index wrapping when it exceeds the buffer size. The changes also include updated comments.