sparrow 1.3.0
Loading...
Searching...
No Matches
dispatch.hpp
Go to the documentation of this file.
1// Copyright 2024 Man Group Operations Limited
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or mplied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <type_traits>
18
19#include "sparrow/date_array.hpp"
20#include "sparrow/decimal_array.hpp"
21#include "sparrow/dictionary_encoded_array.hpp"
22#include "sparrow/duration_array.hpp"
23#include "sparrow/fixed_width_binary_array.hpp"
24#include "sparrow/interval_array.hpp"
25#include "sparrow/layout/array_wrapper.hpp"
26#include "sparrow/layout/nested_value_types.hpp"
27#include "sparrow/list_array.hpp"
28#include "sparrow/map_array.hpp"
29#include "sparrow/null_array.hpp"
30#include "sparrow/primitive_array.hpp"
31#include "sparrow/run_end_encoded_array.hpp"
32#include "sparrow/struct_array.hpp"
33#include "sparrow/time_array.hpp"
34#include "sparrow/timestamp_array.hpp"
35#include "sparrow/timestamp_without_timezone_array.hpp"
36#include "sparrow/types/data_traits.hpp"
37#include "sparrow/types/data_type.hpp"
38#include "sparrow/union_array.hpp"
39#include "sparrow/utils/temporal.hpp"
40#include "sparrow/uuid_array.hpp"
41#include "sparrow/variable_size_binary_array.hpp"
42#include "sparrow/variable_size_binary_view_array.hpp"
43
44namespace sparrow
45{
46 template <class F>
47 using visit_result_t = std::invoke_result_t<F, null_array>;
48
49 template <class F>
50 [[nodiscard]] visit_result_t<F> visit(F&& func, const array_wrapper& ar)
51 {
52 if (ar.is_dictionary())
53 {
54 switch (ar.data_type())
55 {
56 case data_type::UINT8:
57 return func(unwrap_array<dictionary_encoded_array<std::uint8_t>>(ar));
58 case data_type::INT8:
59 return func(unwrap_array<dictionary_encoded_array<std::int8_t>>(ar));
60 case data_type::UINT16:
61 return func(unwrap_array<dictionary_encoded_array<std::uint16_t>>(ar));
62 case data_type::INT16:
63 return func(unwrap_array<dictionary_encoded_array<std::int16_t>>(ar));
64 case data_type::UINT32:
65 return func(unwrap_array<dictionary_encoded_array<std::uint32_t>>(ar));
66 case data_type::INT32:
67 return func(unwrap_array<dictionary_encoded_array<std::int32_t>>(ar));
68 case data_type::UINT64:
69 return func(unwrap_array<dictionary_encoded_array<std::uint64_t>>(ar));
70 case data_type::INT64:
71 return func(unwrap_array<dictionary_encoded_array<std::int64_t>>(ar));
72 default:
73 throw std::runtime_error("data datype of dictionary encoded array must be an integer");
74 }
75 }
76 else
77 {
78 switch (ar.data_type())
79 {
80 case data_type::NA:
81 return func(unwrap_array<null_array>(ar));
82 case data_type::BOOL:
83 return func(unwrap_array<primitive_array<bool>>(ar));
84 case data_type::UINT8:
85 return func(unwrap_array<primitive_array<std::uint8_t>>(ar));
86 case data_type::INT8:
87 return func(unwrap_array<primitive_array<std::int8_t>>(ar));
88 case data_type::UINT16:
89 return func(unwrap_array<primitive_array<std::uint16_t>>(ar));
90 case data_type::INT16:
91 return func(unwrap_array<primitive_array<std::int16_t>>(ar));
92 case data_type::UINT32:
93 return func(unwrap_array<primitive_array<std::uint32_t>>(ar));
94 case data_type::INT32:
95 return func(unwrap_array<primitive_array<std::int32_t>>(ar));
96 case data_type::UINT64:
97 return func(unwrap_array<primitive_array<std::uint64_t>>(ar));
98 case data_type::INT64:
99 return func(unwrap_array<primitive_array<std::int64_t>>(ar));
100 case data_type::HALF_FLOAT:
101 return func(unwrap_array<primitive_array<float16_t>>(ar));
102 case data_type::FLOAT:
103 return func(unwrap_array<primitive_array<float32_t>>(ar));
104 case data_type::DOUBLE:
105 return func(unwrap_array<primitive_array<float64_t>>(ar));
106 case data_type::STRING:
107 return func(unwrap_array<string_array>(ar));
108 case data_type::STRING_VIEW:
109 return func(unwrap_array<string_view_array>(ar));
110 case data_type::LARGE_STRING:
111 return func(unwrap_array<big_string_array>(ar));
112 case data_type::BINARY:
113 return func(unwrap_array<binary_array>(ar));
114 case data_type::BINARY_VIEW:
115 return func(unwrap_array<binary_view_array>(ar));
116 case data_type::LARGE_BINARY:
117 return func(unwrap_array<big_binary_array>(ar));
118 case data_type::RUN_ENCODED:
119 return func(unwrap_array<run_end_encoded_array>(ar));
120 case data_type::LIST:
121 return func(unwrap_array<list_array>(ar));
122 case data_type::LARGE_LIST:
123 return func(unwrap_array<big_list_array>(ar));
124 case data_type::LIST_VIEW:
125 return func(unwrap_array<list_view_array>(ar));
126 case data_type::LARGE_LIST_VIEW:
127 return func(unwrap_array<big_list_view_array>(ar));
128 case data_type::FIXED_SIZED_LIST:
129 return func(unwrap_array<fixed_sized_list_array>(ar));
130 case data_type::STRUCT:
131 return func(unwrap_array<struct_array>(ar));
132 case data_type::MAP:
133 return func(unwrap_array<map_array>(ar));
134 case data_type::DENSE_UNION:
135 return func(unwrap_array<dense_union_array>(ar));
136 case data_type::SPARSE_UNION:
137 return func(unwrap_array<sparse_union_array>(ar));
138 case data_type::DECIMAL32:
139 return func(unwrap_array<decimal_32_array>(ar));
140 case data_type::DECIMAL64:
141 return func(unwrap_array<decimal_64_array>(ar));
142 case data_type::DECIMAL128:
143 return func(unwrap_array<decimal_128_array>(ar));
144 case data_type::DECIMAL256:
145 return func(unwrap_array<decimal_256_array>(ar));
146 case data_type::FIXED_WIDTH_BINARY:
147 {
148 const std::optional<key_value_view> metadata = ar.get_arrow_proxy().metadata(); // ensure
149 // uuid_array
150 // is
151 // handled
152 // in
153 // uuid_array.cpp
154 if (metadata.has_value())
155 {
156 const auto it = metadata->find("ARROW:extension:name");
157 if (it != metadata->end())
158 {
159 return func(unwrap_array<uuid_array>(ar));
160 }
161 }
162 return func(unwrap_array<fixed_width_binary_array>(ar));
163 }
164 case sparrow::data_type::DATE_DAYS:
165 return func(unwrap_array<date_days_array>(ar));
166 case data_type::DATE_MILLISECONDS:
167 return func(unwrap_array<date_milliseconds_array>(ar));
168 case data_type::TIMESTAMP_SECONDS:
169 if (get_timezone(ar.get_arrow_proxy()) == nullptr)
170 {
171 return func(unwrap_array<timestamp_without_timezone_seconds_array>(ar));
172 }
173 else
174 {
175 return func(unwrap_array<timestamp_seconds_array>(ar));
176 }
177 case data_type::TIMESTAMP_MILLISECONDS:
178 if (get_timezone(ar.get_arrow_proxy()) == nullptr)
179 {
180 return func(unwrap_array<timestamp_without_timezone_milliseconds_array>(ar));
181 }
182 else
183 {
184 return func(unwrap_array<timestamp_milliseconds_array>(ar));
185 }
186 case data_type::TIMESTAMP_MICROSECONDS:
187 if (get_timezone(ar.get_arrow_proxy()) == nullptr)
188 {
189 return func(unwrap_array<timestamp_without_timezone_microseconds_array>(ar));
190 }
191 else
192 {
193 return func(unwrap_array<timestamp_microseconds_array>(ar));
194 }
195 case data_type::TIMESTAMP_NANOSECONDS:
196 if (get_timezone(ar.get_arrow_proxy()) == nullptr)
197 {
198 return func(unwrap_array<timestamp_without_timezone_nanoseconds_array>(ar));
199 }
200 else
201 {
202 return func(unwrap_array<timestamp_nanoseconds_array>(ar));
203 }
204 case data_type::TIME_SECONDS:
205 return func(unwrap_array<time_seconds_array>(ar));
206 case data_type::TIME_MILLISECONDS:
207 return func(unwrap_array<time_milliseconds_array>(ar));
208 case data_type::TIME_MICROSECONDS:
209 return func(unwrap_array<time_microseconds_array>(ar));
210 case data_type::TIME_NANOSECONDS:
211 return func(unwrap_array<time_nanoseconds_array>(ar));
212 case data_type::DURATION_SECONDS:
213 return func(unwrap_array<duration_seconds_array>(ar));
214 case data_type::DURATION_MILLISECONDS:
215 return func(unwrap_array<duration_milliseconds_array>(ar));
216 case data_type::DURATION_MICROSECONDS:
217 return func(unwrap_array<duration_microseconds_array>(ar));
218 case data_type::DURATION_NANOSECONDS:
219 return func(unwrap_array<duration_nanoseconds_array>(ar));
220 case data_type::INTERVAL_MONTHS:
221 return func(unwrap_array<months_interval_array>(ar));
222 case data_type::INTERVAL_DAYS_TIME:
223 return func(unwrap_array<days_time_interval_array>(ar));
224 case data_type::INTERVAL_MONTHS_DAYS_NANOSECONDS:
225 return func(unwrap_array<month_day_nanoseconds_interval_array>(ar));
226 default:
227 throw std::invalid_argument("array type not supported");
228 }
229 }
230 }
231}
array_wrapper.hpp
sparrow::array_wrapper
Base class for array type erasure.
Definition array_wrapper.hpp:51
sparrow::array_wrapper::is_dictionary
constexpr bool is_dictionary() const
Definition array_wrapper.hpp:135
sparrow::array_wrapper::get_arrow_proxy
constexpr arrow_proxy & get_arrow_proxy()
Definition array_wrapper.hpp:140
sparrow::array_wrapper::data_type
constexpr enum data_type data_type() const noexcept
Definition array_wrapper.hpp:130
sparrow::arrow_proxy::metadata
SPARROW_API std::optional< key_value_view > metadata() const
Gets the metadata key-value pairs.
sparrow::dictionary_encoded_array
Forward declaration of dictionary_encoded_array.
Definition dictionary_encoded_array.hpp:150
data_traits.hpp
data_type.hpp
date_array.hpp
decimal_array.hpp
dictionary_encoded_array.hpp
duration_array.hpp
fixed_width_binary_array.hpp
interval_array.hpp
list_array.hpp
map_array.hpp
sparrow::get_timezone
SPARROW_API const date::time_zone * get_timezone(const arrow_proxy &proxy)
sparrow::primitive_array
primitive_array_impl< T > primitive_array
Array of values of whose type has fixed binary size.
Definition primitive_array.hpp:63
sparrow::unwrap_array
T & unwrap_array(array_wrapper &)
Definition array_wrapper.hpp:250
sparrow::visit_result_t
std::invoke_result_t< F, null_array > visit_result_t
Definition dispatch.hpp:47
sparrow::visit
visit_result_t< F > visit(F &&func, const array_wrapper &ar)
Definition dispatch.hpp:50
nested_value_types.hpp
null_array.hpp
primitive_array.hpp
run_end_encoded_array.hpp
struct_array.hpp
time_array.hpp
timestamp_array.hpp
timestamp_without_timezone_array.hpp
union_array.hpp
uuid_array.hpp
variable_size_binary_array.hpp
variable_size_binary_view_array.hpp