Skip to content

ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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 6 commits into from
Closed

ARROW-14097: [C++] subtract(time, duration) -> time kernel #12139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9497377
SubtractTimeAndDuration
rok Jan 13, 2022
fde7ac1
Add ReplaceTemporalTypes
rok Jan 20, 2022
55fce19
Review feedback
rok Jan 28, 2022
7f4a82b
Review feedback
rok Jan 31, 2022
c773e06
review feedback
rok Feb 7, 2022
8ec2e30
Linting issue.
rok Feb 8, 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
19 changes: 19 additions & 0 deletions cpp/src/arrow/compute/kernels/codegen_internal_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
ty = CommonTemporalResolution(args.data(), args.size());
ReplaceTemporalTypes(ty, &args);
AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down
88 changes: 88 additions & 0 deletions cpp/src/arrow/compute/kernels/scalar_arithmetic.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
}
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
template <typename T, typename Arg0, typename Arg1>
static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
Status* st) {
T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
if (result < 0 || multiple <= result) {
*st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
multiple, ") s");
}

@lidavidmlidavidmJan 31, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.

@lidavidmlidavidmJan 31, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?

@rokrokJan 31, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:

if (result < 0) {
result = result % multiple;
}

Correct?

@lidavidmlidavidmJan 31, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.

@rokrokJan 31, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.

@lidavidmlidavidmFeb 2, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.

@lidavidmlidavidmFeb 5, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803

I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.

@lidavidmlidavidmFeb 5, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.

@rokrokFeb 8, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.
I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.

return result;
}

template <typename T, typename Arg0, typename Arg1>
static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
Status* st) {
T result = arrow::internal::SafeSignedSubtract(left, right);
if (result < 0 || multiple <= result) {
*st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
multiple, ") s");
}
return result;
}
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
template <typename T, typename Arg0, typename Arg1>
static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
Status* st) {
T result = 0;
if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
*st = Status::Invalid("overflow");
}
if (result < 0 || multiple <= result) {
*st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
multiple, ") s");
}
return result;
}

template <typename T, typename Arg0, typename Arg1>
static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
Status* st) {
T result = 0;
if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
*st = Status::Invalid("overflow");
}
if (result < 0 || multiple <= result) {
*st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
multiple, ") s");
}
return result;
}
};

struct Multiply {
static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
// Add Op(time32, duration) -> time32
TimeUnit::type unit = TimeUnit::SECOND;
auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
std::move(exec_1)));

unit = TimeUnit::MILLI;
auto exec_2 =
ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
std::move(exec_2)));

// Add Op(time64, duration) -> time64
unit = TimeUnit::MICRO;
auto exec_3 =
ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
std::move(exec_3)));

unit = TimeUnit::NANO;
auto exec_4 =
ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
"Calculate the absolute value of the argument element-wise",
("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
duration(TimeUnit::MILLI), std::move(exec_date_64)));

AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

// ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
}

AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

// ----------------------------------------------------------------------
Expand Down
58 changes: 58 additions & 0 deletions cpp/src/arrow/compute/kernels/scalar_temporal_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
}
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
for (auto op : {"subtract", "subtract_checked"}) {
auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

CheckScalarBinary(op, arr_s2,
ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
arr_s);
CheckScalarBinary(op, arr_ms2,
ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
arr_ms);
CheckScalarBinary(op, arr_us2,
ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
arr_us);
CheckScalarBinary(op, arr_ns2,
ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
arr_ns);

auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

EXPECT_RAISES_WITH_MESSAGE_THAT(
Invalid,
::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

EXPECT_RAISES_WITH_MESSAGE_THAT(
Invalid,
::testing::HasSubstr(
"-1000 is not within the acceptable range of [0, 86400000000000)"),
CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

EXPECT_RAISES_WITH_MESSAGE_THAT(
Invalid,
::testing::HasSubstr(
"86400000001000 is not within the acceptable range of [0, 86400000000000)"),
CallFunction(op,
{ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
}
}

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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ARROW-14097: [C++] subtract(time, duration) -> time kernel by rok · Pull Request #12139 · apache/arrow · GitHub
Skip to content
ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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
6
commits into

from

 Closed


ARROW-14097: [C++] subtract(time, duration) -> time kernel
#12139
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9497377

SubtractTimeAndDuration


rok Jan 13, 2022
fde7ac1

Add ReplaceTemporalTypes


rok Jan 20, 2022
55fce19

Review feedback


rok Jan 28, 2022
7f4a82b

Review feedback


rok Jan 31, 2022
c773e06

review feedback


rok Feb 7, 2022
8ec2e30

Linting issue.


rok Feb 8, 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


19 changes: 19 additions & 0 deletions
cpp/src/arrow/compute/kernels/codegen_internal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

 args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
 ty = CommonTemporalResolution(args.data(), args.size());
 ReplaceTemporalTypes(ty, &args);
 AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
 AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down

88 changes: 88 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:
if (result < 0) {
result = result % multiple;
}

Correct?
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.
@lidavidmlidavidmFeb 2, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803
I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.
@rokrokFeb 8, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.

I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, right);
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

struct Multiply {
 static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
 static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
 return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
 // Add Op(time32, duration) -> time32
 TimeUnit::type unit = TimeUnit::SECOND;
 auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_1)));

 unit = TimeUnit::MILLI;
 auto exec_2 =
 ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_2)));

 // Add Op(time64, duration) -> time64
 unit = TimeUnit::MICRO;
 auto exec_3 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_3)));

 unit = TimeUnit::NANO;
 auto exec_4 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
 "Calculate the absolute value of the argument element-wise",
 ("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
 duration(TimeUnit::MILLI), std::move(exec_date_64)));

 AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

 // ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
 }

 AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

 // ----------------------------------------------------------------------
Expand Down

58 changes: 58 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
 }
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
 for (auto op : {"subtract", "subtract_checked"}) {
 auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
 auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
 auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
 auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
 auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
 auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
 auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
 auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

 CheckScalarBinary(op, arr_s2,
 ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
 arr_s);
 CheckScalarBinary(op, arr_ms2,
 ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
 arr_ms);
 CheckScalarBinary(op, arr_us2,
 ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
 arr_us);
 CheckScalarBinary(op, arr_ns2,
 ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
 arr_ns);

 auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
 auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
 auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
 auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
 auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
 auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
 auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
 CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
 CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
 CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
 CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "-1000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "86400000001000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op,
 {ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
 }
}

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-14097: [C++] subtract(time, duration) -> time kernel by rok · Pull Request #12139 · apache/arrow · GitHub
Skip to content
ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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
6
commits into

from

 Closed


ARROW-14097: [C++] subtract(time, duration) -> time kernel
#12139
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9497377

SubtractTimeAndDuration


rok Jan 13, 2022
fde7ac1

Add ReplaceTemporalTypes


rok Jan 20, 2022
55fce19

Review feedback


rok Jan 28, 2022
7f4a82b

Review feedback


rok Jan 31, 2022
c773e06

review feedback


rok Feb 7, 2022
8ec2e30

Linting issue.


rok Feb 8, 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


19 changes: 19 additions & 0 deletions
cpp/src/arrow/compute/kernels/codegen_internal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

 args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
 ty = CommonTemporalResolution(args.data(), args.size());
 ReplaceTemporalTypes(ty, &args);
 AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
 AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down

88 changes: 88 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:
if (result < 0) {
result = result % multiple;
}

Correct?
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.
@lidavidmlidavidmFeb 2, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803
I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.
@rokrokFeb 8, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.

I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, right);
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

struct Multiply {
 static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
 static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
 return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
 // Add Op(time32, duration) -> time32
 TimeUnit::type unit = TimeUnit::SECOND;
 auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_1)));

 unit = TimeUnit::MILLI;
 auto exec_2 =
 ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_2)));

 // Add Op(time64, duration) -> time64
 unit = TimeUnit::MICRO;
 auto exec_3 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_3)));

 unit = TimeUnit::NANO;
 auto exec_4 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
 "Calculate the absolute value of the argument element-wise",
 ("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
 duration(TimeUnit::MILLI), std::move(exec_date_64)));

 AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

 // ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
 }

 AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

 // ----------------------------------------------------------------------
Expand Down

58 changes: 58 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
 }
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
 for (auto op : {"subtract", "subtract_checked"}) {
 auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
 auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
 auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
 auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
 auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
 auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
 auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
 auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

 CheckScalarBinary(op, arr_s2,
 ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
 arr_s);
 CheckScalarBinary(op, arr_ms2,
 ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
 arr_ms);
 CheckScalarBinary(op, arr_us2,
 ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
 arr_us);
 CheckScalarBinary(op, arr_ns2,
 ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
 arr_ns);

 auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
 auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
 auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
 auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
 auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
 auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
 auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
 CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
 CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
 CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
 CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "-1000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "86400000001000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op,
 {ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
 }
}

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-14097: [C++] subtract(time, duration) -> time kernel by rok · Pull Request #12139 · apache/arrow · GitHub
Skip to content
ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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
6
commits into

from

 Closed


ARROW-14097: [C++] subtract(time, duration) -> time kernel
#12139
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9497377

SubtractTimeAndDuration


rok Jan 13, 2022
fde7ac1

Add ReplaceTemporalTypes


rok Jan 20, 2022
55fce19

Review feedback


rok Jan 28, 2022
7f4a82b

Review feedback


rok Jan 31, 2022
c773e06

review feedback


rok Feb 7, 2022
8ec2e30

Linting issue.


rok Feb 8, 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


19 changes: 19 additions & 0 deletions
cpp/src/arrow/compute/kernels/codegen_internal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

 args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
 ty = CommonTemporalResolution(args.data(), args.size());
 ReplaceTemporalTypes(ty, &args);
 AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
 AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down

88 changes: 88 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:
if (result < 0) {
result = result % multiple;
}

Correct?
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.
@lidavidmlidavidmFeb 2, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803
I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.
@rokrokFeb 8, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.

I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, right);
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

struct Multiply {
 static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
 static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
 return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
 // Add Op(time32, duration) -> time32
 TimeUnit::type unit = TimeUnit::SECOND;
 auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_1)));

 unit = TimeUnit::MILLI;
 auto exec_2 =
 ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_2)));

 // Add Op(time64, duration) -> time64
 unit = TimeUnit::MICRO;
 auto exec_3 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_3)));

 unit = TimeUnit::NANO;
 auto exec_4 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
 "Calculate the absolute value of the argument element-wise",
 ("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
 duration(TimeUnit::MILLI), std::move(exec_date_64)));

 AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

 // ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
 }

 AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

 // ----------------------------------------------------------------------
Expand Down

58 changes: 58 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
 }
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
 for (auto op : {"subtract", "subtract_checked"}) {
 auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
 auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
 auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
 auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
 auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
 auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
 auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
 auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

 CheckScalarBinary(op, arr_s2,
 ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
 arr_s);
 CheckScalarBinary(op, arr_ms2,
 ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
 arr_ms);
 CheckScalarBinary(op, arr_us2,
 ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
 arr_us);
 CheckScalarBinary(op, arr_ns2,
 ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
 arr_ns);

 auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
 auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
 auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
 auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
 auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
 auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
 auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
 CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
 CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
 CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
 CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "-1000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "86400000001000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op,
 {ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
 }
}

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
ARROW-14097: [C++] subtract(time, duration) -> time kernel by rok · Pull Request #12139 · apache/arrow · GitHub
Skip to content
ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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
6
commits into

from

 Closed


ARROW-14097: [C++] subtract(time, duration) -> time kernel
#12139
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9497377

SubtractTimeAndDuration


rok Jan 13, 2022
fde7ac1

Add ReplaceTemporalTypes


rok Jan 20, 2022
55fce19

Review feedback


rok Jan 28, 2022
7f4a82b

Review feedback


rok Jan 31, 2022
c773e06

review feedback


rok Feb 7, 2022
8ec2e30

Linting issue.


rok Feb 8, 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


19 changes: 19 additions & 0 deletions
cpp/src/arrow/compute/kernels/codegen_internal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

 args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
 ty = CommonTemporalResolution(args.data(), args.size());
 ReplaceTemporalTypes(ty, &args);
 AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
 AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down

88 changes: 88 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:
if (result < 0) {
result = result % multiple;
}

Correct?
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.
@lidavidmlidavidmFeb 2, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803
I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.
@rokrokFeb 8, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.

I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, right);
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

struct Multiply {
 static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
 static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
 return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
 // Add Op(time32, duration) -> time32
 TimeUnit::type unit = TimeUnit::SECOND;
 auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_1)));

 unit = TimeUnit::MILLI;
 auto exec_2 =
 ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_2)));

 // Add Op(time64, duration) -> time64
 unit = TimeUnit::MICRO;
 auto exec_3 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_3)));

 unit = TimeUnit::NANO;
 auto exec_4 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
 "Calculate the absolute value of the argument element-wise",
 ("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
 duration(TimeUnit::MILLI), std::move(exec_date_64)));

 AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

 // ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
 }

 AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

 // ----------------------------------------------------------------------
Expand Down

58 changes: 58 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
 }
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
 for (auto op : {"subtract", "subtract_checked"}) {
 auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
 auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
 auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
 auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
 auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
 auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
 auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
 auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

 CheckScalarBinary(op, arr_s2,
 ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
 arr_s);
 CheckScalarBinary(op, arr_ms2,
 ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
 arr_ms);
 CheckScalarBinary(op, arr_us2,
 ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
 arr_us);
 CheckScalarBinary(op, arr_ns2,
 ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
 arr_ns);

 auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
 auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
 auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
 auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
 auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
 auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
 auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
 CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
 CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
 CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
 CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "-1000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "86400000001000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op,
 {ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
 }
}

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-14097: [C++] subtract(time, duration) -> time kernel by rok · Pull Request #12139 · apache/arrow · GitHub
Skip to content
ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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
6
commits into

from

 Closed


ARROW-14097: [C++] subtract(time, duration) -> time kernel
#12139
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9497377

SubtractTimeAndDuration


rok Jan 13, 2022
fde7ac1

Add ReplaceTemporalTypes


rok Jan 20, 2022
55fce19

Review feedback


rok Jan 28, 2022
7f4a82b

Review feedback


rok Jan 31, 2022
c773e06

review feedback


rok Feb 7, 2022
8ec2e30

Linting issue.


rok Feb 8, 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


19 changes: 19 additions & 0 deletions
cpp/src/arrow/compute/kernels/codegen_internal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

 args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
 ty = CommonTemporalResolution(args.data(), args.size());
 ReplaceTemporalTypes(ty, &args);
 AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
 AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down

88 changes: 88 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:
if (result < 0) {
result = result % multiple;
}

Correct?
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.
@lidavidmlidavidmFeb 2, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803
I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.
@rokrokFeb 8, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.

I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, right);
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

struct Multiply {
 static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
 static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
 return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
 // Add Op(time32, duration) -> time32
 TimeUnit::type unit = TimeUnit::SECOND;
 auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_1)));

 unit = TimeUnit::MILLI;
 auto exec_2 =
 ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_2)));

 // Add Op(time64, duration) -> time64
 unit = TimeUnit::MICRO;
 auto exec_3 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_3)));

 unit = TimeUnit::NANO;
 auto exec_4 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
 "Calculate the absolute value of the argument element-wise",
 ("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
 duration(TimeUnit::MILLI), std::move(exec_date_64)));

 AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

 // ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
 }

 AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

 // ----------------------------------------------------------------------
Expand Down

58 changes: 58 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
 }
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
 for (auto op : {"subtract", "subtract_checked"}) {
 auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
 auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
 auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
 auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
 auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
 auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
 auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
 auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

 CheckScalarBinary(op, arr_s2,
 ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
 arr_s);
 CheckScalarBinary(op, arr_ms2,
 ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
 arr_ms);
 CheckScalarBinary(op, arr_us2,
 ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
 arr_us);
 CheckScalarBinary(op, arr_ns2,
 ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
 arr_ns);

 auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
 auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
 auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
 auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
 auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
 auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
 auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
 CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
 CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
 CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
 CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "-1000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "86400000001000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op,
 {ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
 }
}

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-14097: [C++] subtract(time, duration) -> time kernel by rok · Pull Request #12139 · apache/arrow · GitHub
Skip to content
ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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
6
commits into

from

 Closed


ARROW-14097: [C++] subtract(time, duration) -> time kernel
#12139
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9497377

SubtractTimeAndDuration


rok Jan 13, 2022
fde7ac1

Add ReplaceTemporalTypes


rok Jan 20, 2022
55fce19

Review feedback


rok Jan 28, 2022
7f4a82b

Review feedback


rok Jan 31, 2022
c773e06

review feedback


rok Feb 7, 2022
8ec2e30

Linting issue.


rok Feb 8, 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


19 changes: 19 additions & 0 deletions
cpp/src/arrow/compute/kernels/codegen_internal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

 args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
 ty = CommonTemporalResolution(args.data(), args.size());
 ReplaceTemporalTypes(ty, &args);
 AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
 AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down

88 changes: 88 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:
if (result < 0) {
result = result % multiple;
}

Correct?
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.
@lidavidmlidavidmFeb 2, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803
I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.
@rokrokFeb 8, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.

I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, right);
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

struct Multiply {
 static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
 static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
 return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
 // Add Op(time32, duration) -> time32
 TimeUnit::type unit = TimeUnit::SECOND;
 auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_1)));

 unit = TimeUnit::MILLI;
 auto exec_2 =
 ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_2)));

 // Add Op(time64, duration) -> time64
 unit = TimeUnit::MICRO;
 auto exec_3 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_3)));

 unit = TimeUnit::NANO;
 auto exec_4 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
 "Calculate the absolute value of the argument element-wise",
 ("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
 duration(TimeUnit::MILLI), std::move(exec_date_64)));

 AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

 // ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
 }

 AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

 // ----------------------------------------------------------------------
Expand Down

58 changes: 58 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
 }
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
 for (auto op : {"subtract", "subtract_checked"}) {
 auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
 auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
 auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
 auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
 auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
 auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
 auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
 auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

 CheckScalarBinary(op, arr_s2,
 ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
 arr_s);
 CheckScalarBinary(op, arr_ms2,
 ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
 arr_ms);
 CheckScalarBinary(op, arr_us2,
 ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
 arr_us);
 CheckScalarBinary(op, arr_ns2,
 ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
 arr_ns);

 auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
 auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
 auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
 auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
 auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
 auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
 auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
 CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
 CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
 CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
 CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "-1000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "86400000001000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op,
 {ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
 }
}

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
ARROW-14097: [C++] subtract(time, duration) -> time kernel by rok · Pull Request #12139 · apache/arrow · GitHub
Skip to content
ARROW-14097: [C++] subtract(time, duration) -> time kernel#12139

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
6
commits into

from

 Closed


ARROW-14097: [C++] subtract(time, duration) -> time kernel
#12139
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9497377

SubtractTimeAndDuration


rok Jan 13, 2022
fde7ac1

Add ReplaceTemporalTypes


rok Jan 20, 2022
55fce19

Review feedback


rok Jan 28, 2022
7f4a82b

Review feedback


rok Jan 31, 2022
c773e06

review feedback


rok Feb 7, 2022
8ec2e30

Linting issue.


rok Feb 8, 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


19 changes: 19 additions & 0 deletions
cpp/src/arrow/compute/kernels/codegen_internal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,8 +247,27 @@ TEST(TestDispatchBest, ReplaceTemporalTypes) {

 args = {timestamp(TimeUnit::SECOND, "UTC"), timestamp(TimeUnit::SECOND, tz)};
 ty = CommonTemporalResolution(args.data(), args.size());
 ReplaceTemporalTypes(ty, &args);
 AssertTypeEqual(args[0].type, timestamp(TimeUnit::SECOND, "UTC"));
 AssertTypeEqual(args[1].type, timestamp(TimeUnit::SECOND, tz));

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

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

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

} // namespace internal
Expand Down

88 changes: 88 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,62 @@ struct SubtractCheckedDate32 {
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDuration {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, static_cast<T>(right));
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Since we could subtract a negative duration, we should also check if the output is larger than the maximum acceptable value.
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Alternatively - maybe this arithmetic should wrap around? Does that make any sense?
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Huh. I wonder how expected this would be. But you're proposing something like this:
if (result < 0) {
result = result % multiple;
}

Correct?
@lidavidmlidavidmJan 31, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Right. Though, I'm not sure if that really makes any sense to have.
@rokrokJan 31, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

It feels semantically correct but I'm going to check what Pandas and others do to see what conventions are.
@lidavidmlidavidmFeb 2, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I poked around stdlib datetime but it doesn't seem to implement this. However, I still think we need to check whether the result is in range on both ends.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I found this reference: https://bugs.python.org/issue1487389#msg54803
I think raising an error is OK. If we need wrap-around, we can add that as a separate kernel perhaps.
@lidavidmlidavidmFeb 5, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We should still raise an error if the result is >24:00 though.
@rokrokFeb 8, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Thanks for looking into this! Pandas appears delegate time to Python and rather work with timedelta which is like our duration.

I made this raise on time < 0 and time >= 24:00. Lets revisit if/when desired.
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = arrow::internal::SafeSignedSubtract(left, right);
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

template <bool is_32bit, int64_t multiple>
struct SubtractTimeDurationChecked {
 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }

 template <typename T, typename Arg0, typename Arg1>
 static enable_if_t<!is_32bit, T> Call(KernelContext*, Arg0 left, Arg1 right,
 Status* st) {
 T result = 0;
 if (ARROW_PREDICT_FALSE(SubtractWithOverflow(left, static_cast<T>(right), &result))) {
 *st = Status::Invalid("overflow");
 }
 if (result < 0 || multiple <= result) {
 *st = Status::Invalid(result, " is not within the acceptable range of ", "[0, ",
 multiple, ") s");
 }
 return result;
 }
};

struct Multiply {
 static_assert(std::is_same<decltype(int8_t() * int8_t()), int32_t>::value, "");
 static_assert(std::is_same<decltype(uint8_t() * uint8_t()), int32_t>::value, "");
Expand DownExpand Up@@ -2132,6 +2188,34 @@ std::shared_ptr<ScalarFunction> MakeArithmeticFunctionFloatingPointNotNull(
 return func;
}

template <template <bool, int64_t> class Op>
void AddArithmeticFunctionTimeDurations(std::shared_ptr<ScalarFunction> func) {
 // Add Op(time32, duration) -> time32
 TimeUnit::type unit = TimeUnit::SECOND;
 auto exec_1 = ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_1)));

 unit = TimeUnit::MILLI;
 auto exec_2 =
 ScalarBinary<Time32Type, Time32Type, DurationType, Op<true, 86400000>>::Exec;
 DCHECK_OK(func->AddKernel({time32(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_2)));

 // Add Op(time64, duration) -> time64
 unit = TimeUnit::MICRO;
 auto exec_3 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_3)));

 unit = TimeUnit::NANO;
 auto exec_4 =
 ScalarBinary<Time64Type, Time64Type, DurationType, Op<false, 86400000000000>>::Exec;
 DCHECK_OK(func->AddKernel({time64(unit), duration(unit)}, OutputType(FirstType),
 std::move(exec_4)));
}

const FunctionDoc absolute_value_doc{
 "Calculate the absolute value of the argument element-wise",
 ("Results will wrap around on integer overflow.\n"
Expand DownExpand Up@@ -2507,6 +2591,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 DCHECK_OK(subtract->AddKernel({in_type_date_64, in_type_date_64},
 duration(TimeUnit::MILLI), std::move(exec_date_64)));

 AddArithmeticFunctionTimeDurations<SubtractTimeDuration>(subtract);

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

 // ----------------------------------------------------------------------
Expand DownExpand Up@@ -2563,6 +2649,8 @@ void RegisterScalarArithmetic(FunctionRegistry* registry) {
 subtract_checked->AddKernel({in_type, in_type}, duration(unit), std::move(exec)));
 }

 AddArithmeticFunctionTimeDurations<SubtractTimeDurationChecked>(subtract_checked);

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

 // ----------------------------------------------------------------------
Expand Down

58 changes: 58 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1156,6 +1156,64 @@ TEST_F(ScalarTemporalTest, TestTemporalSubtractTime) {
 }
}

TEST_F(ScalarTemporalTest, TestTemporalSubtractTimeAndDuration) {
 for (auto op : {"subtract", "subtract_checked"}) {
 auto arr_s = ArrayFromJSON(time32(TimeUnit::SECOND), times_s);
 auto arr_s2 = ArrayFromJSON(time32(TimeUnit::SECOND), times_s2);
 auto arr_ms = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms);
 auto arr_ms2 = ArrayFromJSON(time32(TimeUnit::MILLI), times_ms2);
 auto arr_us = ArrayFromJSON(time64(TimeUnit::MICRO), times_us);
 auto arr_us2 = ArrayFromJSON(time64(TimeUnit::MICRO), times_us2);
 auto arr_ns = ArrayFromJSON(time64(TimeUnit::NANO), times_ns);
 auto arr_ns2 = ArrayFromJSON(time64(TimeUnit::NANO), times_ns2);

 CheckScalarBinary(op, arr_s2,
 ArrayFromJSON(duration(TimeUnit::SECOND), seconds_between_time),
 arr_s);
 CheckScalarBinary(op, arr_ms2,
 ArrayFromJSON(duration(TimeUnit::MILLI), milliseconds_between_time),
 arr_ms);
 CheckScalarBinary(op, arr_us2,
 ArrayFromJSON(duration(TimeUnit::MICRO), microseconds_between_time),
 arr_us);
 CheckScalarBinary(op, arr_ns2,
 ArrayFromJSON(duration(TimeUnit::NANO), nanoseconds_between_time),
 arr_ns);

 auto seconds_3 = ArrayFromJSON(time32(TimeUnit::SECOND), R"([3, null])");
 auto milliseconds_2k = ArrayFromJSON(duration(TimeUnit::MILLI), R"([2000, null])");
 auto milliseconds_1k = ArrayFromJSON(time32(TimeUnit::MILLI), R"([1000, null])");
 auto nanoseconds_3G = ArrayFromJSON(time64(TimeUnit::NANO), R"([3000000000, null])");
 auto microseconds_2M = ArrayFromJSON(duration(TimeUnit::MICRO), R"([2000000, null])");
 auto nanoseconds_1M = ArrayFromJSON(time64(TimeUnit::NANO), R"([1000000000, null])");
 auto microseconds_1M = ArrayFromJSON(time64(TimeUnit::MICRO), R"([1000000, null])");
 CheckScalarBinary(op, seconds_3, milliseconds_2k, milliseconds_1k);
 CheckScalarBinary(op, nanoseconds_3G, microseconds_2M, nanoseconds_1M);
 CheckScalarBinary(op, seconds_3, microseconds_2M, microseconds_1M);

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr("-1 is not within the acceptable range of [0, 86400)"),
 CallFunction(op, {ArrayFromJSON(time32(TimeUnit::SECOND), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::SECOND), R"([2, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "-1000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op, {ArrayFromJSON(time64(TimeUnit::MICRO), R"([1, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([2000, null])")}));

 EXPECT_RAISES_WITH_MESSAGE_THAT(
 Invalid,
 ::testing::HasSubstr(
 "86400000001000 is not within the acceptable range of [0, 86400000000000)"),
 CallFunction(op,
 {ArrayFromJSON(time64(TimeUnit::MICRO), R"([86400000000, null])"),
 ArrayFromJSON(duration(TimeUnit::NANO), R"([-1000, null])")}));
 }
}

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