vortex_array/arrays/struct_/compute/
zip.rs1use std::ops::BitAnd;
5use std::ops::BitOr;
6use std::ops::Not;
7
8use vortex_error::VortexResult;
9use vortex_mask::Mask;
10
11use crate::ArrayRef;
12use crate::ExecutionCtx;
13use crate::IntoArray;
14use crate::array::ArrayView;
15use crate::arrays::Struct;
16use crate::arrays::StructArray;
17use crate::arrays::struct_::StructArrayExt;
18use crate::builtins::ArrayBuiltins;
19use crate::scalar_fn::fns::zip::ZipKernel;
20use crate::validity::Validity;
21
22impl ZipKernel for Struct {
23 fn zip(
24 if_true: ArrayView<'_, Struct>,
25 if_false: &ArrayRef,
26 mask: &ArrayRef,
27 ctx: &mut ExecutionCtx,
28 ) -> VortexResult<Option<ArrayRef>> {
29 let Some(if_false) = if_false.as_opt::<Struct>() else {
30 return Ok(None);
31 };
32 assert_eq!(
33 if_true.names(),
34 if_false.names(),
35 "input arrays to zip must have the same field names",
36 );
37
38 let fields = if_true
39 .iter_unmasked_fields()
40 .zip(if_false.iter_unmasked_fields())
41 .map(|(t, f)| mask.zip(t.clone(), f.clone()))
42 .collect::<VortexResult<Vec<_>>>()?;
43
44 let v1 = if_true.validity()?;
45 let v2 = if_false.validity()?;
46 let validity = match (&v1, &v2) {
47 (Validity::NonNullable, Validity::NonNullable) => Validity::NonNullable,
48 (Validity::AllValid, Validity::AllValid) => Validity::AllValid,
49 (Validity::AllInvalid, Validity::AllInvalid) => Validity::AllInvalid,
50
51 (v1, v2) => {
52 let mask_mask = mask.clone().fill_null(false)?.execute::<Mask>(ctx)?;
53 let v1m = v1.execute_mask(if_true.len(), ctx)?;
54 let v2m = v2.execute_mask(if_false.len(), ctx)?;
55
56 let combined = v1m.bitand(&mask_mask).bitor(&v2m.bitand(&mask_mask.not()));
57 Validity::from_mask(
58 combined,
59 if_true.dtype().nullability() | if_false.dtype().nullability(),
60 )
61 }
62 };
63
64 Ok(Some(
65 StructArray::try_new(if_true.names().clone(), fields, if_true.len(), validity)?
66 .into_array(),
67 ))
68 }
69}
70
71#[cfg(test)]
72mod tests {
73 use std::sync::LazyLock;
74
75 use vortex_mask::Mask;
76 use vortex_session::VortexSession;
77
78 use crate::IntoArray;
79 use crate::VortexSessionExecute;
80 use crate::arrays::PrimitiveArray;
81 use crate::arrays::StructArray;
82 use crate::builtins::ArrayBuiltins;
83 use crate::dtype::FieldNames;
84 use crate::validity::Validity;
85
86 static SESSION: LazyLock<VortexSession> = LazyLock::new(VortexSession::empty);
87
88 #[test]
89 fn test_validity_zip_both_validity_array() {
90 let ctx = SESSION.create_execution_ctx();
91 let if_true = StructArray::new(
93 FieldNames::from_iter(["field"]),
94 vec![PrimitiveArray::from_iter([1, 2, 3, 4]).into_array()],
95 4,
96 Validity::from_iter([true, false, true, false]),
97 )
98 .into_array();
99
100 let if_false = StructArray::new(
101 FieldNames::from_iter(["field"]),
102 vec![PrimitiveArray::from_iter([10, 20, 30, 40]).into_array()],
103 4,
104 Validity::from_iter([false, true, false, true]),
105 )
106 .into_array();
107
108 let mask = Mask::from_iter([false, false, true, false]);
109
110 let result = mask.into_array().zip(if_true, if_false).unwrap();
111
112 insta::assert_snapshot!(result.display_table(&ctx), @r"
113 ┌───────┐
114 │ field │
115 ├───────┤
116 │ null │
117 ├───────┤
118 │ 20i32 │
119 ├───────┤
120 │ 3i32 │
121 ├───────┤
122 │ 40i32 │
123 └───────┘
124 ");
125 }
126
127 #[test]
128 fn test_validity_zip_allvalid_and_array() {
129 let ctx = SESSION.create_execution_ctx();
130 let if_true = StructArray::new(
131 FieldNames::from_iter(["a"]),
132 vec![PrimitiveArray::from_iter([1, 2, 3, 4]).into_array()],
133 4,
134 Validity::AllValid,
135 )
136 .into_array();
137
138 let if_false = StructArray::new(
139 FieldNames::from_iter(["a"]),
140 vec![PrimitiveArray::from_iter([10, 20, 30, 40]).into_array()],
141 4,
142 Validity::from_iter([false, false, true, true]),
143 )
144 .into_array();
145
146 let mask = Mask::from_iter([true, false, false, false]);
147
148 let result = mask.into_array().zip(if_true, if_false).unwrap();
149
150 insta::assert_snapshot!(result.display_table(&ctx), @r"
151 ┌───────┐
152 │ a │
153 ├───────┤
154 │ 1i32 │
155 ├───────┤
156 │ null │
157 ├───────┤
158 │ 30i32 │
159 ├───────┤
160 │ 40i32 │
161 └───────┘
162 ");
163 }
164}