Uh oh!
There was an error while loading. Please reload this page.
ARROW-13530: [C++] Implement cumulative sum compute function#12460
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -135,6 +135,10 @@ static auto kPartitionNthOptionsType = GetFunctionOptionsType<PartitionNthOption | ||
| static auto kSelectKOptionsType = GetFunctionOptionsType<SelectKOptions>( | ||
| DataMember("k", &SelectKOptions::k), | ||
| DataMember("sort_keys", &SelectKOptions::sort_keys)); | ||
| static auto kCumulativeSumOptionsType = GetFunctionOptionsType<CumulativeSumOptions>( | ||
| DataMember("start", &CumulativeSumOptions::start), | ||
| DataMember("skip_nulls", &CumulativeSumOptions::skip_nulls), | ||
| DataMember("check_overflow", &CumulativeSumOptions::check_overflow)); | ||
| } // namespace | ||
| } // namespace internal | ||
| @@ -176,6 +180,18 @@ SelectKOptions::SelectKOptions(int64_t k, std::vector<SortKey> sort_keys) | ||
| sort_keys(std::move(sort_keys)) {} | ||
| constexpr char SelectKOptions::kTypeName[]; | ||
| CumulativeSumOptions::CumulativeSumOptions(double start, bool skip_nulls, | ||
| bool check_overflow) | ||
| : CumulativeSumOptions(std::make_shared<DoubleScalar>(start), skip_nulls, | ||
| check_overflow) {} | ||
| CumulativeSumOptions::CumulativeSumOptions(std::shared_ptr<Scalar> start, bool skip_nulls, | ||
| bool check_overflow) | ||
| : FunctionOptions(internal::kCumulativeSumOptionsType), | ||
| start(std::move(start)), | ||
| skip_nulls(skip_nulls), | ||
| check_overflow(check_overflow) {} | ||
| constexpr char CumulativeSumOptions::kTypeName[]; | ||
| namespace internal { | ||
| void RegisterVectorOptions(FunctionRegistry* registry) { | ||
| DCHECK_OK(registry->AddFunctionOptionsType(kFilterOptionsType)); | ||
| @@ -185,6 +201,7 @@ void RegisterVectorOptions(FunctionRegistry* registry) { | ||
| DCHECK_OK(registry->AddFunctionOptionsType(kSortOptionsType)); | ||
| DCHECK_OK(registry->AddFunctionOptionsType(kPartitionNthOptionsType)); | ||
| DCHECK_OK(registry->AddFunctionOptionsType(kSelectKOptionsType)); | ||
| DCHECK_OK(registry->AddFunctionOptionsType(kCumulativeSumOptionsType)); | ||
| } | ||
| } // namespace internal | ||
| @@ -325,6 +342,15 @@ Result<std::shared_ptr<Array>> DropNull(const Array& values, ExecContext* ctx) { | ||
| return out.make_array(); | ||
| } | ||
| // ---------------------------------------------------------------------- | ||
| // Cumulative functions | ||
| Result<Datum> CumulativeSum(const Datum& values, const CumulativeSumOptions& options, | ||
| ExecContext* ctx) { | ||
| auto func_name = (options.check_overflow) ? "cumulative_sum_checked" : "cumulative_sum"; | ||
| return CallFunction(func_name, {Datum(values)}, &options, ctx); | ||
JabariBooker marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| } | ||
| // ---------------------------------------------------------------------- | ||
| // Deprecated functions | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -188,6 +188,27 @@ class ARROW_EXPORT PartitionNthOptions : public FunctionOptions { | ||
| NullPlacement null_placement; | ||
| }; | ||
| /// \brief Options for cumulative sum function | ||
| class ARROW_EXPORT CumulativeSumOptions : public FunctionOptions { | ||
| public: | ||
| explicit CumulativeSumOptions(double start = 0, bool skip_nulls = false, | ||
| bool check_overflow = false); | ||
| explicit CumulativeSumOptions(std::shared_ptr<Scalar> start, bool skip_nulls = false, | ||
| bool check_overflow = false); | ||
| static constexpr char const kTypeName[] = "CumulativeSumOptions"; | ||
| static CumulativeSumOptions Defaults() { return CumulativeSumOptions(); } | ||
| /// Optional starting value for cumulative operation computation | ||
| std::shared_ptr<Scalar> start; | ||
| /// If true, nulls in the input are ignored and produce a corresponding null output. | ||
| /// When false, the first null encountered is propagated through the remaining output. | ||
| bool skip_nulls = false; | ||
Member There was a problem hiding this comment. The naming here is not very good because nulls are never skipped. That said, Pandas uses a similar naming and I don't have a better suggestion. @jorisvandenbossche Any opinion? ContributorAuthor There was a problem hiding this comment. This is where I took the naming from actually. | ||
| /// When true, returns an Invalid Status when overflow is detected | ||
| bool check_overflow = false; | ||
Comment on lines
+208
to
+209
Member There was a problem hiding this comment. Since there are two different functions ("cumulative_sum" and "cumulative_sum_checked"), I don't think it makes sense to also have an option for this. Also, it seems actually ignored... ContributorAuthor There was a problem hiding this comment. This is inline with the existing scalar arithmetic functions that uses a | ||
| }; | ||
| /// @} | ||
| /// \brief Filter with a boolean selection filter | ||
| @@ -522,6 +543,12 @@ Result<Datum> DictionaryEncode( | ||
| const DictionaryEncodeOptions& options = DictionaryEncodeOptions::Defaults(), | ||
| ExecContext* ctx = NULLPTR); | ||
| ARROW_EXPORT | ||
| Result<Datum> CumulativeSum( | ||
| const Datum& values, | ||
| const CumulativeSumOptions& options = CumulativeSumOptions::Defaults(), | ||
| ExecContext* ctx = NULLPTR); | ||
| // ---------------------------------------------------------------------- | ||
| // Deprecated functions | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.