vortex_array/arrays/constant/compute/
take.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use vortex_error::VortexResult;
5use vortex_mask::AllOr;
6
7use crate::ArrayRef;
8use crate::IntoArray;
9use crate::array::ArrayView;
10use crate::arrays::Constant;
11use crate::arrays::ConstantArray;
12use crate::arrays::MaskedArray;
13use crate::arrays::dict::TakeReduce;
14use crate::arrays::dict::TakeReduceAdaptor;
15use crate::optimizer::rules::ParentRuleSet;
16use crate::scalar::Scalar;
17use crate::validity::Validity;
18
19impl TakeReduce for Constant {
20    fn take(array: ArrayView<'_, Constant>, indices: &ArrayRef) -> VortexResult<Option<ArrayRef>> {
21        let result = match indices.validity_mask()?.bit_buffer() {
22            AllOr::All => {
23                let scalar = Scalar::try_new(
24                    array
25                        .scalar()
26                        .dtype()
27                        .union_nullability(indices.dtype().nullability()),
28                    array.scalar().value().cloned(),
29                )?;
30                ConstantArray::new(scalar, indices.len()).into_array()
31            }
32            AllOr::None => ConstantArray::new(
33                Scalar::null(
34                    array
35                        .dtype()
36                        .union_nullability(indices.dtype().nullability()),
37                ),
38                indices.len(),
39            )
40            .into_array(),
41            AllOr::Some(v) => {
42                let arr = ConstantArray::new(array.scalar().clone(), indices.len()).into_array();
43
44                if array.scalar().is_null() {
45                    return Ok(Some(arr));
46                }
47
48                MaskedArray::try_new(arr, Validity::from(v.clone()))?.into_array()
49            }
50        };
51        Ok(Some(result))
52    }
53}
54
55impl Constant {
56    pub const TAKE_RULES: ParentRuleSet<Self> =
57        ParentRuleSet::new(&[ParentRuleSet::lift(&TakeReduceAdaptor::<Self>(Self))]);
58}
59
60#[cfg(test)]
61mod tests {
62    use rstest::rstest;
63    use vortex_buffer::buffer;
64    use vortex_mask::AllOr;
65
66    use crate::IntoArray;
67    use crate::ToCanonical;
68    use crate::arrays::ConstantArray;
69    use crate::arrays::PrimitiveArray;
70    use crate::assert_arrays_eq;
71    use crate::compute::conformance::take::test_take_conformance;
72    use crate::dtype::Nullability;
73    use crate::scalar::Scalar;
74    use crate::validity::Validity;
75
76    #[test]
77    fn take_nullable_indices() {
78        let array = ConstantArray::new(42, 10).into_array();
79        let taken = array
80            .take(
81                PrimitiveArray::new(
82                    buffer![0, 5, 7],
83                    Validity::from_iter(vec![false, true, false]),
84                )
85                .into_array(),
86            )
87            .unwrap();
88        let valid_indices: &[usize] = &[1usize];
89        assert_eq!(
90            &array.dtype().with_nullability(Nullability::Nullable),
91            taken.dtype()
92        );
93        assert_arrays_eq!(
94            taken.to_primitive(),
95            PrimitiveArray::new(
96                buffer![42i32, 42, 42],
97                Validity::from_iter([false, true, false])
98            )
99        );
100        assert_eq!(
101            taken.validity_mask().unwrap().indices(),
102            AllOr::Some(valid_indices)
103        );
104    }
105
106    #[test]
107    fn take_all_valid_indices() {
108        let array = ConstantArray::new(42, 10).into_array();
109        let taken = array
110            .take(PrimitiveArray::new(buffer![0, 5, 7], Validity::AllValid).into_array())
111            .unwrap();
112        assert_eq!(
113            &array.dtype().with_nullability(Nullability::Nullable),
114            taken.dtype()
115        );
116        assert_arrays_eq!(
117            taken.to_primitive(),
118            PrimitiveArray::new(buffer![42i32, 42, 42], Validity::AllValid)
119        );
120        assert_eq!(taken.validity_mask().unwrap().indices(), AllOr::All);
121    }
122
123    #[rstest]
124    #[case(ConstantArray::new(42i32, 5))]
125    #[case(ConstantArray::new(std::f64::consts::PI, 10))]
126    #[case(ConstantArray::new(Scalar::from("hello"), 3))]
127    #[case(ConstantArray::new(Scalar::null_native::<i64>(), 5))]
128    #[case(ConstantArray::new(true, 1))]
129    fn test_take_constant_conformance(#[case] array: ConstantArray) {
130        test_take_conformance(&array.into_array());
131    }
132}
vortex_array/arrays/constant/compute/take.rs

vortex_array/arrays/constant/compute/
take.rs
