datafusion_extra_functions/common/mode.rs
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18mod bytes;
19mod native;
20
21pub use bytes::BytesModeAccumulator;
22pub use native::FloatModeAccumulator;
23pub use native::PrimitiveModeAccumulator;
24
25use datafusion::{arrow, common, error};
26
27/// Unwraps the two list-typed state columns (`values`, `frequencies`) row by
28/// row and passes each row's inner arrays to `f`.
29pub(crate) fn for_each_state_row(
30 states: &[arrow::array::ArrayRef],
31 mut f: impl FnMut(&arrow::array::ArrayRef, &arrow::array::Int64Array) -> error::Result<()>,
32) -> error::Result<()> {
33 if states.is_empty() {
34 return Ok(());
35 }
36
37 let values = common::cast::as_list_array(&states[0])?;
38 let counts = common::cast::as_list_array(&states[1])?;
39
40 for (values, counts) in values.iter().zip(counts.iter()) {
41 if let (Some(values), Some(counts)) = (values, counts) {
42 let counts = common::cast::as_primitive_array::<arrow::datatypes::Int64Type>(&counts)?;
43 f(&values, counts)?;
44 }
45 }
46
47 Ok(())
48}