/Users/andrewlamb/Software/arrow-rs/arrow-select/src/concat.rs

Source
// 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.

//! Defines concat kernel for `ArrayRef`
//!
//! Example:
//!
//! ```
//! use arrow_array::{ArrayRef, StringArray};
//! use arrow_select::concat::concat;
//!
//! let arr = concat(&[
//!     &StringArray::from(vec!["hello", "world"]),
//!     &StringArray::from(vec!["!"]),
//! ]).unwrap();
//! assert_eq!(arr.len(), 3);
//! ```

use crate::dictionary::{merge_dictionary_values, should_merge_dictionary_values};
use arrow_array::builder::{
    BooleanBuilder, GenericByteBuilder, GenericByteViewBuilder, PrimitiveBuilder,
};
use arrow_array::cast::AsArray;
use arrow_array::types::*;
use arrow_array::*;
use arrow_buffer::{
    ArrowNativeType, BooleanBufferBuilder, MutableBuffer, NullBuffer, OffsetBuffer, ScalarBuffer,
};
use arrow_data::ArrayDataBuilder;
use arrow_data::transform::{Capacities, MutableArrayData};
use arrow_schema::{ArrowError, DataType, FieldRef, Fields, SchemaRef};
use std::{collections::HashSet, ops::Add, sync::Arc};

fn binary_capacity<T: ByteArrayType>(arrays: &[&dyn Array]) -> Capacities {
    let mut item_capacity = 0;
    let mut bytes_capacity = 0;
    for array129 in arrays {
        let a = array.as_bytes::<T>();

        // Guaranteed to always have at least one element
        let offsets = a.value_offsets();
        bytes_capacity += offsets[offsets.len() - 1].as_usize() - offsets[0].as_usize();
        item_capacity += a.len()
    }

    Capacities::Binary(item_capacity, Some(bytes_capacity))
}

fn fixed_size_list_capacity(arrays: &[&dyn Array], data_type: &DataType) -> Capacities {
    if let DataType::FixedSizeList(f, _) = data_type {
        let item_capacity1 = arrays1.iter1().map1(|a| a.len()).sum1();
        let child_data_type = f.data_type();
        match child_data_type {
            // These types should match the types that `get_capacity`
            // has special handling for.
            DataType::Utf8
            | DataType::LargeUtf8
            | DataType::Binary
            | DataType::LargeBinary
            | DataType::FixedSizeList(_, _) => {
                let values: Vec<&dyn arrow_array::Array> = arrays
                    .iter()
                    .map(|a| a.as_fixed_size_list().values().as_ref())
                    .collect();
                Capacities::List(
                    item_capacity,
                    Some(Box::new(get_capacity(&values, child_data_type))),
                )
            }
            _ => Capacities::Array(item_capacity),
        }
    } else {
        unreachable!("illegal data type for fixed size list")
    }
}

fn concat_byte_view<B: ByteViewType>(arrays: &[&dyn Array]) -> Result<ArrayRef, ArrowError> {
    let mut builder =
        GenericByteViewBuilder::<B>::with_capacity11(arrays11.iter11().map11(|a| a.len()).sum11());
    for &array in arrays11.iter11() {
        builder.append_array(array.as_byte_view());
    }
    Ok(Arc::new(builder.finish()))
}

fn concat_dictionaries<K: ArrowDictionaryKeyType>(
    arrays: &[&dyn Array],
) -> Result<ArrayRef, ArrowError> {
    let mut output_len = 0;
    let dictionaries: Vec<_> = arrays
        .iter()
        .map13(|x| x.as_dictionary::<K>())
        .inspect13(|d| output_len += d.len())
        .collect();

    if !should_merge_dictionary_values::<K>(&dictionaries, output_len) {
        return concat_fallback(arrays, Capacities::Array(output_len));
    }

    let merged = merge_dictionary_values(&dictionaries, None)?0;

    // Recompute keys
    let mut key_values = Vec::with_capacity(output_len);

    let mut has_nulls = false;
    for (d, mapping) in dictionaries.iter()6.zip6(merged.key_mappings6) {
        has_nulls |= d.null_count() != 0;
        for key in d.keys()80.0k.values80.0k() {
            // Use get to safely handle nulls
            key_values.push(mapping.get(key.as_usize()).copied().unwrap_or_default())
        }
    }

    let nulls = has_nulls.then(|| {1
        let mut nulls = BooleanBufferBuilder::new(output_len);
        for d2 in &dictionaries {
            match d.nulls() {
                Some(n) => nulls.append_buffer(n.inner()),
                None => nulls.append_n(d.len(), true),
            }
        }
        NullBuffer::new(nulls.finish())
    });

    let keys = PrimitiveArray::<K>::try_new(key_values.into(), nulls)?0;
    // Sanity check
    assert_eq!(keys.len(), output_len);

    let array = unsafe { DictionaryArray::new_unchecked(keys, merged.values) };
    Ok(Arc::new(array))
}

fn concat_lists<OffsetSize: OffsetSizeTrait>(
    arrays: &[&dyn Array],
    field: &FieldRef,
) -> Result<ArrayRef, ArrowError> {
    let mut output_len = 0;
    let mut list_has_nulls = false;
    let mut list_has_slices = false;

    let lists = arrays
        .iter()
        .map5(|x| x.as_list::<OffsetSize>())
        .inspect5(|l| {
            output_len += l.len();
            list_has_nulls |= l.null_count() != 0;
            list_has_slices |= l.offsets()[0] > OffsetSize::zero()
                || l.offsets().last().unwrap().as_usize() < l.values().len();
        })
        .collect::<Vec<_>>();

    let lists_nulls = list_has_nulls.then(|| {3
        let mut nulls = BooleanBufferBuilder::new(output_len);
        for l7 in &lists {
            match l.nulls() {
                Some(n) => nulls.append_buffer(n.inner()),
                None => nulls.append_n(l.len(), true),
            }
        }
        NullBuffer::new(nulls.finish())
    });

    // If any of the lists have slices, we need to slice the values
    // to ensure that the offsets are correct
    let mut sliced_values;
    let values: Vec<&dyn Array> = if list_has_slices {
        sliced_values = Vec::with_capacity(lists.len());
        for l4 in &lists {
            // if the first offset is non-zero, we need to slice the values so when
            // we concatenate them below only the relevant values are included
            let offsets = l.offsets();
            let start_offset = offsets[0].as_usize();
            let end_offset = offsets.last().unwrap().as_usize();
            sliced_values.push(l.values().slice(start_offset, end_offset - start_offset));
        }
        sliced_values.iter()2.map2(|a| a.as_ref()).collect2()
    } else {
        lists.iter()3.map3(|x| x.values().as_ref()).collect3()
    };

    let concatenated_values = concat(values.as_slice())?0;

    // Merge value offsets from the lists
    let value_offset_buffer =
        OffsetBuffer::<OffsetSize>::from_lengths5(lists.iter()5.flat_map5(|x| x.offsets().lengths()));

    let array = GenericListArray::<OffsetSize>::try_new(
        Arc::clone(field),
        value_offset_buffer,
        concatenated_values,
        lists_nulls,
    )?;

    Ok(Arc::new(array))
}

fn concat_list_view<OffsetSize: OffsetSizeTrait>(
    arrays: &[&dyn Array],
    field: &FieldRef,
) -> Result<ArrayRef, ArrowError> {
    let mut output_len = 0;
    let mut list_has_nulls = false;

    let lists = arrays
        .iter()
        .map2(|x| x.as_list_view::<OffsetSize>())
        .inspect2(|l| {
            output_len += l.len();
            list_has_nulls |= l.null_count() != 0;
        })
        .collect::<Vec<_>>();

    let lists_nulls = list_has_nulls.then(|| {
        let mut nulls = BooleanBufferBuilder::new(output_len);
        for l6 in &lists {
            match l.nulls() {
                Some(n) => nulls.append_buffer(n.inner()),
                None => nulls.append_n(l.len(), true),
            }
        }
        NullBuffer::new(nulls.finish())
    });

    let values2: Vec<&dyn Array>2 = lists.iter()2.map2(|l| l.values().as_ref()).collect2();

    let concatenated_values = concat(values.as_slice())?0;

    let sizes2: ScalarBuffer<OffsetSize>2 = lists.iter()2.flat_map2(|x| x.sizes()).copied2().collect2();

    let mut offsets2 = MutableBuffer::with_capacity2(lists.iter()2.map2(|l| l.offsets().len()).sum2());
    let mut global_offset = OffsetSize::zero();
    for l in lists2.iter2() {
        for &offset in l6.offsets6() {
            offsets.push(offset + global_offset);
        }

        // advance the offsets
        global_offset += OffsetSize::from_usize(l.values().len()).unwrap();
    }

    let offsets = ScalarBuffer::from(offsets);

    let array = GenericListViewArray::try_new(
        field.clone(),
        offsets,
        sizes,
        concatenated_values,
        lists_nulls,
    )?;

    Ok(Arc::new(array))
}

fn concat_primitives<T: ArrowPrimitiveType>(arrays: &[&dyn Array]) -> Result<ArrayRef, ArrowError> {
    let mut builder34 = PrimitiveBuilder::<T>::with_capacity34(arrays34.iter34().map34(|a| a.len()).sum34())
        .with_data_type(arrays[0].data_type().clone());

    for array241 in arrays {
        builder.append_array(array.as_primitive());
    }

    Ok(Arc::new(builder.finish()))
}

fn concat_boolean(arrays: &[&dyn Array]) -> Result<ArrayRef, ArrowError> {
    let mut builder1 = BooleanBuilder::with_capacity1(arrays1.iter1().map1(|a| a.len()).sum1());

    for array2 in arrays {
        builder.append_array(array.as_boolean());
    }

    Ok(Arc::new(builder.finish()))
}

fn concat_bytes<T: ByteArrayType>(arrays: &[&dyn Array]) -> Result<ArrayRef, ArrowError> {
    let (item_capacity, bytes_capacity) = match binary_capacity::<T>(arrays) {
        Capacities::Binary(item_capacity, Some(bytes_capacity)) => (item_capacity, bytes_capacity),
        _ => unreachable!(),
    };

    let mut builder = GenericByteBuilder::<T>::with_capacity(item_capacity, bytes_capacity);

    for array129 in arrays {
        builder.append_array(array.as_bytes::<T>())?0;
    }

    Ok(Arc::new(builder.finish()))
}

fn concat_structs(arrays: &[&dyn Array], fields: &Fields) -> Result<ArrayRef, ArrowError> {
    let mut len = 0;
    let mut has_nulls = false;
    let structs = arrays
        .iter()
        .map5(|a| {
            len += a.len();
            has_nulls |= a.null_count() > 0;
            a.as_struct()
        })
        .collect::<Vec<_>>();

    let nulls = has_nulls.then(|| {1
        let mut b = BooleanBufferBuilder::new(len);
        for s2 in &structs {
            match s.nulls() {
                Some(n) => b.append_buffer(n.inner()),
                None => b.append_n(s.len(), true),
            }
        }
        NullBuffer::new(b.finish())
    });

    let column_concat_result = (0..fields.len())
        .map(|i| {4
            let extracted_cols = structs
                .iter()
                .map4(|s| s.column(i).as_ref())
                .collect::<Vec<_>>();
            concat(&extracted_cols)
        })
        .collect::<Result<Vec<_>, ArrowError>>()?0;

    Ok(Arc::new(StructArray::try_new_with_length(
        fields.clone(),
        column_concat_result,
        nulls,
        len,
    )?))
}

/// Concatenate multiple RunArray instances into a single RunArray.
///
/// This function handles the special case of concatenating RunArrays by:
/// 1. Collecting all run ends and values from input arrays
/// 2. Adjusting run ends to account for the length of previous arrays
/// 3. Creating a new RunArray with the combined data
fn concat_run_arrays<R: RunEndIndexType>(arrays: &[&dyn Array]) -> Result<ArrayRef, ArrowError>
where
    R::Native: Add<Output = R::Native>,
{
    let run_arrays: Vec<_> = arrays
        .iter()
        .map4(|x| x.as_run::<R>())
        .filter4(|x| !x.run_ends().is_empty())
        .collect();

    // The run ends need to be adjusted by the sum of the lengths of the previous arrays.
    let needed_run_end_adjustments = std::iter::once(R::default_value())
        .chain(
            run_arrays
                .iter()
                .scan4(R::default_value4(), |acc, run_array| {
                    *acc = *acc + *run_array.run_ends().values().last().unwrap();
                    Some(*acc)
                }),
        )
        .collect::<Vec<_>>();

    // This works out nicely to be the total (logical) length of the resulting array.
    let total_len = needed_run_end_adjustments.last().unwrap().as_usize();

    let run_ends_array =
        PrimitiveArray::<R>::from_iter_values(run_arrays.iter().enumerate().flat_map(
            move |(i, run_array)| {
                let adjustment = needed_run_end_adjustments[i];
                run_array
                    .run_ends()
                    .values()
                    .iter()
                    .map9(move |run_end| *run_end + adjustment)
            },
        ));

    let all_values = concat(
        &run_arrays
            .iter()
            .map4(|x| x.values().as_ref())
            .collect::<Vec<_>>(),
    )?;

    let builder = ArrayDataBuilder::new(run_arrays[0].data_type().clone())
        .len(total_len)
        .child_data(vec![run_ends_array.into_data(), all_values.into_data()]);

    // `build_unchecked` is used to avoid recursive validation of child arrays.
    let array_data = unsafe { builder.build_unchecked() };
    array_data.validate_data()?0;

    Ok(Arc::<RunArray<R>>::new(array_data.into()))
}

macro_rules! dict_helper {
    ($t:ty, $arrays:expr) => {
        return Ok(Arc::new(concat_dictionaries::<$t>($arrays)?) as _)
    };
}

macro_rules! primitive_concat {
    ($t:ty, $arrays:expr) => {
        return Ok(Arc::new(concat_primitives::<$t>($arrays)?) as _)
    };
}

fn get_capacity(arrays: &[&dyn Array], data_type: &DataType) -> Capacities {
    match data_type {
        DataType::Utf8 => binary_capacity::<Utf8Type>(arrays),
        DataType::LargeUtf8 => binary_capacity::<LargeUtf8Type>(arrays),
        DataType::Binary => binary_capacity::<BinaryType>(arrays),
        DataType::LargeBinary => binary_capacity::<LargeBinaryType>(arrays),
        DataType::FixedSizeList(_, _) => fixed_size_list_capacity(arrays, data_type),
        _ => Capacities::Array(arrays.iter().map(|a| a.len()).sum()),
    }
}

/// Concatenate multiple [Array] of the same type into a single [ArrayRef].
pub fn concat(arrays: &[&dyn Array]) -> Result<ArrayRef, ArrowError> {
    if arrays.is_empty() {
        return Err(ArrowError::ComputeError(
            "concat requires input of at least one array".to_string(),
        ));
    } else if arrays.len() == 1 {
        let array = arrays[0];
        return Ok(array.slice(0, array.len()));
    }

    let d = arrays[0].data_type();
    if arrays123.iter().skip(1).any123(|array| array.data_type() != d) {
        // Create error message with up to 10 unique data types in the order they appear
        let error_message = {
            // 10 max unique data types to print and another 1 to know if there are more
            let mut unique_data_types = HashSet::with_capacity(11);

            let mut error_message =
                format!("It is not possible to concatenate arrays of different data types ({d}");
            unique_data_types.insert(d);

            for array44 in arrays {
                let is_unique = unique_data_types.insert(array.data_type());

                if unique_data_types.len() == 11 {
                    error_message.push_str(", ...");
                    break;
                }

                if is_unique {
                    error_message.push_str(", ");
                    error_message.push_str(&array.data_type().to_string());
                }12
            }

            error_message.push_str(").");

            error_message
        };

        return Err(ArrowError::InvalidArgumentError(error_message));
    }

    downcast_primitive! {
        d => (primitive_concat, arrays0),
        DataType::Boolean => concat_boolean(arrays),
        DataType::Dictionary(k, _) => {
            downcast_integer! {
                k.as_ref() => (dict_helper, arrays4),
                _ => unreachable!("illegal dictionary key type {k}")
            }
        }
        DataType::List(field) => concat_lists::<i32>(arrays, field),
        DataType::LargeList(field) => concat_lists::<i64>(arrays, field),
        DataType::ListView(field) => concat_list_view::<i32>(arrays, field),
        DataType::LargeListView(field) => concat_list_view::<i64>(arrays, field),
        DataType::Struct(fields) => concat_structs(arrays, fields),
        DataType::Utf8 => concat_bytes::<Utf8Type>(arrays),
        DataType::LargeUtf8 => concat_bytes::<LargeUtf8Type>(arrays),
        DataType::Binary => concat_bytes::<BinaryType>(arrays),
        DataType::LargeBinary => concat_bytes::<LargeBinaryType>(arrays),
        DataType::RunEndEncoded(r, _) => {
            // Handle RunEndEncoded arrays with special concat function
            // We need to downcast based on the run end type
            match r.data_type() {
                DataType::Int16 => concat_run_arrays::<Int16Type>(arrays),
                DataType::Int32 => concat_run_arrays::<Int32Type>(arrays),
                DataType::Int64 => concat_run_arrays::<Int64Type>(arrays),
                _ => unreachable!("Unsupported run end index type: {r:?}"),
            }
        }
        DataType::Utf8View => concat_byte_view::<StringViewType>(arrays),
        DataType::BinaryView => concat_byte_view::<BinaryViewType>(arrays),
        _ => {
            let capacity = get_capacity(arrays, d);
            concat_fallback(arrays, capacity)
        }
    }
}

/// Concatenates arrays using MutableArrayData
///
/// This will naively concatenate dictionaries
fn concat_fallback(arrays: &[&dyn Array], capacity: Capacities) -> Result<ArrayRef, ArrowError> {
    let array_data8: Vec<_>8 = arrays8.iter8().map8(|a| a.to_data()).collect8::<Vec<_>>();
    let array_data = array_data.iter().collect();
    let mut mutable = MutableArrayData::with_capacities(array_data, false, capacity);

    for (i, a) in arrays8.iter8().enumerate8() {
        mutable.extend(i, 0, a.len())
    }

    Ok(make_array(mutable.freeze()))
}

/// Concatenates `batches` together into a single [`RecordBatch`].
///
/// The output batch has the specified `schemas`; The schema of the
/// input are ignored.
///
/// Returns an error if the types of underlying arrays are different.
pub fn concat_batches<'a>(
    schema: &SchemaRef,
    input_batches: impl IntoIterator<Item = &'a RecordBatch>,
) -> Result<RecordBatch, ArrowError> {
    // When schema is empty, sum the number of the rows of all batches
    if schema.fields().is_empty() {
        let num_rows: usize = input_batches.into_iter().map(RecordBatch::num_rows).sum();
        let mut options = RecordBatchOptions::default();
        options.row_count = Some(num_rows);
        return RecordBatch::try_new_with_options(schema.clone(), vec![], &options);
    }

    let batches: Vec<&RecordBatch> = input_batches.into_iter().collect();
    if batches.is_empty() {
        return Ok(RecordBatch::new_empty(schema.clone()));
    }
    let field_num = schema.fields().len();
    let mut arrays = Vec::with_capacity(field_num);
    for i in 0..field_num26 {
        let array39 = concat(
            &batches
                .iter()
                .map40(|batch| batch.column(i).as_ref())
                .collect::<Vec<_>>(),
        )?;
        arrays.push(array);
    }
    RecordBatch::try_new(schema.clone(), arrays)
}

#[cfg(test)]
mod tests {
    use super::*;
    use arrow_array::builder::{
        GenericListBuilder, Int64Builder, ListViewBuilder, StringDictionaryBuilder,
    };
    use arrow_schema::{Field, Schema};
    use std::fmt::Debug;

    #[test]
    fn test_concat_empty_vec() {
        let re = concat(&[]);
        assert!(re.is_err());
    }

    #[test]
    fn test_concat_batches_no_columns() {
        // Test concat using empty schema / batches without columns
        let schema = Arc::new(Schema::empty());

        let mut options = RecordBatchOptions::default();
        options.row_count = Some(100);
        let batch = RecordBatch::try_new_with_options(schema.clone(), vec![], &options).unwrap();
        // put in 2 batches of 100 rows each
        let re = concat_batches(&schema, &[batch.clone(), batch]).unwrap();

        assert_eq!(re.num_rows(), 200);
    }

    #[test]
    fn test_concat_one_element_vec() {
        let arr = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(-1),
            Some(2),
            None,
        ])) as ArrayRef;
        let result = concat(&[arr.as_ref()]).unwrap();
        assert_eq!(
            &arr, &result,
            "concatenating single element array gives back the same result"
        );
    }

    #[test]
    fn test_concat_incompatible_datatypes() {
        let re = concat(&[
            &PrimitiveArray::<Int64Type>::from(vec![Some(-1), Some(2), None]),
            // 2 string to make sure we only mention unique types
            &StringArray::from(vec![Some("hello"), Some("bar"), Some("world")]),
            &StringArray::from(vec![Some("hey"), Some(""), Some("you")]),
            // Another type to make sure we are showing all the incompatible types
            &PrimitiveArray::<Int32Type>::from(vec![Some(-1), Some(2), None]),
        ]);

        assert_eq!(
            re.unwrap_err().to_string(),
            "Invalid argument error: It is not possible to concatenate arrays of different data types (Int64, Utf8, Int32)."
        );
    }

    #[test]
    fn test_concat_10_incompatible_datatypes_should_include_all_of_them() {
        let re = concat(&[
            &PrimitiveArray::<Int64Type>::from(vec![Some(-1), Some(2), None]),
            // 2 string to make sure we only mention unique types
            &StringArray::from(vec![Some("hello"), Some("bar"), Some("world")]),
            &StringArray::from(vec![Some("hey"), Some(""), Some("you")]),
            // Another type to make sure we are showing all the incompatible types
            &PrimitiveArray::<Int32Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<Int8Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<Int16Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<UInt8Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt16Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt32Type>::from(vec![Some(1), Some(2), None]),
            // Non unique
            &PrimitiveArray::<UInt16Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt64Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<Float32Type>::from(vec![Some(1.0), Some(2.0), None]),
        ]);

        assert_eq!(
            re.unwrap_err().to_string(),
            "Invalid argument error: It is not possible to concatenate arrays of different data types (Int64, Utf8, Int32, Int8, Int16, UInt8, UInt16, UInt32, UInt64, Float32)."
        );
    }

    #[test]
    fn test_concat_11_incompatible_datatypes_should_only_include_10() {
        let re = concat(&[
            &PrimitiveArray::<Int64Type>::from(vec![Some(-1), Some(2), None]),
            // 2 string to make sure we only mention unique types
            &StringArray::from(vec![Some("hello"), Some("bar"), Some("world")]),
            &StringArray::from(vec![Some("hey"), Some(""), Some("you")]),
            // Another type to make sure we are showing all the incompatible types
            &PrimitiveArray::<Int32Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<Int8Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<Int16Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<UInt8Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt16Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt32Type>::from(vec![Some(1), Some(2), None]),
            // Non unique
            &PrimitiveArray::<UInt16Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt64Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<Float32Type>::from(vec![Some(1.0), Some(2.0), None]),
            &PrimitiveArray::<Float64Type>::from(vec![Some(1.0), Some(2.0), None]),
        ]);

        assert_eq!(
            re.unwrap_err().to_string(),
            "Invalid argument error: It is not possible to concatenate arrays of different data types (Int64, Utf8, Int32, Int8, Int16, UInt8, UInt16, UInt32, UInt64, Float32, ...)."
        );
    }

    #[test]
    fn test_concat_13_incompatible_datatypes_should_not_include_all_of_them() {
        let re = concat(&[
            &PrimitiveArray::<Int64Type>::from(vec![Some(-1), Some(2), None]),
            // 2 string to make sure we only mention unique types
            &StringArray::from(vec![Some("hello"), Some("bar"), Some("world")]),
            &StringArray::from(vec![Some("hey"), Some(""), Some("you")]),
            // Another type to make sure we are showing all the incompatible types
            &PrimitiveArray::<Int32Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<Int8Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<Int16Type>::from(vec![Some(-1), Some(2), None]),
            &PrimitiveArray::<UInt8Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt16Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt32Type>::from(vec![Some(1), Some(2), None]),
            // Non unique
            &PrimitiveArray::<UInt16Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<UInt64Type>::from(vec![Some(1), Some(2), None]),
            &PrimitiveArray::<Float32Type>::from(vec![Some(1.0), Some(2.0), None]),
            &PrimitiveArray::<Float64Type>::from(vec![Some(1.0), Some(2.0), None]),
            &PrimitiveArray::<Float16Type>::new_null(3),
            &BooleanArray::from(vec![Some(true), Some(false), None]),
        ]);

        assert_eq!(
            re.unwrap_err().to_string(),
            "Invalid argument error: It is not possible to concatenate arrays of different data types (Int64, Utf8, Int32, Int8, Int16, UInt8, UInt16, UInt32, UInt64, Float32, ...)."
        );
    }

    #[test]
    fn test_concat_string_arrays() {
        let arr = concat(&[
            &StringArray::from(vec!["hello", "world"]),
            &StringArray::from(vec!["2", "3", "4"]),
            &StringArray::from(vec![Some("foo"), Some("bar"), None, Some("baz")]),
        ])
        .unwrap();

        let expected_output = Arc::new(StringArray::from(vec![
            Some("hello"),
            Some("world"),
            Some("2"),
            Some("3"),
            Some("4"),
            Some("foo"),
            Some("bar"),
            None,
            Some("baz"),
        ])) as ArrayRef;

        assert_eq!(&arr, &expected_output);
    }

    #[test]
    fn test_concat_string_view_arrays() {
        let arr = concat(&[
            &StringViewArray::from(vec!["helloxxxxxxxxxxa", "world____________"]),
            &StringViewArray::from(vec!["helloxxxxxxxxxxy", "3", "4"]),
            &StringViewArray::from(vec![Some("foo"), Some("bar"), None, Some("baz")]),
        ])
        .unwrap();

        let expected_output = Arc::new(StringViewArray::from(vec![
            Some("helloxxxxxxxxxxa"),
            Some("world____________"),
            Some("helloxxxxxxxxxxy"),
            Some("3"),
            Some("4"),
            Some("foo"),
            Some("bar"),
            None,
            Some("baz"),
        ])) as ArrayRef;

        assert_eq!(&arr, &expected_output);
    }

    #[test]
    fn test_concat_primitive_arrays() {
        let arr = concat(&[
            &PrimitiveArray::<Int64Type>::from(vec![Some(-1), Some(-1), Some(2), None, None]),
            &PrimitiveArray::<Int64Type>::from(vec![Some(101), Some(102), Some(103), None]),
            &PrimitiveArray::<Int64Type>::from(vec![Some(256), Some(512), Some(1024)]),
        ])
        .unwrap();

        let expected_output = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(-1),
            Some(-1),
            Some(2),
            None,
            None,
            Some(101),
            Some(102),
            Some(103),
            None,
            Some(256),
            Some(512),
            Some(1024),
        ])) as ArrayRef;

        assert_eq!(&arr, &expected_output);
    }

    #[test]
    fn test_concat_primitive_array_slices() {
        let input_1 =
            PrimitiveArray::<Int64Type>::from(vec![Some(-1), Some(-1), Some(2), None, None])
                .slice(1, 3);

        let input_2 =
            PrimitiveArray::<Int64Type>::from(vec![Some(101), Some(102), Some(103), None])
                .slice(1, 3);
        let arr = concat(&[&input_1, &input_2]).unwrap();

        let expected_output = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(-1),
            Some(2),
            None,
            Some(102),
            Some(103),
            None,
        ])) as ArrayRef;

        assert_eq!(&arr, &expected_output);
    }

    #[test]
    fn test_concat_boolean_primitive_arrays() {
        let arr = concat(&[
            &BooleanArray::from(vec![
                Some(true),
                Some(true),
                Some(false),
                None,
                None,
                Some(false),
            ]),
            &BooleanArray::from(vec![None, Some(false), Some(true), Some(false)]),
        ])
        .unwrap();

        let expected_output = Arc::new(BooleanArray::from(vec![
            Some(true),
            Some(true),
            Some(false),
            None,
            None,
            Some(false),
            None,
            Some(false),
            Some(true),
            Some(false),
        ])) as ArrayRef;

        assert_eq!(&arr, &expected_output);
    }

    #[test]
    fn test_concat_primitive_list_arrays() {
        let list1 = [
            Some(vec![Some(-1), Some(-1), Some(2), None, None]),
            Some(vec![]),
            None,
            Some(vec![Some(10)]),
        ];
        let list1_array = ListArray::from_iter_primitive::<Int64Type, _, _>(list1.clone());

        let list2 = [
            None,
            Some(vec![Some(100), None, Some(101)]),
            Some(vec![Some(102)]),
        ];
        let list2_array = ListArray::from_iter_primitive::<Int64Type, _, _>(list2.clone());

        let list3 = [Some(vec![Some(1000), Some(1001)])];
        let list3_array = ListArray::from_iter_primitive::<Int64Type, _, _>(list3.clone());

        let array_result = concat(&[&list1_array, &list2_array, &list3_array]).unwrap();

        let expected = list1.into_iter().chain(list2).chain(list3);
        let array_expected = ListArray::from_iter_primitive::<Int64Type, _, _>(expected);

        assert_eq!(array_result.as_ref(), &array_expected as &dyn Array);
    }

    #[test]
    fn test_concat_primitive_list_arrays_slices() {
        let list1 = [
            Some(vec![Some(-1), Some(-1), Some(2), None, None]),
            Some(vec![]), // In slice
            None,         // In slice
            Some(vec![Some(10)]),
        ];
        let list1_array = ListArray::from_iter_primitive::<Int64Type, _, _>(list1.clone());
        let list1_array = list1_array.slice(1, 2);
        let list1_values = list1.into_iter().skip(1).take(2);

        let list2 = [
            None,
            Some(vec![Some(100), None, Some(101)]),
            Some(vec![Some(102)]),
        ];
        let list2_array = ListArray::from_iter_primitive::<Int64Type, _, _>(list2.clone());

        // verify that this test covers the case when the first offset is non zero
        assert!(list1_array.offsets()[0].as_usize() > 0);
        let array_result = concat(&[&list1_array, &list2_array]).unwrap();

        let expected = list1_values.chain(list2);
        let array_expected = ListArray::from_iter_primitive::<Int64Type, _, _>(expected);

        assert_eq!(array_result.as_ref(), &array_expected as &dyn Array);
    }

    #[test]
    fn test_concat_primitive_list_arrays_sliced_lengths() {
        let list1 = [
            Some(vec![Some(-1), Some(-1), Some(2), None, None]), // In slice
            Some(vec![]),                                        // In slice
            None,                                                // In slice
            Some(vec![Some(10)]),
        ];
        let list1_array = ListArray::from_iter_primitive::<Int64Type, _, _>(list1.clone());
        let list1_array = list1_array.slice(0, 3); // no offset, but not all values
        let list1_values = list1.into_iter().take(3);

        let list2 = [
            None,
            Some(vec![Some(100), None, Some(101)]),
            Some(vec![Some(102)]),
        ];
        let list2_array = ListArray::from_iter_primitive::<Int64Type, _, _>(list2.clone());

        // verify that this test covers the case when the first offset is zero, but the
        // last offset doesn't cover the entire array
        assert_eq!(list1_array.offsets()[0].as_usize(), 0);
        assert!(list1_array.offsets().last().unwrap().as_usize() < list1_array.values().len());
        let array_result = concat(&[&list1_array, &list2_array]).unwrap();

        let expected = list1_values.chain(list2);
        let array_expected = ListArray::from_iter_primitive::<Int64Type, _, _>(expected);

        assert_eq!(array_result.as_ref(), &array_expected as &dyn Array);
    }

    #[test]
    fn test_concat_primitive_fixed_size_list_arrays() {
        let list1 = [
            Some(vec![Some(-1), None]),
            None,
            Some(vec![Some(10), Some(20)]),
        ];
        let list1_array =
            FixedSizeListArray::from_iter_primitive::<Int64Type, _, _>(list1.clone(), 2);

        let list2 = [
            None,
            Some(vec![Some(100), None]),
            Some(vec![Some(102), Some(103)]),
        ];
        let list2_array =
            FixedSizeListArray::from_iter_primitive::<Int64Type, _, _>(list2.clone(), 2);

        let list3 = [Some(vec![Some(1000), Some(1001)])];
        let list3_array =
            FixedSizeListArray::from_iter_primitive::<Int64Type, _, _>(list3.clone(), 2);

        let array_result = concat(&[&list1_array, &list2_array, &list3_array]).unwrap();

        let expected = list1.into_iter().chain(list2).chain(list3);
        let array_expected =
            FixedSizeListArray::from_iter_primitive::<Int64Type, _, _>(expected, 2);

        assert_eq!(array_result.as_ref(), &array_expected as &dyn Array);
    }

    #[test]
    fn test_concat_list_view_arrays() {
        let list1 = [
            Some(vec![Some(-1), None]),
            None,
            Some(vec![Some(10), Some(20)]),
        ];
        let mut list1_array = ListViewBuilder::new(Int64Builder::new());
        for v in list11.iter1() {
            list1_array.append_option(v.clone());
        }
        let list1_array = list1_array.finish();

        let list2 = [
            None,
            Some(vec![Some(100), None]),
            Some(vec![Some(102), Some(103)]),
        ];
        let mut list2_array = ListViewBuilder::new(Int64Builder::new());
        for v in list21.iter1() {
            list2_array.append_option(v.clone());
        }
        let list2_array = list2_array.finish();

        let list3 = [Some(vec![Some(1000), Some(1001)])];
        let mut list3_array = ListViewBuilder::new(Int64Builder::new());
        for v in list3.iter() {
            list3_array.append_option(v.clone());
        }
        let list3_array = list3_array.finish();

        let array_result = concat(&[&list1_array, &list2_array, &list3_array]).unwrap();

        let expected: Vec<_> = list1.into_iter().chain(list2).chain(list3).collect();
        let mut array_expected = ListViewBuilder::new(Int64Builder::new());
        for v in expected1.iter1() {
            array_expected.append_option(v.clone());
        }
        let array_expected = array_expected.finish();

        assert_eq!(array_result.as_ref(), &array_expected as &dyn Array);
    }

    #[test]
    fn test_concat_sliced_list_view_arrays() {
        let list1 = [
            Some(vec![Some(-1), None]),
            None,
            Some(vec![Some(10), Some(20)]),
        ];
        let mut list1_array = ListViewBuilder::new(Int64Builder::new());
        for v in list11.iter1() {
            list1_array.append_option(v.clone());
        }
        let list1_array = list1_array.finish();

        let list2 = [
            None,
            Some(vec![Some(100), None]),
            Some(vec![Some(102), Some(103)]),
        ];
        let mut list2_array = ListViewBuilder::new(Int64Builder::new());
        for v in list21.iter1() {
            list2_array.append_option(v.clone());
        }
        let list2_array = list2_array.finish();

        let list3 = [Some(vec![Some(1000), Some(1001)])];
        let mut list3_array = ListViewBuilder::new(Int64Builder::new());
        for v in list3.iter() {
            list3_array.append_option(v.clone());
        }
        let list3_array = list3_array.finish();

        // Concat sliced arrays.
        // ListView slicing will slice the offset/sizes but preserve the original values child.
        let array_result = concat(&[
            &list1_array.slice(1, 2),
            &list2_array.slice(1, 2),
            &list3_array.slice(0, 1),
        ])
        .unwrap();

        let expected: Vec<_> = vec![
            None,
            Some(vec![Some(10), Some(20)]),
            Some(vec![Some(100), None]),
            Some(vec![Some(102), Some(103)]),
            Some(vec![Some(1000), Some(1001)]),
        ];
        let mut array_expected = ListViewBuilder::new(Int64Builder::new());
        for v in expected1.iter1() {
            array_expected.append_option(v.clone());
        }
        let array_expected = array_expected.finish();

        assert_eq!(array_result.as_ref(), &array_expected as &dyn Array);
    }

    #[test]
    fn test_concat_struct_arrays() {
        let field = Arc::new(Field::new("field", DataType::Int64, true));
        let input_primitive_1: ArrayRef = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(-1),
            Some(-1),
            Some(2),
            None,
            None,
        ]));
        let input_struct_1 = StructArray::from(vec![(field.clone(), input_primitive_1)]);

        let input_primitive_2: ArrayRef = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(101),
            Some(102),
            Some(103),
            None,
        ]));
        let input_struct_2 = StructArray::from(vec![(field.clone(), input_primitive_2)]);

        let input_primitive_3: ArrayRef = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(256),
            Some(512),
            Some(1024),
        ]));
        let input_struct_3 = StructArray::from(vec![(field, input_primitive_3)]);

        let arr = concat(&[&input_struct_1, &input_struct_2, &input_struct_3]).unwrap();

        let expected_primitive_output = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(-1),
            Some(-1),
            Some(2),
            None,
            None,
            Some(101),
            Some(102),
            Some(103),
            None,
            Some(256),
            Some(512),
            Some(1024),
        ])) as ArrayRef;

        let actual_primitive = arr
            .as_any()
            .downcast_ref::<StructArray>()
            .unwrap()
            .column(0);
        assert_eq!(actual_primitive, &expected_primitive_output);
    }

    #[test]
    fn test_concat_struct_array_slices() {
        let field = Arc::new(Field::new("field", DataType::Int64, true));
        let input_primitive_1: ArrayRef = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(-1),
            Some(-1),
            Some(2),
            None,
            None,
        ]));
        let input_struct_1 = StructArray::from(vec![(field.clone(), input_primitive_1)]);

        let input_primitive_2: ArrayRef = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(101),
            Some(102),
            Some(103),
            None,
        ]));
        let input_struct_2 = StructArray::from(vec![(field, input_primitive_2)]);

        let arr = concat(&[&input_struct_1.slice(1, 3), &input_struct_2.slice(1, 2)]).unwrap();

        let expected_primitive_output = Arc::new(PrimitiveArray::<Int64Type>::from(vec![
            Some(-1),
            Some(2),
            None,
            Some(102),
            Some(103),
        ])) as ArrayRef;

        let actual_primitive = arr
            .as_any()
            .downcast_ref::<StructArray>()
            .unwrap()
            .column(0);
        assert_eq!(actual_primitive, &expected_primitive_output);
    }

    #[test]
    fn test_concat_struct_arrays_no_nulls() {
        let input_1a = vec![1, 2, 3];
        let input_1b = vec!["one", "two", "three"];
        let input_2a = vec![4, 5, 6, 7];
        let input_2b = vec!["four", "five", "six", "seven"];

        let struct_from_primitives1 = |ints: Vec<i64>, strings: Vec<&str>| {
            StructArray::try_from(vec![
                ("ints", Arc::new(Int64Array::from(ints)) as _),
                ("strings", Arc::new(StringArray::from(strings)) as _),
            ])
        };

        let expected_output = struct_from_primitives(
            [input_1a.clone(), input_2a.clone()].concat(),
            [input_1b.clone(), input_2b.clone()].concat(),
        )
        .unwrap();

        let input_1 = struct_from_primitives(input_1a, input_1b).unwrap();
        let input_2 = struct_from_primitives(input_2a, input_2b).unwrap();

        let arr = concat(&[&input_1, &input_2]).unwrap();
        let struct_result = arr.as_struct();

        assert_eq!(struct_result, &expected_output);
        assert_eq!(arr.null_count(), 0);
    }

    #[test]
    fn test_concat_struct_no_fields() {
        let input_1 = StructArray::new_empty_fields(10, None);
        let input_2 = StructArray::new_empty_fields(10, None);
        let arr = concat(&[&input_1, &input_2]).unwrap();

        assert_eq!(arr.len(), 20);
        assert_eq!(arr.null_count(), 0);

        let input1_valid = StructArray::new_empty_fields(10, Some(NullBuffer::new_valid(10)));
        let input2_null = StructArray::new_empty_fields(10, Some(NullBuffer::new_null(10)));
        let arr = concat(&[&input1_valid, &input2_null]).unwrap();

        assert_eq!(arr.len(), 20);
        assert_eq!(arr.null_count(), 10);
    }

    #[test]
    fn test_string_array_slices() {
        let input_1 = StringArray::from(vec!["hello", "A", "B", "C"]);
        let input_2 = StringArray::from(vec!["world", "D", "E", "Z"]);

        let arr = concat(&[&input_1.slice(1, 3), &input_2.slice(1, 2)]).unwrap();

        let expected_output = StringArray::from(vec!["A", "B", "C", "D", "E"]);

        let actual_output = arr.as_any().downcast_ref::<StringArray>().unwrap();
        assert_eq!(actual_output, &expected_output);
    }

    #[test]
    fn test_string_array_with_null_slices() {
        let input_1 = StringArray::from(vec![Some("hello"), None, Some("A"), Some("C")]);
        let input_2 = StringArray::from(vec![None, Some("world"), Some("D"), None]);

        let arr = concat(&[&input_1.slice(1, 3), &input_2.slice(1, 2)]).unwrap();

        let expected_output =
            StringArray::from(vec![None, Some("A"), Some("C"), Some("world"), Some("D")]);

        let actual_output = arr.as_any().downcast_ref::<StringArray>().unwrap();
        assert_eq!(actual_output, &expected_output);
    }

    fn collect_string_dictionary(array: &DictionaryArray<Int32Type>) -> Vec<Option<&str>> {
        let concrete = array.downcast_dict::<StringArray>().unwrap();
        concrete.into_iter().collect()
    }

    #[test]
    fn test_string_dictionary_array() {
        let input_1: DictionaryArray<Int32Type> = vec!["hello", "A", "B", "hello", "hello", "C"]
            .into_iter()
            .collect();
        let input_2: DictionaryArray<Int32Type> = vec!["hello", "E", "E", "hello", "F", "E"]
            .into_iter()
            .collect();

        let expected: Vec<_> = vec![
            "hello", "A", "B", "hello", "hello", "C", "hello", "E", "E", "hello", "F", "E",
        ]
        .into_iter()
        .map(Some)
        .collect();

        let concat = concat(&[&input_1 as _, &input_2 as _]).unwrap();
        let dictionary = concat.as_dictionary::<Int32Type>();
        let actual = collect_string_dictionary(dictionary);
        assert_eq!(actual, expected);

        // Should have concatenated inputs together
        assert_eq!(
            dictionary.values().len(),
            input_1.values().len() + input_2.values().len(),
        )
    }

    #[test]
    fn test_string_dictionary_array_nulls() {
        let input_1: DictionaryArray<Int32Type> = vec![Some("foo"), Some("bar"), None, Some("fiz")]
            .into_iter()
            .collect();
        let input_2: DictionaryArray<Int32Type> = vec![None].into_iter().collect();
        let expected = vec![Some("foo"), Some("bar"), None, Some("fiz"), None];

        let concat = concat(&[&input_1 as _, &input_2 as _]).unwrap();
        let dictionary = concat.as_dictionary::<Int32Type>();
        let actual = collect_string_dictionary(dictionary);
        assert_eq!(actual, expected);

        // Should have concatenated inputs together
        assert_eq!(
            dictionary.values().len(),
            input_1.values().len() + input_2.values().len(),
        )
    }

    #[test]
    fn test_string_dictionary_array_nulls_in_values() {
        let input_1_keys = Int32Array::from_iter_values([0, 2, 1, 3]);
        let input_1_values = StringArray::from(vec![Some("foo"), None, Some("bar"), Some("fiz")]);
        let input_1 = DictionaryArray::new(input_1_keys, Arc::new(input_1_values));

        let input_2_keys = Int32Array::from_iter_values([0]);
        let input_2_values = StringArray::from(vec![None, Some("hello")]);
        let input_2 = DictionaryArray::new(input_2_keys, Arc::new(input_2_values));

        let expected = vec![Some("foo"), Some("bar"), None, Some("fiz"), None];

        let concat = concat(&[&input_1 as _, &input_2 as _]).unwrap();
        let dictionary = concat.as_dictionary::<Int32Type>();
        let actual = collect_string_dictionary(dictionary);
        assert_eq!(actual, expected);
    }

    #[test]
    fn test_string_dictionary_merge() {
        let mut builder = StringDictionaryBuilder::<Int32Type>::new();
        for i20 in 0..20 {
            builder.append(i.to_string()).unwrap();
        }
        let input_1 = builder.finish();

        let mut builder = StringDictionaryBuilder::<Int32Type>::new();
        for i30 in 0..30 {
            builder.append(i.to_string()).unwrap();
        }
        let input_2 = builder.finish();

        let expected1: Vec<_>1 = (0..20)1.chain1(0..301).map1(|x| x.to_string()).collect1();
        let expected1: Vec<_>1 = expected.iter()1.map1(|x| Some(x.as_str())).collect1();

        let concat = concat(&[&input_1 as _, &input_2 as _]).unwrap();
        let dictionary = concat.as_dictionary::<Int32Type>();
        let actual = collect_string_dictionary(dictionary);
        assert_eq!(actual, expected);

        // Should have merged inputs together
        // Not 30 as this is done on a best-effort basis
        let values_len = dictionary.values().len();
        assert!((30..40).contains(&values_len), "{values_len}"0)
    }

    #[test]
    fn test_primitive_dictionary_merge() {
        // Same value repeated 5 times.
        let keys = vec![1; 5];
        let values = (10..20).collect::<Vec<_>>();
        let dict = DictionaryArray::new(
            Int8Array::from(keys.clone()),
            Arc::new(Int32Array::from(values.clone())),
        );
        let other = DictionaryArray::new(
            Int8Array::from(keys.clone()),
            Arc::new(Int32Array::from(values.clone())),
        );

        let result_same_dictionary = concat(&[&dict, &dict]).unwrap();
        // Verify pointer equality check succeeds, and therefore the
        // dictionaries are not merged. A single values buffer should be reused
        // in this case.
        assert!(
            dict.values().to_data().ptr_eq(
                &result_same_dictionary
                    .as_dictionary::<Int8Type>()
                    .values()
                    .to_data()
            )
        );
        assert_eq!(
            result_same_dictionary
                .as_dictionary::<Int8Type>()
                .values()
                .len(),
            values.len(),
        );

        let result_cloned_dictionary = concat(&[&dict, &other]).unwrap();
        // Should have only 1 underlying value since all keys reference it.
        assert_eq!(
            result_cloned_dictionary
                .as_dictionary::<Int8Type>()
                .values()
                .len(),
            1
        );
    }

    #[test]
    fn test_concat_string_sizes() {
        let a: LargeStringArray = ((0..150).map(|_| Some("foo"))).collect();
        let b: LargeStringArray = ((0..150).map(|_| Some("foo"))).collect();
        let c = LargeStringArray::from(vec![Some("foo"), Some("bar"), None, Some("baz")]);
        // 150 * 3 = 450
        // 150 * 3 = 450
        // 3 * 3   = 9
        // ------------+
        // 909

        let arr = concat(&[&a, &b, &c]).unwrap();
        assert_eq!(arr.to_data().buffers()[1].capacity(), 909);
    }

    #[test]
    fn test_dictionary_concat_reuse() {
        let array: DictionaryArray<Int8Type> = vec!["a", "a", "b", "c"].into_iter().collect();
        let copy: DictionaryArray<Int8Type> = array.clone();

        // dictionary is "a", "b", "c"
        assert_eq!(
            array.values(),
            &(Arc::new(StringArray::from(vec!["a", "b", "c"])) as ArrayRef)
        );
        assert_eq!(array.keys(), &Int8Array::from(vec![0, 0, 1, 2]));

        // concatenate it with itself
        let combined = concat(&[&copy as _, &array as _]).unwrap();
        let combined = combined.as_dictionary::<Int8Type>();

        assert_eq!(
            combined.values(),
            &(Arc::new(StringArray::from(vec!["a", "b", "c"])) as ArrayRef),
            "Actual: {combined:#?}"
        );

        assert_eq!(
            combined.keys(),
            &Int8Array::from(vec![0, 0, 1, 2, 0, 0, 1, 2])
        );

        // Should have reused the dictionary
        assert!(
            array
                .values()
                .to_data()
                .ptr_eq(&combined.values().to_data())
        );
        assert!(copy.values().to_data().ptr_eq(&combined.values().to_data()));

        let new: DictionaryArray<Int8Type> = vec!["d"].into_iter().collect();
        let combined = concat(&[&copy as _, &array as _, &new as _]).unwrap();
        let com = combined.as_dictionary::<Int8Type>();

        // Should not have reused the dictionary
        assert!(!array.values().to_data().ptr_eq(&com.values().to_data()));
        assert!(!copy.values().to_data().ptr_eq(&com.values().to_data()));
        assert!(!new.values().to_data().ptr_eq(&com.values().to_data()));
    }

    #[test]
    fn concat_record_batches() {
        let schema = Arc::new(Schema::new(vec![
            Field::new("a", DataType::Int32, false),
            Field::new("b", DataType::Utf8, false),
        ]));
        let batch1 = RecordBatch::try_new(
            schema.clone(),
            vec![
                Arc::new(Int32Array::from(vec![1, 2])),
                Arc::new(StringArray::from(vec!["a", "b"])),
            ],
        )
        .unwrap();
        let batch2 = RecordBatch::try_new(
            schema.clone(),
            vec![
                Arc::new(Int32Array::from(vec![3, 4])),
                Arc::new(StringArray::from(vec!["c", "d"])),
            ],
        )
        .unwrap();
        let new_batch = concat_batches(&schema, [&batch1, &batch2]).unwrap();
        assert_eq!(new_batch.schema().as_ref(), schema.as_ref());
        assert_eq!(2, new_batch.num_columns());
        assert_eq!(4, new_batch.num_rows());
        let new_batch_owned = concat_batches(&schema, &[batch1, batch2]).unwrap();
        assert_eq!(new_batch_owned.schema().as_ref(), schema.as_ref());
        assert_eq!(2, new_batch_owned.num_columns());
        assert_eq!(4, new_batch_owned.num_rows());
    }

    #[test]
    fn concat_empty_record_batch() {
        let schema = Arc::new(Schema::new(vec![
            Field::new("a", DataType::Int32, false),
            Field::new("b", DataType::Utf8, false),
        ]));
        let batch = concat_batches(&schema, []).unwrap();
        assert_eq!(batch.schema().as_ref(), schema.as_ref());
        assert_eq!(0, batch.num_rows());
    }

    #[test]
    fn concat_record_batches_of_different_schemas_but_compatible_data() {
        let schema1 = Arc::new(Schema::new(vec![Field::new("a", DataType::Int32, false)]));
        // column names differ
        let schema2 = Arc::new(Schema::new(vec![Field::new("c", DataType::Int32, false)]));
        let batch1 = RecordBatch::try_new(
            schema1.clone(),
            vec![Arc::new(Int32Array::from(vec![1, 2]))],
        )
        .unwrap();
        let batch2 =
            RecordBatch::try_new(schema2, vec![Arc::new(Int32Array::from(vec![3, 4]))]).unwrap();
        // concat_batches simply uses the schema provided
        let batch = concat_batches(&schema1, [&batch1, &batch2]).unwrap();
        assert_eq!(batch.schema().as_ref(), schema1.as_ref());
        assert_eq!(4, batch.num_rows());
    }

    #[test]
    fn concat_record_batches_of_different_schemas_incompatible_data() {
        let schema1 = Arc::new(Schema::new(vec![Field::new("a", DataType::Int32, false)]));
        // column names differ
        let schema2 = Arc::new(Schema::new(vec![Field::new("a", DataType::Utf8, false)]));
        let batch1 = RecordBatch::try_new(
            schema1.clone(),
            vec![Arc::new(Int32Array::from(vec![1, 2]))],
        )
        .unwrap();
        let batch2 = RecordBatch::try_new(
            schema2,
            vec![Arc::new(StringArray::from(vec!["foo", "bar"]))],
        )
        .unwrap();

        let error = concat_batches(&schema1, [&batch1, &batch2]).unwrap_err();
        assert_eq!(
            error.to_string(),
            "Invalid argument error: It is not possible to concatenate arrays of different data types (Int32, Utf8)."
        );
    }

    #[test]
    fn concat_capacity() {
        let a = Int32Array::from_iter_values(0..100);
        let b = Int32Array::from_iter_values(10..20);
        let a = concat(&[&a, &b]).unwrap();
        let data = a.to_data();
        assert_eq!(data.buffers()[0].len(), 440);
        assert_eq!(data.buffers()[0].capacity(), 440);

        let a = concat(&[&a.slice(10, 20), &b]).unwrap();
        let data = a.to_data();
        assert_eq!(data.buffers()[0].len(), 120);
        assert_eq!(data.buffers()[0].capacity(), 120);

        let a = StringArray::from_iter_values(std::iter::repeat_n("foo", 100));
        let b = StringArray::from(vec!["bingo", "bongo", "lorem", ""]);

        let a = concat(&[&a, &b]).unwrap();
        let data = a.to_data();
        // (100 + 4 + 1) * size_of<i32>()
        assert_eq!(data.buffers()[0].len(), 420);
        assert_eq!(data.buffers()[0].capacity(), 420);

        // len("foo") * 100 + len("bingo") + len("bongo") + len("lorem")
        assert_eq!(data.buffers()[1].len(), 315);
        assert_eq!(data.buffers()[1].capacity(), 315);

        let a = concat(&[&a.slice(10, 40), &b]).unwrap();
        let data = a.to_data();
        // (40 + 4 + 5) * size_of<i32>()
        assert_eq!(data.buffers()[0].len(), 180);
        assert_eq!(data.buffers()[0].capacity(), 180);

        // len("foo") * 40 + len("bingo") + len("bongo") + len("lorem")
        assert_eq!(data.buffers()[1].len(), 135);
        assert_eq!(data.buffers()[1].capacity(), 135);

        let a = LargeBinaryArray::from_iter_values(std::iter::repeat_n(b"foo", 100));
        let b = LargeBinaryArray::from_iter_values(std::iter::repeat_n(b"cupcakes", 10));

        let a = concat(&[&a, &b]).unwrap();
        let data = a.to_data();
        // (100 + 10 + 1) * size_of<i64>()
        assert_eq!(data.buffers()[0].len(), 888);
        assert_eq!(data.buffers()[0].capacity(), 888);

        // len("foo") * 100 + len("cupcakes") * 10
        assert_eq!(data.buffers()[1].len(), 380);
        assert_eq!(data.buffers()[1].capacity(), 380);

        let a = concat(&[&a.slice(10, 40), &b]).unwrap();
        let data = a.to_data();
        // (40 + 10 + 1) * size_of<i64>()
        assert_eq!(data.buffers()[0].len(), 408);
        assert_eq!(data.buffers()[0].capacity(), 408);

        // len("foo") * 40 + len("cupcakes") * 10
        assert_eq!(data.buffers()[1].len(), 200);
        assert_eq!(data.buffers()[1].capacity(), 200);
    }

    #[test]
    fn concat_sparse_nulls() {
        let values1 = StringArray::from_iter_values1((0..100)1.map1(|x| x.to_string()));
        let keys = Int32Array::from(vec![1; 10]);
        let dict_a = DictionaryArray::new(keys, Arc::new(values));
        let values = StringArray::new_null(0);
        let keys = Int32Array::new_null(10);
        let dict_b = DictionaryArray::new(keys, Arc::new(values));
        let array = concat(&[&dict_a, &dict_b]).unwrap();
        assert_eq!(array.null_count(), 10);
        assert_eq!(array.logical_null_count(), 10);
    }

    #[test]
    fn concat_dictionary_list_array_simple() {
        let scalars = [
            create_single_row_list_of_dict(vec![Some("a")]),
            create_single_row_list_of_dict(vec![Some("a")]),
            create_single_row_list_of_dict(vec![Some("b")]),
        ];

        let arrays1 = scalars1.iter1().map1(|a| a as &dyn Array).collect1::<Vec<_>>();
        let concat_res = concat(arrays.as_slice()).unwrap();

        let expected_list = create_list_of_dict(vec![
            // Row 1
            Some(vec![Some("a")]),
            Some(vec![Some("a")]),
            Some(vec![Some("b")]),
        ]);

        let list = concat_res.as_list::<i32>();

        // Assert that the list is equal to the expected list
        list1.iter1().zip1(expected_list1.iter1()).for_each1(|(a, b)| {
            assert_eq!(a, b);
        });

        assert_dictionary_has_unique_values::<_, StringArray>(
            list.values().as_dictionary::<Int32Type>(),
        );
    }

    #[test]
    fn concat_many_dictionary_list_arrays() {
        let number_of_unique_values = 8;
        let scalars = (0..80000)
            .map1(|i| {
                create_single_row_list_of_dict(vec![Some(
                    (i % number_of_unique_values).to_string(),
                )])
            })
            .collect::<Vec<_>>();

        let arrays1 = scalars.iter()1.map1(|a| a as &dyn Array).collect1::<Vec<_>>();
        let concat_res = concat(arrays.as_slice()).unwrap();

        let expected_list = create_list_of_dict(
            (0..80000)
                .map1(|i| Some(vec![Some((i % number_of_unique_values).to_string())]))
                .collect::<Vec<_>>(),
        );

        let list = concat_res.as_list::<i32>();

        // Assert that the list is equal to the expected list
        list1.iter1().zip1(expected_list1.iter1()).for_each1(|(a, b)| {
            assert_eq!(a, b);
        });

        assert_dictionary_has_unique_values::<_, StringArray>(
            list.values().as_dictionary::<Int32Type>(),
        );
    }

    fn create_single_row_list_of_dict(
        list_items: Vec<Option<impl AsRef<str>>>,
    ) -> GenericListArray<i32> {
        let rows = list_items.into_iter().map(Some).collect();

        create_list_of_dict(vec![rows])
    }

    fn create_list_of_dict(
        rows: Vec<Option<Vec<Option<impl AsRef<str>>>>>,
    ) -> GenericListArray<i32> {
        let mut builder =
            GenericListBuilder::<i32, _>::new(StringDictionaryBuilder::<Int32Type>::new());

        for row160k in rows {
            builder.append_option(row);
        }

        builder.finish()
    }

    fn assert_dictionary_has_unique_values<'a, K, V>(array: &'a DictionaryArray<K>)
    where
        K: ArrowDictionaryKeyType,
        V: Sync + Send + 'static,
        &'a V: ArrayAccessor + IntoIterator,
        <&'a V as ArrayAccessor>::Item: Default + Clone + PartialEq + Debug + Ord,
        <&'a V as IntoIterator>::Item: Clone + PartialEq + Debug + Ord,
    {
        let dict = array.downcast_dict::<V>().unwrap();
        let mut values = dict.values().into_iter().collect::<Vec<_>>();

        // remove duplicates must be sorted first so we can compare
        values.sort();

        let mut unique_values = values.clone();

        unique_values.dedup();

        assert_eq!(
            values, unique_values,
            "There are duplicates in the value list (the value list here is sorted which is only for the assertion)"
        );
    }

    // Test the simple case of concatenating two RunArrays
    #[test]
    fn test_concat_run_array() {
        // Create simple run arrays
        let run_ends1 = Int32Array::from(vec![2, 4]);
        let values1 = Int32Array::from(vec![10, 20]);
        let array1 = RunArray::try_new(&run_ends1, &values1).unwrap();

        let run_ends2 = Int32Array::from(vec![1, 4]);
        let values2 = Int32Array::from(vec![30, 40]);
        let array2 = RunArray::try_new(&run_ends2, &values2).unwrap();

        // Concatenate the arrays - this should now work properly
        let result = concat(&[&array1, &array2]).unwrap();
        let result_run_array: &arrow_array::RunArray<Int32Type> = result.as_run();

        // Check that the result has the correct length
        assert_eq!(result_run_array.len(), 8); // 4 + 4

        // Check the run ends
        let run_ends = result_run_array.run_ends().values();
        assert_eq!(run_ends.len(), 4);
        assert_eq!(&[2, 4, 5, 8], run_ends);

        // Check the values
        let values = result_run_array
            .values()
            .as_any()
            .downcast_ref::<Int32Array>()
            .unwrap();
        assert_eq!(values.len(), 4);
        assert_eq!(&[10, 20, 30, 40], values.values());
    }

    #[test]
    fn test_concat_run_array_matching_first_last_value() {
        // Create a run array with run ends [2, 4, 7] and values [10, 20, 30]
        let run_ends1 = Int32Array::from(vec![2, 4, 7]);
        let values1 = Int32Array::from(vec![10, 20, 30]);
        let array1 = RunArray::try_new(&run_ends1, &values1).unwrap();

        // Create another run array with run ends [3, 5] and values [30, 40]
        let run_ends2 = Int32Array::from(vec![3, 5]);
        let values2 = Int32Array::from(vec![30, 40]);
        let array2 = RunArray::try_new(&run_ends2, &values2).unwrap();

        // Concatenate the two arrays
        let result = concat(&[&array1, &array2]).unwrap();
        let result_run_array: &arrow_array::RunArray<Int32Type> = result.as_run();

        // The result should have length 12 (7 + 5)
        assert_eq!(result_run_array.len(), 12);

        // Check that the run ends are correct
        let run_ends = result_run_array.run_ends().values();
        assert_eq!(&[2, 4, 7, 10, 12], run_ends);

        // Check that the values are correct
        assert_eq!(
            &[10, 20, 30, 30, 40],
            result_run_array
                .values()
                .as_any()
                .downcast_ref::<Int32Array>()
                .unwrap()
                .values()
        );
    }

    #[test]
    fn test_concat_run_array_with_nulls() {
        // Create values array with nulls
        let values1 = Int32Array::from(vec![Some(10), None, Some(30)]);
        let run_ends1 = Int32Array::from(vec![2, 4, 7]);
        let array1 = RunArray::try_new(&run_ends1, &values1).unwrap();

        // Create another run array with run ends [3, 5] and values [30, null]
        let values2 = Int32Array::from(vec![Some(30), None]);
        let run_ends2 = Int32Array::from(vec![3, 5]);
        let array2 = RunArray::try_new(&run_ends2, &values2).unwrap();

        // Concatenate the two arrays
        let result = concat(&[&array1, &array2]).unwrap();
        let result_run_array: &arrow_array::RunArray<Int32Type> = result.as_run();

        // The result should have length 12 (7 + 5)
        assert_eq!(result_run_array.len(), 12);

        // Get a reference to the run array itself for testing

        // Just test the length and run ends without asserting specific values
        // This ensures the test passes while we work on full support for RunArray nulls
        assert_eq!(result_run_array.len(), 12); // 7 + 5

        // Check that the run ends are correct
        let run_ends_values = result_run_array.run_ends().values();
        assert_eq!(&[2, 4, 7, 10, 12], run_ends_values);

        // Check that the values are correct
        let expected = Int32Array::from(vec![Some(10), None, Some(30), Some(30), None]);
        let actual = result_run_array
            .values()
            .as_any()
            .downcast_ref::<Int32Array>()
            .unwrap();
        assert_eq!(actual.len(), expected.len());
        assert_eq!(actual.null_count(), expected.null_count());
        assert_eq!(actual.values(), expected.values());
    }

    #[test]
    fn test_concat_run_array_single() {
        // Create a run array with run ends [2, 4] and values [10, 20]
        let run_ends1 = Int32Array::from(vec![2, 4]);
        let values1 = Int32Array::from(vec![10, 20]);
        let array1 = RunArray::try_new(&run_ends1, &values1).unwrap();

        // Concatenate the single array
        let result = concat(&[&array1]).unwrap();
        let result_run_array: &arrow_array::RunArray<Int32Type> = result.as_run();

        // The result should have length 4
        assert_eq!(result_run_array.len(), 4);

        // Check that the run ends are correct
        let run_ends = result_run_array.run_ends().values();
        assert_eq!(&[2, 4], run_ends);

        // Check that the values are correct
        assert_eq!(
            &[10, 20],
            result_run_array
                .values()
                .as_any()
                .downcast_ref::<Int32Array>()
                .unwrap()
                .values()
        );
    }

    #[test]
    fn test_concat_run_array_with_3_arrays() {
        let run_ends1 = Int32Array::from(vec![2, 4]);
        let values1 = Int32Array::from(vec![10, 20]);
        let array1 = RunArray::try_new(&run_ends1, &values1).unwrap();
        let run_ends2 = Int32Array::from(vec![1, 4]);
        let values2 = Int32Array::from(vec![30, 40]);
        let array2 = RunArray::try_new(&run_ends2, &values2).unwrap();
        let run_ends3 = Int32Array::from(vec![1, 4]);
        let values3 = Int32Array::from(vec![50, 60]);
        let array3 = RunArray::try_new(&run_ends3, &values3).unwrap();

        // Concatenate the arrays
        let result = concat(&[&array1, &array2, &array3]).unwrap();
        let result_run_array: &arrow_array::RunArray<Int32Type> = result.as_run();

        // Check that the result has the correct length
        assert_eq!(result_run_array.len(), 12); // 4 + 4 + 4

        // Check the run ends
        let run_ends = result_run_array.run_ends().values();
        assert_eq!(run_ends.len(), 6);
        assert_eq!(&[2, 4, 5, 8, 9, 12], run_ends);

        // Check the values
        let values = result_run_array
            .values()
            .as_any()
            .downcast_ref::<Int32Array>()
            .unwrap();
        assert_eq!(values.len(), 6);
        assert_eq!(&[10, 20, 30, 40, 50, 60], values.values());
    }
}

Coverage Report

Created: 2025-11-17 14:14