Skip to content

Commit 6cfb2b0

Browse files
docs: add back array children docs moved from slots (#7249)
Add back docs for each array child removed in #6870 --------- Signed-off-by: Joe Isaacs <joe.isaacs@live.co.uk> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent a6cc251 commit 6cfb2b0

33 files changed

Lines changed: 110 additions & 4 deletions

File tree

encodings/alp/src/alp/array.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,9 +214,13 @@ impl VTable for ALP {
214214
}
215215
}
216216

217+
/// The ALP-encoded values array.
217218
pub(super) const ENCODED_SLOT: usize = 0;
219+
/// The indices of exception values that could not be ALP-encoded.
218220
pub(super) const PATCH_INDICES_SLOT: usize = 1;
221+
/// The exception values that could not be ALP-encoded.
219222
pub(super) const PATCH_VALUES_SLOT: usize = 2;
223+
/// Chunk offsets for the patch indices/values.
220224
pub(super) const PATCH_CHUNK_OFFSETS_SLOT: usize = 3;
221225
pub(super) const NUM_SLOTS: usize = 4;
222226
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = [

encodings/alp/src/alp_rd/array.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,10 +344,15 @@ impl VTable for ALPRD {
344344
}
345345
}
346346

347+
/// The left (most significant) parts of the real-double encoded values.
347348
pub(super) const LEFT_PARTS_SLOT: usize = 0;
349+
/// The right (least significant) parts of the real-double encoded values.
348350
pub(super) const RIGHT_PARTS_SLOT: usize = 1;
351+
/// The indices of left-parts exception values that could not be dictionary-encoded.
349352
pub(super) const LP_PATCH_INDICES_SLOT: usize = 2;
353+
/// The exception values for left-parts that could not be dictionary-encoded.
350354
pub(super) const LP_PATCH_VALUES_SLOT: usize = 3;
355+
/// Chunk offsets for the left-parts patch indices/values.
351356
pub(super) const LP_PATCH_CHUNK_OFFSETS_SLOT: usize = 4;
352357
pub(super) const NUM_SLOTS: usize = 5;
353358
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = [

encodings/bytebool/src/array.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ impl VTable for ByteBool {
193193
}
194194
}
195195

196+
/// The validity bitmap indicating which elements are non-null.
196197
pub(super) const VALIDITY_SLOT: usize = 0;
197198
pub(super) const NUM_SLOTS: usize = 1;
198199
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = ["validity"];

encodings/datetime-parts/src/array.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,11 @@ impl VTable for DateTimeParts {
237237
}
238238
}
239239

240+
/// The days component of the datetime, stored as an integer array.
240241
pub(super) const DAYS_SLOT: usize = 0;
242+
/// The seconds component of the datetime (within the day).
241243
pub(super) const SECONDS_SLOT: usize = 1;
244+
/// The sub-second component of the datetime.
242245
pub(super) const SUBSECONDS_SLOT: usize = 2;
243246
pub(super) const NUM_SLOTS: usize = 3;
244247
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = ["days", "seconds", "subseconds"];

encodings/decimal-byte-parts/src/decimal_byte_parts/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,7 @@ impl VTable for DecimalByteParts {
203203
}
204204
}
205205

206+
/// The most significant parts of the decimal values.
206207
pub(super) const MSP_SLOT: usize = 0;
207208
pub(super) const NUM_SLOTS: usize = 1;
208209
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = ["msp"];

encodings/fastlanes/src/bitpacking/array/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,13 @@ use crate::bitpack_compress::bitpack_encode;
2626
use crate::unpack_iter::BitPacked;
2727
use crate::unpack_iter::BitUnpackedChunks;
2828

29+
/// The indices of exception values that don't fit in the bit-packed representation.
2930
pub(super) const PATCH_INDICES_SLOT: usize = 0;
31+
/// The exception values that don't fit in the bit-packed representation.
3032
pub(super) const PATCH_VALUES_SLOT: usize = 1;
33+
/// Chunk offsets for the patch indices/values.
3134
pub(super) const PATCH_CHUNK_OFFSETS_SLOT: usize = 2;
35+
/// The validity bitmap indicating which elements are non-null.
3236
pub(super) const VALIDITY_SLOT: usize = 3;
3337
pub(super) const NUM_SLOTS: usize = 4;
3438
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = [

encodings/fastlanes/src/delta/array/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ use vortex_error::vortex_ensure;
1818
pub mod delta_compress;
1919
pub mod delta_decompress;
2020

21+
/// The base values for each block of deltas.
2122
pub(super) const BASES_SLOT: usize = 0;
23+
/// The delta-encoded values relative to the base values.
2224
pub(super) const DELTAS_SLOT: usize = 1;
2325
pub(super) const NUM_SLOTS: usize = 2;
2426
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = ["bases", "deltas"];

encodings/fastlanes/src/for/array/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ use vortex_error::vortex_bail;
1212
pub mod for_compress;
1313
pub mod for_decompress;
1414

15+
/// The encoded array with the frame-of-reference (minimum value) subtracted.
1516
pub(super) const ENCODED_SLOT: usize = 0;
1617
pub(super) const NUM_SLOTS: usize = 1;
1718
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = ["encoded"];

encodings/fastlanes/src/rle/array/mod.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,19 @@ use crate::FL_CHUNK_SIZE;
1515
pub mod rle_compress;
1616
pub mod rle_decompress;
1717

18+
/// Run values in the dictionary.
1819
pub(super) const VALUES_SLOT: usize = 0;
20+
/// Chunk-local indices from all chunks. The start of each chunk is looked up in `values_idx_offsets`.
1921
pub(super) const INDICES_SLOT: usize = 1;
22+
/// Index start positions of each value chunk.
23+
///
24+
/// # Example
25+
/// ```text
26+
/// // Chunk 0: [10, 20] (starts at index 0)
27+
/// // Chunk 1: [30, 40] (starts at index 2)
28+
/// let values = [10, 20, 30, 40]; // Global values array
29+
/// let values_idx_offsets = [0, 2]; // Chunk 0 starts at index 0, Chunk 1 starts at index 2
30+
/// ```
2031
pub(super) const VALUES_IDX_OFFSETS_SLOT: usize = 2;
2132
pub(super) const NUM_SLOTS: usize = 3;
2233
pub(super) const SLOT_NAMES: [&str; NUM_SLOTS] = ["values", "indices", "values_idx_offsets"];

encodings/fsst/src/array.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,11 @@ impl VTable for FSST {
346346
}
347347
}
348348

349+
/// Lengths of the original values before compression, can be compressed.
349350
pub(crate) const UNCOMPRESSED_LENGTHS_SLOT: usize = 0;
351+
/// The offsets array for the FSST-compressed codes.
350352
pub(crate) const CODES_OFFSETS_SLOT: usize = 1;
353+
/// The validity bitmap for the compressed codes.
351354
pub(crate) const CODES_VALIDITY_SLOT: usize = 2;
352355
pub(crate) const NUM_SLOTS: usize = 3;
353356
pub(crate) const SLOT_NAMES: [&str; NUM_SLOTS] =

0 commit comments

Comments
 (0)