pitrou commented on a change in pull request #10176: URL: https://github.com/apache/arrow/pull/10176#discussion_r643933506
########## File path: cpp/src/arrow/compute/kernels/scalar_temporal.cc ########## @@ -0,0 +1,614 @@ +// 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. + +#include "arrow/builder.h" +#include "arrow/compute/kernels/common.h" +#include "arrow/util/time.h" +#include "arrow/vendored/datetime.h" + +namespace arrow { + +namespace compute { +namespace internal { + +using applicator::ScalarUnaryNotNull; +using applicator::SimpleUnary; +using arrow_vendored::date::days; +using arrow_vendored::date::floor; +using arrow_vendored::date::hh_mm_ss; +using arrow_vendored::date::sys_days; +using arrow_vendored::date::sys_time; +using arrow_vendored::date::trunc; +using arrow_vendored::date::weekday; +using arrow_vendored::date::weeks; +using arrow_vendored::date::year_month_day; +using arrow_vendored::date::years; +using arrow_vendored::date::literals::dec; +using arrow_vendored::date::literals::jan; +using arrow_vendored::date::literals::last; +using arrow_vendored::date::literals::mon; +using arrow_vendored::date::literals::thu; + +// Based on ScalarUnaryNotNullStateful. Adds timezone awareness. +template <typename OutType, typename Op> +struct ScalarUnaryStatefulTemporal { + using ThisType = ScalarUnaryStatefulTemporal<OutType, Op>; + using OutValue = typename GetOutputType<OutType>::T; + + Op op; + explicit ScalarUnaryStatefulTemporal(Op op) : op(std::move(op)) {} + + template <typename Type> + struct ArrayExec { + static Status Exec(const ThisType& functor, KernelContext* ctx, const ArrayData& arg0, + Datum* out) { + const std::string timezone = + std::static_pointer_cast<const TimestampType>(arg0.type)->timezone(); + Status st = Status::OK(); + ArrayData* out_arr = out->mutable_array(); + auto out_data = out_arr->GetMutableValues<OutValue>(1); + + if (timezone.empty()) { + VisitArrayValuesInline<Int64Type>( + arg0, + [&](int64_t v) { + *out_data++ = functor.op.template Call<OutValue>(ctx, v, &st); + }, + [&]() { + // null + ++out_data; + }); + } else { + st = Status::Invalid("Timezone aware timestamps not supported. Timezone found: ", + timezone); + } + return st; + } + }; + + Status Scalar(KernelContext* ctx, const Scalar& arg0, Datum* out) { + const std::string timezone = + std::static_pointer_cast<const TimestampType>(arg0.type)->timezone(); + Status st = Status::OK(); + if (timezone.empty()) { + if (arg0.is_valid) { + int64_t arg0_val = UnboxScalar<Int64Type>::Unbox(arg0); + BoxScalar<OutType>::Box(this->op.template Call<OutValue>(ctx, arg0_val, &st), + out->scalar().get()); + } + } else { + st = Status::Invalid("Timezone aware timestamps not supported. Timezone found: ", + timezone); + } + return st; + } + + Status Exec(KernelContext* ctx, const ExecBatch& batch, Datum* out) { + if (batch[0].kind() == Datum::ARRAY) { + return ArrayExec<OutType>::Exec(*this, ctx, *batch[0].array(), out); + } else { + return Scalar(ctx, *batch[0].scalar(), out); + } + } +}; + +template <typename OutType, typename Op> +struct ScalarUnaryTemporal { + using OutValue = typename GetOutputType<OutType>::T; + + static Status Exec(KernelContext* ctx, const ExecBatch& batch, Datum* out) { + // Seed kernel with dummy state + ScalarUnaryStatefulTemporal<OutType, Op> kernel({}); + return kernel.Exec(ctx, batch, out); + } +}; + +// ---------------------------------------------------------------------- +// Extract year from timestamp + +template <typename Duration> +struct Year { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + return static_cast<T>(static_cast<const int32_t>( + year_month_day(floor<days>(sys_time<Duration>(Duration{arg}))).year())); + } +}; + +// ---------------------------------------------------------------------- +// Extract month from timestamp + +template <typename Duration> +struct Month { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + return static_cast<T>(static_cast<const uint32_t>( + year_month_day(floor<days>(sys_time<Duration>(Duration{arg}))).month())); + } +}; + +// ---------------------------------------------------------------------- +// Extract day from timestamp + +template <typename Duration> +struct Day { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + return static_cast<T>(static_cast<const uint32_t>( + year_month_day(floor<days>(sys_time<Duration>(Duration{arg}))).day())); + } +}; + +// ---------------------------------------------------------------------- +// Extract day of week from timestamp + +template <typename Duration> +struct DayOfWeek { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + return static_cast<T>( + weekday(year_month_day(floor<days>(sys_time<Duration>(Duration{arg})))) + .iso_encoding()); + } +}; + +// ---------------------------------------------------------------------- +// Extract day of year from timestamp + +template <typename Duration> +struct DayOfYear { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + const auto sd = sys_days{floor<days>(Duration{arg})}; + return static_cast<T>((sd - sys_days(year_month_day(sd).year() / jan / 0)).count()); + } +}; + +// ---------------------------------------------------------------------- +// Extract ISO Year values from timestamp + +template <typename Duration> +struct ISOYear { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + return static_cast<T>(static_cast<const int32_t>( + year_month_day{sys_days{floor<days>(Duration{arg})} + days{3}}.year())); + } +}; + +// ---------------------------------------------------------------------- +// Extract ISO week from timestamp + +// Based on +// https://github.com/HowardHinnant/date/blob/6e921e1b1d21e84a5c82416ba7ecd98e33a436d0/include/date/iso_week.h#L1503 +template <typename Duration> +struct ISOWeek { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + const auto dp = sys_days{floor<days>(Duration{arg})}; + auto y = year_month_day{dp + days{3}}.year(); + auto start = sys_days((y - years{1}) / dec / thu[last]) + (mon - thu); + if (dp < start) { + --y; + start = sys_days((y - years{1}) / dec / thu[last]) + (mon - thu); + } + return static_cast<T>(trunc<weeks>(dp - start).count() + 1); + } +}; + +// ---------------------------------------------------------------------- +// Extract day of quarter from timestamp + +template <typename Duration> +struct Quarter { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + const auto ymd = year_month_day(floor<days>(sys_time<Duration>(Duration{arg}))); + return static_cast<T>((static_cast<const uint32_t>(ymd.month()) - 1) / 3 + 1); + } +}; + +// ---------------------------------------------------------------------- +// Extract hour from timestamp + +template <typename Duration> +struct Hour { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + Duration t = Duration{arg}; + return static_cast<T>((t - floor<days>(t)) / std::chrono::hours(1)); + } +}; + +// ---------------------------------------------------------------------- +// Extract minute from timestamp + +template <typename Duration> +struct Minute { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + Duration t = Duration{arg}; + return static_cast<T>((t - floor<std::chrono::hours>(t)) / std::chrono::minutes(1)); + } +}; + +// ---------------------------------------------------------------------- +// Extract second from timestamp + +template <typename Duration> +struct Second { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + Duration t = Duration{arg}; + return static_cast<T>( + std::chrono::duration<double>(t - floor<std::chrono::minutes>(t)).count()); + } +}; + +// ---------------------------------------------------------------------- +// Extract subsecond from timestamp + +template <typename Duration> +struct Subsecond { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + Duration t = Duration{arg}; + return static_cast<T>((t - floor<std::chrono::seconds>(t)) / + std::chrono::nanoseconds(1)); + } +}; + +// ---------------------------------------------------------------------- +// Extract milliseconds from timestamp + +template <typename Duration> +struct Millisecond { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + Duration t = Duration{arg}; + return static_cast<T>( + ((t - floor<std::chrono::seconds>(t)) / std::chrono::milliseconds(1)) % 1000); + } +}; + +// ---------------------------------------------------------------------- +// Extract microseconds from timestamp + +template <typename Duration> +struct Microsecond { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + Duration t = Duration{arg}; + return static_cast<T>( + ((t - floor<std::chrono::seconds>(t)) / std::chrono::microseconds(1)) % 1000); + } +}; + +// ---------------------------------------------------------------------- +// Extract nanoseconds from timestamp + +template <typename Duration> +struct Nanosecond { + template <typename T> + static T Call(KernelContext*, int64_t arg, Status*) { + Duration t = Duration{arg}; + return static_cast<T>( + ((t - floor<std::chrono::seconds>(t)) / std::chrono::nanoseconds(1)) % 1000); + } +}; + +// ---------------------------------------------------------------------- +// Extract ISO calendar values from timestamp + +template <typename Duration, typename OutType> +struct ISOCalendar { + using T = typename OutType::c_type; + + static Status Call(KernelContext* ctx, const Scalar& in, Scalar* out) { + using ScalarType = typename TypeTraits<OutType>::ScalarType; + const auto& out_type = TypeTraits<OutType>::type_singleton(); + + const std::string timezone = + std::static_pointer_cast<const TimestampType>(in.type)->timezone(); + if (!timezone.empty()) { + return Status::Invalid("Timezone aware timestamps not supported. Timezone found: ", + timezone); + } + + if (!in.is_valid) { + out->is_valid = false; + } else { + const std::shared_ptr<DataType> iso_calendar_type = + struct_({field("iso_year", out_type), field("iso_week", out_type), + field("weekday", out_type)}); + + const auto& in_val = internal::UnboxScalar<const TimestampType>::Unbox(in); + const auto dp = sys_days{floor<days>(Duration{in_val})}; + const auto ymd = year_month_day(dp); + auto y = year_month_day{dp + days{3}}.year(); + auto start = sys_days((y - years{1}) / dec / thu[last]) + (mon - thu); + if (dp < start) { + --y; + start = sys_days((y - years{1}) / dec / thu[last]) + (mon - thu); + } + + std::vector<std::shared_ptr<Scalar>> values = { + std::make_shared<ScalarType>(static_cast<T>(static_cast<int32_t>(ymd.year()))), + std::make_shared<ScalarType>( + static_cast<T>(trunc<weeks>(dp - start).count() + 1)), + std::make_shared<ScalarType>(static_cast<T>(weekday(ymd).iso_encoding()))}; + *checked_cast<StructScalar*>(out) = StructScalar(values, iso_calendar_type); + } + return Status::OK(); + } + + static Status Call(KernelContext* ctx, const ArrayData& in, ArrayData* out) { + using BuilderType = typename TypeTraits<OutType>::BuilderType; + const auto& out_type = TypeTraits<OutType>::type_singleton(); + + const std::string timezone = + std::static_pointer_cast<const TimestampType>(in.type)->timezone(); + if (!timezone.empty()) { + return Status::Invalid("Timezone aware timestamps not supported. Timezone found: ", + timezone); + } + + const std::shared_ptr<DataType> iso_calendar_type = + struct_({field("iso_year", out_type), field("iso_week", out_type), + field("weekday", out_type)}); + + std::unique_ptr<ArrayBuilder> array_builder; + RETURN_NOT_OK(MakeBuilder(ctx->memory_pool(), iso_calendar_type, &array_builder)); + StructBuilder* struct_builder = checked_cast<StructBuilder*>(array_builder.get()); + + std::vector<BuilderType*> field_builders; + field_builders.reserve(3); + for (int i = 0; i < 3; i++) { + field_builders.push_back( + checked_cast<BuilderType*>(struct_builder->field_builder(i))); + } + auto visit_null = [&]() { return struct_builder->AppendNull(); }; + auto visit_value = [&](int64_t arg) { + const auto dp = sys_days{floor<days>(Duration{arg})}; + const auto ymd = year_month_day(dp); + auto y = year_month_day{dp + days{3}}.year(); + auto start = sys_days((y - years{1}) / dec / thu[last]) + (mon - thu); + if (dp < start) { + --y; + start = sys_days((y - years{1}) / dec / thu[last]) + (mon - thu); + } + + RETURN_NOT_OK( + field_builders[0]->Append(static_cast<T>(static_cast<int32_t>(ymd.year())))); + RETURN_NOT_OK(field_builders[1]->Append( + static_cast<T>(trunc<weeks>(dp - start).count() + 1))); + RETURN_NOT_OK( + field_builders[2]->Append(static_cast<T>(weekday(ymd).iso_encoding()))); + + return struct_builder->Append(); + }; + RETURN_NOT_OK(VisitArrayDataInline<OutType>(in, visit_value, visit_null)); + + std::shared_ptr<Array> out_array; + RETURN_NOT_OK(struct_builder->Finish(&out_array)); + *out = *std::move(out_array->data()); + + return Status::OK(); + } +}; + +// Generate a kernel given an arithmetic functor +template <template <typename... Args> class KernelGenerator, + template <typename... Args> class Op, typename Duration> +ArrayKernelExec ExecFromOp(detail::GetTypeId get_id) { + switch (get_id.id) { Review comment: I don't think there's a point in trying to control the output type. Also this will generate a lot of additional code. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
