JabariBooker commented on code in PR #12460: URL: https://github.com/apache/arrow/pull/12460#discussion_r858882569
########## cpp/src/arrow/compute/kernels/vector_cumulative_ops.cc: ########## @@ -0,0 +1,212 @@ +// 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/array/array_base.h" +#include "arrow/array/builder_primitive.h" +#include "arrow/compute/api_scalar.h" +#include "arrow/compute/api_vector.h" +#include "arrow/compute/cast.h" +#include "arrow/compute/kernels/base_arithmetic_internal.h" +#include "arrow/compute/kernels/codegen_internal.h" +#include "arrow/compute/kernels/common.h" +#include "arrow/result.h" +#include "arrow/util/bit_util.h" +#include "arrow/visit_type_inline.h" + +namespace arrow { +namespace compute { +namespace internal { +namespace { +template <typename OptionsType> +struct CumulativeOptionsWrapper : public OptionsWrapper<OptionsType> { + using State = CumulativeOptionsWrapper<OptionsType>; + + explicit CumulativeOptionsWrapper(OptionsType options) + : OptionsWrapper<OptionsType>(std::move(options)) {} + + static Result<std::unique_ptr<KernelState>> Init(KernelContext* ctx, + const KernelInitArgs& args) { + auto options = static_cast<const OptionsType*>(args.options); + if (!options) { + return Status::Invalid( + "Attempted to initialize KernelState from null FunctionOptions"); + } + + const auto& start = options->start; + if (!start || !start->is_valid) { + return Status::Invalid("Cumulative `start` option must be non-null and valid"); + } + + // Ensure `start` option matches input type + if (!start->type->Equals(args.inputs[0].type)) { + ARROW_ASSIGN_OR_RAISE(auto casted_start, + Cast(Datum(start), args.inputs[0].type, CastOptions::Safe(), + ctx->exec_context())); + auto new_options = OptionsType(casted_start.scalar(), options->skip_nulls); + return ::arrow::internal::make_unique<State>(new_options); + } + return ::arrow::internal::make_unique<State>(*options); + } +}; + +// The driver kernel for all cumulative compute functions. Op is a compute kernel +// representing any binary associative operation (add, product, min, max, etc.) and +// OptionsType the options type corresponding to Op. ArgType and OutType are the input +// and output types, which will normally be the same (e.g. the cumulative sum of an array +// of Int64Type will result in an array of Int64Type). +template <typename OutType, typename ArgType, typename Op, typename OptionsType> +struct CumulativeGeneric { + using OutValue = typename GetOutputType<OutType>::T; + using ArgValue = typename GetViewType<ArgType>::T; + + static Status Exec(KernelContext* ctx, const ExecBatch& batch, Datum* out) { + const auto& options = CumulativeOptionsWrapper<OptionsType>::Get(ctx); + auto start = UnboxScalar<OutType>::Unbox(*(options.start)); + auto skip_nulls = options.skip_nulls; + bool encountered_null = false; + + std::shared_ptr<ArrayData> out_arr; + NumericBuilder<OutType> builder; + + switch (batch[0].kind()) { + case Datum::SCALAR: { + auto in_value = UnboxScalar<OutType>::Unbox(*(batch[0].scalar())); + RETURN_NOT_OK(builder.Append(start + in_value)); + break; + } + case Datum::ARRAY: { + auto input = batch[0].array(); + + RETURN_NOT_OK(Call(ctx, *input, builder, &start, skip_nulls, &encountered_null)); + break; + } + case Datum::CHUNKED_ARRAY: { + const auto& input = batch[0].chunked_array(); + + for (const auto& chunk : input->chunks()) { + RETURN_NOT_OK( + Call(ctx, *chunk->data(), builder, &start, skip_nulls, &encountered_null)); + } + break; + } + default: + return Status::NotImplemented( + "Unsupported input type for function 'cumulative_<operator>': ", + batch[0].ToString()); + } + + RETURN_NOT_OK(builder.FinishInternal(&out_arr)); + out->value = std::move(out_arr); + return Status::OK(); + } + + static Status Call(KernelContext* ctx, const ArrayData& input, + NumericBuilder<OutType>& builder, ArgValue* accumulator, + bool skip_nulls, bool* encountered_null) { + Status st = Status::OK(); + ArgValue accumulator_tmp = *accumulator; + bool encountered_null_tmp = *encountered_null; + + auto null_func = [&]() { + st &= builder.AppendNull(); + encountered_null_tmp = true; + }; + + if (skip_nulls || (input.GetNullCount() == 0 && !encountered_null_tmp)) { + VisitArrayValuesInline<ArgType>( + input, + [&](ArgValue v) { + accumulator_tmp = Op::template Call<OutValue, ArgValue, ArgValue>( + ctx, v, accumulator_tmp, &st); + st &= builder.Append(accumulator_tmp); + }, + null_func); + } else { + VisitArrayValuesInline<ArgType>( + input, + [&](ArgValue v) { + if (encountered_null_tmp) { + st &= builder.AppendNull(); + } else { + accumulator_tmp = Op::template Call<OutValue, ArgValue, ArgValue>( + ctx, v, accumulator_tmp, &st); + st &= builder.Append(accumulator_tmp); + } + }, + null_func); + } + + *accumulator = accumulator_tmp; + *encountered_null = encountered_null_tmp; + return st; + } +}; + +const FunctionDoc cumulative_sum_doc{ + "Compute the cumulative sum over an array/chunked array of numbers", + ("`values` must be an array/chunked array of numeric type values.\n" Review Comment: Forgot about this, thanks -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
