Skip to content

Commit 2ac1bd9

Browse files
committed
Update doc
Signed-off-by: Adam Gutglick <adam@spiraldb.com>
1 parent 6e58481 commit 2ac1bd9

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

  • vortex-array/src/aggregate_fn/fns/uncompressed_size_in_bytes

vortex-array/src/aggregate_fn/fns/uncompressed_size_in_bytes/mod.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,12 @@ fn uncompressed_size_in_bytes_u64(array: &ArrayRef, ctx: &mut ExecutionCtx) -> V
8383
Ok(size)
8484
}
8585

86-
/// Sum the canonical, recursively uncompressed buffer sizes for an array.
86+
/// Sum the canonical, recursively **uncompressed** data size for an array.
8787
///
8888
/// Applies to all types and returns a non-null `u64`. Encoding kernels can return this aggregate
8989
/// directly from metadata to avoid decoding arrays whose uncompressed size is known.
90+
///
91+
/// This is generally useful for various execution engines to pick better join orderings.
9092
#[derive(Clone, Debug)]
9193
pub struct UncompressedSizeInBytes;
9294

@@ -102,8 +104,8 @@ impl AggregateFnVTable for UncompressedSizeInBytes {
102104
unimplemented!("UncompressedSizeInBytes is not yet serializable");
103105
}
104106

105-
fn return_dtype(&self, _options: &Self::Options, _input_dtype: &DType) -> Option<DType> {
106-
supports_uncompressed_size_in_bytes(_input_dtype)
107+
fn return_dtype(&self, _options: &Self::Options, input_dtype: &DType) -> Option<DType> {
108+
supports_uncompressed_size_in_bytes(input_dtype)
107109
.then_some(DType::Primitive(PType::U64, NonNullable))
108110
}
109111

0 commit comments

Comments
 (0)