edponce commented on code in PR #12460: URL: https://github.com/apache/arrow/pull/12460#discussion_r848235268
########## cpp/src/arrow/compute/kernels/vector_cumulative_ops_test.cc: ########## @@ -0,0 +1,265 @@ +// 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 <memory> +#include <string> +#include <vector> + +#include <gtest/gtest.h> + +#include "arrow/array.h" +#include "arrow/chunked_array.h" +#include "arrow/testing/gtest_util.h" +#include "arrow/testing/util.h" +#include "arrow/type.h" + +#include "arrow/compute/api.h" +#include "arrow/compute/kernels/test_util.h" + +namespace arrow { +namespace compute { + +template <typename T, typename OptionsType> +class TestCumulativeOp : public ::testing::Test { + public: + using ArrowType = T; + using ScalarType = typename TypeTraits<T>::ScalarType; + using CType = typename TypeTraits<T>::CType; + + protected: + std::shared_ptr<DataType> type_singleton() { return default_type_instance<T>(); } + + std::shared_ptr<Array> array(const std::string& values) { + return ArrayFromJSON(type_singleton(), values); + } + + std::shared_ptr<ChunkedArray> chunked_array(const std::vector<std::string>& values) { + return ChunkedArrayFromJSON(type_singleton(), values); + } + + template <typename V = T> + enable_if_t<!is_floating_type<V>::value, void> Assert( + const std::string func, const std::shared_ptr<Array>& input, + const std::shared_ptr<Array>& expected, const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, CallFunction(func, {Datum(input)}, &options)); + + AssertArraysEqual(*expected, *result.make_array(), false, EqualOptions::Defaults()); + } + + template <typename V = T> + enable_if_t<!is_floating_type<V>::value, void> Assert( + const std::string func, const std::shared_ptr<ChunkedArray>& input, + const std::shared_ptr<ChunkedArray>& expected, const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, + CallFunction(func, {Datum(input)}, &options, nullptr)); + + ChunkedArray actual(result.chunks(), this->type_singleton()); + AssertChunkedEqual(*expected, actual); + } + + template <typename V = T> + enable_if_floating_point<V> Assert(const std::string func, + const std::shared_ptr<Array>& input, + const std::shared_ptr<Array>& expected, + const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, CallFunction(func, {Datum(input)}, &options)); + + AssertArraysApproxEqual(*expected, *result.make_array(), false, + EqualOptions::Defaults()); + } + + template <typename V = T> + enable_if_floating_point<V> Assert(const std::string func, + const std::shared_ptr<ChunkedArray>& input, + const std::shared_ptr<ChunkedArray>& expected, + const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, + CallFunction(func, {Datum(input)}, &options, nullptr)); + + ChunkedArray actual(result.chunks(), this->type_singleton()); + AssertChunkedApproxEquivalent(*expected, actual, EqualOptions::Defaults()); + } +}; + +template <typename T> +class TestCumulativeSum : public TestCumulativeOp<T, CumulativeSumOptions> { + public: + using OptionsType = CumulativeSumOptions; + using ArrowType = typename TestCumulativeOp<T, OptionsType>::ArrowType; + using ScalarType = typename TestCumulativeOp<T, OptionsType>::ScalarType; + using CType = typename TestCumulativeOp<T, OptionsType>::CType; + + protected: + template <typename U = T> + enable_if_parameter_free<U, OptionsType> generate_options(CType start = 0, + bool skip_nulls = false, + bool check_overflow = false) { + return OptionsType(std::make_shared<ScalarType>(start), skip_nulls, check_overflow); + } + + template <typename U = T> + enable_if_t<is_time_type<U>::value || is_timestamp_type<U>::value, OptionsType> + generate_options(CType start = 0, bool skip_nulls = false, + bool check_overflow = false) { + TimeUnit::type unit; + switch (ArrowType::type_id) { + case Type::TIME64: + unit = TimeUnit::NANO; + break; + default: + unit = TimeUnit::SECOND; + break; + } + return OptionsType(std::make_shared<ScalarType>(start, unit), skip_nulls, + check_overflow); + } + + void Assert(const std::string& values, const std::string& expected, + const OptionsType& options) { + auto values_arr = TestCumulativeOp<T, OptionsType>::array(values); + auto expected_arr = TestCumulativeOp<T, OptionsType>::array(expected); + auto func_name = options.check_overflow ? "cumulative_sum_checked" : "cumulative_sum"; + TestCumulativeOp<T, OptionsType>::Assert(func_name, values_arr, expected_arr, + options); + } + + void Assert(const std::vector<std::string>& values, + const std::vector<std::string>& expected, const OptionsType& options) { + auto values_arr = TestCumulativeOp<T, OptionsType>::chunked_array(values); + auto expected_arr = TestCumulativeOp<T, OptionsType>::chunked_array(expected); + auto func_name = options.check_overflow ? "cumulative_sum_checked" : "cumulative_sum"; + TestCumulativeOp<T, OptionsType>::Assert(func_name, values_arr, expected_arr, + options); + } +}; + +TYPED_TEST_SUITE(TestCumulativeSum, NumericArrowTypes); + +TYPED_TEST(TestCumulativeSum, NoStartNoSkipNoNulls) { + CumulativeSumOptions options = this->generate_options(); + auto empty = "[]"; + auto values = "[1, 2, 3, 4, 5, 6]"; + auto expected = "[1, 3, 6, 10, 15, 21]"; + std::vector<std::string> chunked_values = {"[1, 2, 3]", "[4, 5, 6]"}; + std::vector<std::string> chunked_expected = {"[1, 3, 6, 10, 15, 21]"}; + + this->Assert(empty, empty, options); + this->Assert(values, expected, options); + this->Assert(chunked_values, chunked_expected, options); +} + +TYPED_TEST(TestCumulativeSum, NoStartNoSkipHasNulls) { + CumulativeSumOptions options = this->generate_options(); + auto one_null = "[null]"; + auto three_null = "[null, null, null]"; Review Comment: Nit: I think you use either `one_null` or `three_null` but not both. Similar for all other cases. ########## cpp/src/arrow/compute/kernels/vector_cumulative_ops_test.cc: ########## @@ -0,0 +1,265 @@ +// 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 <memory> +#include <string> +#include <vector> + +#include <gtest/gtest.h> + +#include "arrow/array.h" +#include "arrow/chunked_array.h" +#include "arrow/testing/gtest_util.h" +#include "arrow/testing/util.h" +#include "arrow/type.h" + +#include "arrow/compute/api.h" +#include "arrow/compute/kernels/test_util.h" + +namespace arrow { +namespace compute { + +template <typename T, typename OptionsType> +class TestCumulativeOp : public ::testing::Test { + public: + using ArrowType = T; + using ScalarType = typename TypeTraits<T>::ScalarType; + using CType = typename TypeTraits<T>::CType; + + protected: + std::shared_ptr<DataType> type_singleton() { return default_type_instance<T>(); } + + std::shared_ptr<Array> array(const std::string& values) { + return ArrayFromJSON(type_singleton(), values); + } + + std::shared_ptr<ChunkedArray> chunked_array(const std::vector<std::string>& values) { + return ChunkedArrayFromJSON(type_singleton(), values); + } + + template <typename V = T> + enable_if_t<!is_floating_type<V>::value, void> Assert( + const std::string func, const std::shared_ptr<Array>& input, + const std::shared_ptr<Array>& expected, const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, CallFunction(func, {Datum(input)}, &options)); + + AssertArraysEqual(*expected, *result.make_array(), false, EqualOptions::Defaults()); + } + + template <typename V = T> + enable_if_t<!is_floating_type<V>::value, void> Assert( + const std::string func, const std::shared_ptr<ChunkedArray>& input, + const std::shared_ptr<ChunkedArray>& expected, const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, + CallFunction(func, {Datum(input)}, &options, nullptr)); + + ChunkedArray actual(result.chunks(), this->type_singleton()); + AssertChunkedEqual(*expected, actual); + } + + template <typename V = T> + enable_if_floating_point<V> Assert(const std::string func, + const std::shared_ptr<Array>& input, + const std::shared_ptr<Array>& expected, + const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, CallFunction(func, {Datum(input)}, &options)); + + AssertArraysApproxEqual(*expected, *result.make_array(), false, + EqualOptions::Defaults()); + } + + template <typename V = T> + enable_if_floating_point<V> Assert(const std::string func, + const std::shared_ptr<ChunkedArray>& input, + const std::shared_ptr<ChunkedArray>& expected, + const OptionsType& options) { + ASSERT_OK_AND_ASSIGN(auto result, + CallFunction(func, {Datum(input)}, &options, nullptr)); + + ChunkedArray actual(result.chunks(), this->type_singleton()); + AssertChunkedApproxEquivalent(*expected, actual, EqualOptions::Defaults()); + } +}; + +template <typename T> +class TestCumulativeSum : public TestCumulativeOp<T, CumulativeSumOptions> { + public: + using OptionsType = CumulativeSumOptions; + using ArrowType = typename TestCumulativeOp<T, OptionsType>::ArrowType; + using ScalarType = typename TestCumulativeOp<T, OptionsType>::ScalarType; + using CType = typename TestCumulativeOp<T, OptionsType>::CType; + + protected: + template <typename U = T> + enable_if_parameter_free<U, OptionsType> generate_options(CType start = 0, + bool skip_nulls = false, + bool check_overflow = false) { + return OptionsType(std::make_shared<ScalarType>(start), skip_nulls, check_overflow); + } + + template <typename U = T> + enable_if_t<is_time_type<U>::value || is_timestamp_type<U>::value, OptionsType> + generate_options(CType start = 0, bool skip_nulls = false, + bool check_overflow = false) { + TimeUnit::type unit; + switch (ArrowType::type_id) { + case Type::TIME64: + unit = TimeUnit::NANO; + break; + default: + unit = TimeUnit::SECOND; + break; + } + return OptionsType(std::make_shared<ScalarType>(start, unit), skip_nulls, + check_overflow); + } + + void Assert(const std::string& values, const std::string& expected, + const OptionsType& options) { + auto values_arr = TestCumulativeOp<T, OptionsType>::array(values); + auto expected_arr = TestCumulativeOp<T, OptionsType>::array(expected); + auto func_name = options.check_overflow ? "cumulative_sum_checked" : "cumulative_sum"; + TestCumulativeOp<T, OptionsType>::Assert(func_name, values_arr, expected_arr, + options); + } + + void Assert(const std::vector<std::string>& values, + const std::vector<std::string>& expected, const OptionsType& options) { + auto values_arr = TestCumulativeOp<T, OptionsType>::chunked_array(values); + auto expected_arr = TestCumulativeOp<T, OptionsType>::chunked_array(expected); + auto func_name = options.check_overflow ? "cumulative_sum_checked" : "cumulative_sum"; + TestCumulativeOp<T, OptionsType>::Assert(func_name, values_arr, expected_arr, + options); + } +}; + +TYPED_TEST_SUITE(TestCumulativeSum, NumericArrowTypes); + +TYPED_TEST(TestCumulativeSum, NoStartNoSkipNoNulls) { + CumulativeSumOptions options = this->generate_options(); + auto empty = "[]"; + auto values = "[1, 2, 3, 4, 5, 6]"; + auto expected = "[1, 3, 6, 10, 15, 21]"; + std::vector<std::string> chunked_values = {"[1, 2, 3]", "[4, 5, 6]"}; + std::vector<std::string> chunked_expected = {"[1, 3, 6, 10, 15, 21]"}; + + this->Assert(empty, empty, options); + this->Assert(values, expected, options); + this->Assert(chunked_values, chunked_expected, options); +} + +TYPED_TEST(TestCumulativeSum, NoStartNoSkipHasNulls) { + CumulativeSumOptions options = this->generate_options(); + auto one_null = "[null]"; + auto three_null = "[null, null, null]"; + auto values = "[1, 2, null, 4, null, 6]"; + auto expected = "[1, 3, null, null, null, null]"; + std::vector<std::string> chunked_values = {"[1, 2, null]", "[4, null, 6]"}; + std::vector<std::string> chunked_expected = {"[1, 3, null, null, null, null]"}; + + this->Assert(one_null, one_null, options); + this->Assert(three_null, three_null, options); + this->Assert(values, expected, options); + this->Assert(chunked_values, chunked_expected, options); +} + +TYPED_TEST(TestCumulativeSum, NoStartDoSkipNoNulls) { + CumulativeSumOptions options = this->generate_options(0, true); + auto empty = "[]"; + auto values = "[1, 2, 3, 4, 5, 6]"; + auto expected = "[1, 3, 6, 10, 15, 21]"; + std::vector<std::string> chunked_values = {"[1, 2, 3]", "[4, 5, 6]"}; + std::vector<std::string> chunked_expected = {"[1, 3, 6, 10, 15, 21]"}; + + this->Assert(empty, empty, options); + this->Assert(values, expected, options); + this->Assert(chunked_values, chunked_expected, options); +} + +TYPED_TEST(TestCumulativeSum, NoStartDoSkipHasNulls) { + CumulativeSumOptions options = this->generate_options(0, true); + auto one_null = "[null]"; + auto three_null = "[null, null, null]"; + auto values = "[1, 2, null, 4, null, 6]"; + auto expected = "[1, 3, null, 7, null, 13]"; + std::vector<std::string> chunked_values = {"[1, 2, null]", "[4, null, 6]"}; + std::vector<std::string> chunked_expected = {"[1, 3, null, 7, null, 13]"}; + + this->Assert(one_null, one_null, options); + this->Assert(three_null, three_null, options); + this->Assert(values, expected, options); + this->Assert(chunked_values, chunked_expected, options); +} + +TYPED_TEST(TestCumulativeSum, HasStartNoSkipNoNulls) { + CumulativeSumOptions options = this->generate_options(10); + auto empty = "[]"; Review Comment: I think you can combine the `NoNulls` and `HasNulls` tests to reduce 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
