Skip to content

Docs: document chunk_offsets in Patches #5429

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

Merged
connortsui20 merged 3 commits into from
Nov 20, 2025
Merged

Docs: document chunk_offsets in Patches #5429

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e7c6fba
document chunk_offsets in patches
connortsui20 Nov 20, 2025
2757537
Update vortex-array/src/patches.rs
connortsui20 Nov 20, 2025
84a5b8b
Merge branch 'develop' into ct/alp-chunk-offsets-docs
connortsui20 Nov 20, 2025
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
7 changes: 6 additions & 1 deletion vortex-array/src/patches.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,19 @@ pub struct Patches {
indices: ArrayRef,
values: ArrayRef,
/// Stores the patch index offset for each chunk.
///
/// This allows us to lookup the patches for a given chunk in constant time via
/// `patch_indices[chunk_offsets[i]..chunk_offsets[i+1]]`.
///
/// This is optional for backcompatability reasons.
chunk_offsets: Option<ArrayRef>,
/// Chunk offsets are only sliced off in case the slice is fully
/// outside of the chunk range.
///
/// Though the range for indices and values is sliced in terms of
/// individual elements, not chunks. To account for that we do a
/// saturating sub when adjusting the indices based on the chunk offset.
//
///
/// `offset_within_chunk` is necessary in order to keep track of how many
/// elements were sliced off within the chunk.
offset_within_chunk: Option<usize>,
Expand Down
Loading