Skip to content

ARROW-14101: [C++] multiply(duration, integer) -> duration kernel #12215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rok wants to merge 2 commits into from
Closed

ARROW-14101: [C++] multiply(duration, integer) -> duration kernel #12215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3fa8fe
multiply(duration, integer) -> duration
rok Feb 22, 2022
c797d52
Review feedback
rok Feb 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions cpp/src/arrow/compute/kernels/codegen_internal_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,8 @@ TEST(TestDispatchBest, CommonTemporalResolution) {
ASSERT_EQ(TimeUnit::MILLI, CommonTemporalResolution(args.data(), args.size()));
args = {time64(TimeUnit::MICRO), duration(TimeUnit::NANO)};
ASSERT_EQ(TimeUnit::NANO, CommonTemporalResolution(args.data(), args.size()));
args = {duration(TimeUnit::SECOND), int64()};
ASSERT_EQ(TimeUnit::SECOND, CommonTemporalResolution(args.data(), args.size()));
Comment on lines +205 to +206
Copy link
Member

@pitrou pitrou Feb 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks unexpected to me since int64 is not a temporal at all. @lidavidm What do you think?

Copy link
Member

@lidavidm lidavidm Feb 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is fine, but maybe we need a better name for what this function does.

That said, I don't think this change is needed for this function to work, anyways. There's only a single temporal argument so there isn't really a meaningful common resolution to cast to.

Copy link
Member

@pitrou pitrou Feb 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, the function doesn't seem to have changed :-). It's just the additional test that surprised me (but adding a test for existing behaviour is useful, thank you @rok ).

Copy link
Member Author

@rok rok Feb 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well duration has a unit and int64 is dimensionless. The goal of the function is to find the best common unit and I'd argue it still does.

}

TEST(TestDispatchBest, ReplaceTemporalTypes) {
Expand Down Expand Up @@ -268,6 +270,11 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {
ReplaceTemporalTypes(ty, &args);
AssertTypeEqual(args[0].type, time64(TimeUnit::NANO));
AssertTypeEqual(args[1].type, duration(TimeUnit::NANO));

args = {duration(TimeUnit::SECOND), int64()};
ReplaceTemporalTypes(CommonTemporalResolution(args.data(), args.size()), &args);
AssertTypeEqual(args[0].type, duration(TimeUnit::SECOND));
AssertTypeEqual(args[1].type, int64());
}

} // namespace internal
Expand Down
43 changes: 42 additions & 1 deletion cpp/src/arrow/compute/kernels/scalar_arithmetic.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ namespace internal {

using applicator::ScalarBinary;
using applicator::ScalarBinaryEqualTypes;
using applicator::ScalarBinaryNotNull;
using applicator::ScalarBinaryNotNullEqualTypes;
using applicator::ScalarUnary;
using applicator::ScalarUnaryNotNull;
Expand Down Expand Up @@ -1647,8 +1648,8 @@ ArrayKernelExec ArithmeticExecFromOp(detail::GetTypeId get_id) {
return KernelGenerator<Int32Type, Int32Type, Op>::Exec;
case Type::UINT32:
return KernelGenerator<UInt32Type, UInt32Type, Op>::Exec;
case Type::DURATION:
case Type::INT64:
case Type::DURATION:
case Type::TIMESTAMP:
return KernelGenerator<Int64Type, Int64Type, Op>::Exec;
case Type::UINT64:
Expand Down Expand Up @@ -2802,23 +2803,63 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
// ----------------------------------------------------------------------
auto multiply = MakeArithmeticFunction<Multiply>("multiply", &mul_doc);
AddDecimalBinaryKernels<Multiply>("multiply", multiply.get());

// Add multiply(duration, int64) -> duration
for (auto unit : TimeUnit::values()) {
auto exec1 = ArithmeticExecFromOp<ScalarBinaryEqualTypes, Multiply>(Type::DURATION);
DCHECK_OK(
multiply->AddKernel({duration(unit), int64()}, duration(unit), std::move(exec1)));
auto exec2 = ArithmeticExecFromOp<ScalarBinaryEqualTypes, Multiply>(Type::DURATION);
DCHECK_OK(
multiply->AddKernel({int64(), duration(unit)}, duration(unit), std::move(exec2)));
}

DCHECK_OK(registry->AddFunction(std::move(multiply)));

// ----------------------------------------------------------------------
auto multiply_checked = MakeArithmeticFunctionNotNull<MultiplyChecked>(
"multiply_checked", &mul_checked_doc);
AddDecimalBinaryKernels<MultiplyChecked>("multiply_checked", multiply_checked.get());

// Add multiply_checked(duration, int64) -> duration
for (auto unit : TimeUnit::values()) {
auto exec1 =
ArithmeticExecFromOp<ScalarBinaryEqualTypes, MultiplyChecked>(Type::DURATION);
DCHECK_OK(multiply_checked->AddKernel({duration(unit), int64()}, duration(unit),
std::move(exec1)));
auto exec2 =
ArithmeticExecFromOp<ScalarBinaryEqualTypes, MultiplyChecked>(Type::DURATION);
DCHECK_OK(multiply_checked->AddKernel({int64(), duration(unit)}, duration(unit),
std::move(exec2)));
}

DCHECK_OK(registry->AddFunction(std::move(multiply_checked)));

// ----------------------------------------------------------------------
auto divide = MakeArithmeticFunctionNotNull<Divide>("divide", &div_doc);
AddDecimalBinaryKernels<Divide>("divide", divide.get());

// Add divide(duration, int64) -> duration
for (auto unit : TimeUnit::values()) {
auto exec = ScalarBinaryNotNull<DurationType, DurationType, Int64Type, Divide>::Exec;
DCHECK_OK(
divide->AddKernel({duration(unit), int64()}, duration(unit), std::move(exec)));
}
DCHECK_OK(registry->AddFunction(std::move(divide)));

// ----------------------------------------------------------------------
auto divide_checked =
MakeArithmeticFunctionNotNull<DivideChecked>("divide_checked", &div_checked_doc);
AddDecimalBinaryKernels<DivideChecked>("divide_checked", divide_checked.get());

// Add divide_checked(duration, int64) -> duration
for (auto unit : TimeUnit::values()) {
auto exec =
ScalarBinaryNotNull<DurationType, DurationType, Int64Type, DivideChecked>::Exec;
DCHECK_OK(divide_checked->AddKernel({duration(unit), int64()}, duration(unit),
std::move(exec)));
}

DCHECK_OK(registry->AddFunction(std::move(divide_checked)));

// ----------------------------------------------------------------------
Expand Down
44 changes: 44 additions & 0 deletions cpp/src/arrow/compute/kernels/scalar_temporal_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1455,6 +1455,50 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractDuration) {
}
}

TEST_F(ScalarTemporalTest, TestTemporalMultiplyDuration) {
std::shared_ptr<Array> max_array;
auto max = std::numeric_limits<int64_t>::max();
ArrayFromVector<Int64Type, int64_t>({max, max, max, max, max}, &max_array);

for (auto u : TimeUnit::values()) {
auto unit = duration(u);
auto durations = ArrayFromJSON(unit, R"([0, -1, 2, 6, null])");
auto multipliers = ArrayFromJSON(int64(), R"([0, 3, 2, 7, null])");
auto durations_multiplied = ArrayFromJSON(unit, R"([0, -3, 4, 42, null])");

CheckScalarBinary("multiply", durations, multipliers, durations_multiplied);
CheckScalarBinary("multiply", multipliers, durations, durations_multiplied);
CheckScalarBinary("multiply_checked", durations, multipliers, durations_multiplied);
CheckScalarBinary("multiply_checked", multipliers, durations, durations_multiplied);

EXPECT_RAISES_WITH_MESSAGE_THAT(
Invalid, ::testing::HasSubstr("Invalid: overflow"),
CallFunction("multiply_checked", {durations, max_array}));
EXPECT_RAISES_WITH_MESSAGE_THAT(
Invalid, ::testing::HasSubstr("Invalid: overflow"),
CallFunction("multiply_checked", {max_array, durations}));
}
}

TEST_F(ScalarTemporalTest, TestTemporalDivideDuration) {
for (auto u : TimeUnit::values()) {
auto unit = duration(u);
auto divided_durations = ArrayFromJSON(unit, R"([0, -1, -2, 6, null])");
auto divisors = ArrayFromJSON(int64(), R"([3, 3, -2, 7, null])");
auto durations = ArrayFromJSON(unit, R"([1, -3, 4, 42, null])");
auto zeros = ArrayFromJSON(int64(), R"([0, 0, 0, 0, null])");
CheckScalarBinary("divide", durations, divisors, divided_durations);
CheckScalarBinary("divide_checked", durations, divisors, divided_durations);
Copy link
Member

@pitrou pitrou Feb 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also check that division by zero raises?

Copy link
Member Author

@rok rok Feb 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.


EXPECT_RAISES_WITH_MESSAGE_THAT(Invalid,
::testing::HasSubstr("Invalid: divide by zero"),
CallFunction("divide", {durations, zeros}));
EXPECT_RAISES_WITH_MESSAGE_THAT(Invalid,
::testing::HasSubstr("Invalid: divide by zero"),
CallFunction("divide_checked", {durations, zeros}));
}
}

TEST_F(ScalarTemporalTest, TestTemporalDifferenceWeeks) {
auto raw_days = ArrayFromJSON(timestamp(TimeUnit::SECOND), R"([
"2021-08-09", "2021-08-10", "2021-08-11", "2021-08-12", "2021-08-13", "2021-08-14", "2021-08-15",
Expand Down
8 changes: 4 additions & 4 deletions docs/source/cpp/compute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,13 +441,13 @@ Mixed time resolution temporal inputs will be cast to finest input resolution.
+------------------+--------+------------------+----------------------+-------+
| add_checked | Binary | Numeric/Temporal | Numeric/Temporal | \(1) |
+------------------+--------+------------------+----------------------+-------+
| divide | Binary | Numeric | Numeric | \(1) |
| divide | Binary | Numeric/Temporal | Numeric/Temporal | \(1) |
+------------------+--------+------------------+----------------------+-------+
| divide_checked | Binary | Numeric | Numeric | \(1) |
| divide_checked | Binary | Numeric/Temporal | Numeric/Temporal | \(1) |
+------------------+--------+------------------+----------------------+-------+
| multiply | Binary | Numeric | Numeric | \(1) |
| multiply | Binary | Numeric/Temporal | Numeric/Temporal | \(1) |
+------------------+--------+------------------+----------------------+-------+
| multiply_checked | Binary | Numeric | Numeric | \(1) |
| multiply_checked | Binary | Numeric/Temporal | Numeric/Temporal | \(1) |
+------------------+--------+------------------+----------------------+-------+
| negate | Unary | Numeric | Numeric | |
+------------------+--------+------------------+----------------------+-------+
Expand Down