forked from apache/datafusion
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Convert CumeDist to UDWF (apache#13051)
* Transferred cumedist * fixes * remove expr tests * small fix * small fix * check * clippy fix * roundtrip fix
- Loading branch information
1 parent
521966a
commit a4e6b07
Showing
18 changed files
with
195 additions
and
199 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| // 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. | ||
|
|
||
| //! `cume_dist` window function implementation | ||
|
|
||
| use datafusion_common::arrow::array::{ArrayRef, Float64Array}; | ||
| use datafusion_common::arrow::datatypes::DataType; | ||
| use datafusion_common::arrow::datatypes::Field; | ||
| use datafusion_common::Result; | ||
| use datafusion_expr::window_doc_sections::DOC_SECTION_RANKING; | ||
| use datafusion_expr::{ | ||
| Documentation, PartitionEvaluator, Signature, Volatility, WindowUDFImpl, | ||
| }; | ||
| use datafusion_functions_window_common::field; | ||
| use datafusion_functions_window_common::partition::PartitionEvaluatorArgs; | ||
| use field::WindowUDFFieldArgs; | ||
| use std::any::Any; | ||
| use std::fmt::Debug; | ||
| use std::iter; | ||
| use std::ops::Range; | ||
| use std::sync::{Arc, OnceLock}; | ||
|
|
||
| define_udwf_and_expr!( | ||
| CumeDist, | ||
| cume_dist, | ||
| "Calculates the cumulative distribution of a value in a group of values." | ||
| ); | ||
|
|
||
| /// CumeDist calculates the cume_dist in the window function with order by | ||
| #[derive(Debug)] | ||
| pub struct CumeDist { | ||
| signature: Signature, | ||
| } | ||
|
|
||
| impl CumeDist { | ||
| pub fn new() -> Self { | ||
| Self { | ||
| signature: Signature::any(0, Volatility::Immutable), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl Default for CumeDist { | ||
| fn default() -> Self { | ||
| Self::new() | ||
| } | ||
| } | ||
|
|
||
| impl WindowUDFImpl for CumeDist { | ||
| /// Return a reference to Any that can be used for downcasting | ||
| fn as_any(&self) -> &dyn Any { | ||
| self | ||
| } | ||
|
|
||
| fn name(&self) -> &str { | ||
| "cume_dist" | ||
| } | ||
|
|
||
| fn signature(&self) -> &Signature { | ||
| &self.signature | ||
| } | ||
|
|
||
| fn partition_evaluator( | ||
| &self, | ||
| _partition_evaluator_args: PartitionEvaluatorArgs, | ||
| ) -> Result<Box<dyn PartitionEvaluator>> { | ||
| Ok(Box::<CumeDistEvaluator>::default()) | ||
| } | ||
|
|
||
| fn field(&self, field_args: WindowUDFFieldArgs) -> Result<Field> { | ||
| Ok(Field::new(field_args.name(), DataType::Float64, false)) | ||
| } | ||
|
|
||
| fn documentation(&self) -> Option<&Documentation> { | ||
| Some(get_cume_dist_doc()) | ||
| } | ||
| } | ||
|
|
||
| static DOCUMENTATION: OnceLock<Documentation> = OnceLock::new(); | ||
|
|
||
| fn get_cume_dist_doc() -> &'static Documentation { | ||
| DOCUMENTATION.get_or_init(|| { | ||
| Documentation::builder() | ||
| .with_doc_section(DOC_SECTION_RANKING) | ||
| .with_description( | ||
| "Relative rank of the current row: (number of rows preceding or peer with current row) / (total rows).", | ||
| ) | ||
| .with_syntax_example("cume_dist()") | ||
| .build() | ||
| .unwrap() | ||
| }) | ||
| } | ||
|
|
||
| #[derive(Debug, Default)] | ||
| pub(crate) struct CumeDistEvaluator; | ||
|
|
||
| impl PartitionEvaluator for CumeDistEvaluator { | ||
| /// Computes the cumulative distribution for all rows in the partition | ||
| fn evaluate_all_with_rank( | ||
| &self, | ||
| num_rows: usize, | ||
| ranks_in_partition: &[Range<usize>], | ||
| ) -> Result<ArrayRef> { | ||
| let scalar = num_rows as f64; | ||
| let result = Float64Array::from_iter_values( | ||
| ranks_in_partition | ||
| .iter() | ||
| .scan(0_u64, |acc, range| { | ||
| let len = range.end - range.start; | ||
| *acc += len as u64; | ||
| let value: f64 = (*acc as f64) / scalar; | ||
| let result = iter::repeat(value).take(len); | ||
| Some(result) | ||
| }) | ||
| .flatten(), | ||
| ); | ||
| Ok(Arc::new(result)) | ||
| } | ||
|
|
||
| fn include_rank(&self) -> bool { | ||
| true | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
| use datafusion_common::cast::as_float64_array; | ||
|
|
||
| fn test_f64_result( | ||
| num_rows: usize, | ||
| ranks: Vec<Range<usize>>, | ||
| expected: Vec<f64>, | ||
| ) -> Result<()> { | ||
| let evaluator = CumeDistEvaluator; | ||
| let result = evaluator.evaluate_all_with_rank(num_rows, &ranks)?; | ||
| let result = as_float64_array(&result)?; | ||
| let result = result.values().to_vec(); | ||
| assert_eq!(expected, result); | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[test] | ||
| #[allow(clippy::single_range_in_vec_init)] | ||
| fn test_cume_dist() -> Result<()> { | ||
| test_f64_result(0, vec![], vec![])?; | ||
|
|
||
| test_f64_result(1, vec![0..1], vec![1.0])?; | ||
|
|
||
| test_f64_result(2, vec![0..2], vec![1.0, 1.0])?; | ||
|
|
||
| test_f64_result(4, vec![0..2, 2..4], vec![0.5, 0.5, 1.0, 1.0])?; | ||
|
|
||
| Ok(()) | ||
| } | ||
| } |
This file contains 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
This file contains 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
Oops, something went wrong.