-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Specialized GroupValues
for primitive
and large_primitive
#16136
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
e3477f1
93045f2
6ce4857
1b5cde9
8c05f69
cf053cb
8e09c83
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
// Licensed to the Apache Software Foundation (ASF) under one | ||
// or more contributor license agreements. See the NOTICE file | ||
// distributed with this work for additional information | ||
// regarding copyright ownership. The ASF licenses this file | ||
// to you under the Apache License, Version 2.0 (the | ||
// "License"); you may not use this file except in compliance | ||
// with the License. You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, | ||
// software distributed under the License is distributed on an | ||
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
// KIND, either express or implied. See the License for the | ||
// specific language governing permissions and limitations | ||
// under the License. | ||
|
||
use crate::aggregates::group_values::single_group_by::primitive::{ | ||
emit_internal, HashValue, | ||
}; | ||
use crate::aggregates::group_values::GroupValues; | ||
use ahash::RandomState; | ||
use arrow::array::{ | ||
cast::AsArray, ArrayRef, ArrowNativeTypeOp, ArrowPrimitiveType, PrimitiveArray, | ||
}; | ||
use arrow::datatypes::DataType; | ||
use arrow::record_batch::RecordBatch; | ||
use datafusion_common::Result; | ||
use datafusion_execution::memory_pool::proxy::VecAllocExt; | ||
use datafusion_expr::EmitTo; | ||
use hashbrown::hash_table::HashTable; | ||
use std::mem::size_of; | ||
|
||
/// A [`GroupValues`] storing a single column of large primitive values (bits > 64) | ||
/// | ||
/// This specialization is significantly faster than using the more general | ||
/// purpose `Row`s format | ||
pub struct GroupValuesLargePrimitive<T: ArrowPrimitiveType> { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why use large primitive? Is 128 bits slower otherwise? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
🤔 I currently decide which type to use Because the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hm I think the storage of a value inside There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I think for the
But I am indeed not sure, for the large primitive, if doing this can get benefit, because storing them inline Also comparing them directly is more expansive than comparing their hashes... |
||
/// The data type of the output array | ||
data_type: DataType, | ||
/// Stores the `(group_index, hash)` based on the hash of its value | ||
/// | ||
/// We also store `hash` is for reducing cost of rehashing. Such cost | ||
/// is obvious in high cardinality group by situation. | ||
/// More details can see: | ||
/// <https://github.com/apache/datafusion/issues/15961> | ||
/// | ||
map: HashTable<(usize, u64)>, | ||
/// The group index of the null value if any | ||
null_group: Option<usize>, | ||
/// The values for each group index | ||
values: Vec<T::Native>, | ||
/// The random state used to generate hashes | ||
random_state: RandomState, | ||
} | ||
|
||
impl<T: ArrowPrimitiveType> GroupValuesLargePrimitive<T> { | ||
pub fn new(data_type: DataType) -> Self { | ||
assert!(PrimitiveArray::<T>::is_compatible(&data_type)); | ||
Self { | ||
data_type, | ||
map: HashTable::with_capacity(128), | ||
values: Vec::with_capacity(128), | ||
null_group: None, | ||
random_state: Default::default(), | ||
} | ||
} | ||
} | ||
|
||
impl<T: ArrowPrimitiveType> GroupValues for GroupValuesLargePrimitive<T> | ||
where | ||
T::Native: HashValue, | ||
{ | ||
fn intern(&mut self, cols: &[ArrayRef], groups: &mut Vec<usize>) -> Result<()> { | ||
assert_eq!(cols.len(), 1); | ||
groups.clear(); | ||
|
||
for v in cols[0].as_primitive::<T>() { | ||
let group_id = match v { | ||
None => *self.null_group.get_or_insert_with(|| { | ||
let group_id = self.values.len(); | ||
self.values.push(Default::default()); | ||
group_id | ||
}), | ||
Some(key) => { | ||
let state = &self.random_state; | ||
let hash = key.hash(state); | ||
let insert = self.map.entry( | ||
hash, | ||
|&(g, _)| unsafe { self.values.get_unchecked(g).is_eq(key) }, | ||
|&(_, h)| h, | ||
); | ||
|
||
match insert { | ||
hashbrown::hash_table::Entry::Occupied(o) => o.get().0, | ||
hashbrown::hash_table::Entry::Vacant(v) => { | ||
let g = self.values.len(); | ||
v.insert((g, hash)); | ||
self.values.push(key); | ||
g | ||
} | ||
} | ||
} | ||
}; | ||
groups.push(group_id) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It can |
||
} | ||
Ok(()) | ||
} | ||
|
||
fn size(&self) -> usize { | ||
self.map.capacity() * size_of::<(usize, u64)>() + self.values.allocated_size() | ||
} | ||
|
||
fn is_empty(&self) -> bool { | ||
self.values.is_empty() | ||
} | ||
|
||
fn len(&self) -> usize { | ||
self.values.len() | ||
} | ||
|
||
fn emit(&mut self, emit_to: EmitTo) -> Result<Vec<ArrayRef>> { | ||
emit_internal::<T, u64>( | ||
emit_to, | ||
&mut self.values, | ||
&mut self.null_group, | ||
&mut self.map, | ||
self.data_type.clone(), | ||
) | ||
} | ||
|
||
fn clear_shrink(&mut self, batch: &RecordBatch) { | ||
let count = batch.num_rows(); | ||
self.values.clear(); | ||
self.values.shrink_to(count); | ||
self.map.clear(); | ||
self.map.shrink_to(count, |_| 0); // hasher does not matter since the map is cleared | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would help me a lot if you could document the rationale behind this change and why it is different than
GroupValuesPrimitive
Or something like that