ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

ARROW-14825: [C++] Temporal component extraction function for extracting epiyear #12372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c31c36e
Added Epiyear
rok Feb 9, 2022
a5ec857
Epiyear -> USEpiyear
rok Feb 9, 2022
35d00d0
USEpiyear -> USYear
rok Feb 10, 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
1 change: 1 addition & 0 deletions cpp/src/arrow/compute/api_scalar.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down
14 changes: 14 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down
16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
std::string day_of_year =
"[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
std::string us_year =
"[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
"2008, 2008, 2012, null]";
std::string iso_year =
"[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
"2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
CheckScalarUnary("us_year", unit, sample, int64(), us_year);
CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
ASSERT_RAISES(Invalid,
IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
{"year": 2262, "month": 4, "day": 13}])");
auto day_of_week = "[0, 6]";
auto day_of_year = "[263, 103]";
auto us_year = "[1677, 2262]";
auto iso_year = "[1677, 2262]";
auto iso_week = "[38, 15]";
auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
CheckScalarUnary("us_year", unit, times, int64(), us_year);
CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
std::string is_dst =
"[false, false, false, false, false, false, false, false, false, false, false, "
"false, false, false, false, false, null]";
auto us_year =
"[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
"2008, 2008, 2011, null]";
auto iso_year =
"[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
"2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
CheckScalarUnary("us_year", unit, times, int64(), us_year);
CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
std::string is_dst =
"[false, true, false, false, true, true, true, true, true, true, true, true, "
"true, true, true, true, null]";
auto us_year =
"[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
"2008, 2008, 2012, null]";
auto iso_year =
"[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
"2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
ASSERT_RAISES(Invalid, USYear(timestamp_array));
ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
ASSERT_RAISES(Invalid, Week(timestamp_array));
ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down
42 changes: 42 additions & 0 deletions cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
explicit USYear(const FunctionOptions* options, Localizer&& localizer)
: localizer_(std::move(localizer)) {}

template <typename T, typename Arg0>
T Call(KernelContext*, Arg0 arg, Status*) const {
const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
auto y = year_month_day{t + days{3}}.year();
auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
if (t < start) {
--y;
}
return static_cast<T>(static_cast<int32_t>(y));
}

Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
"cannot be found in the timezone database."),
{"values"}};

const FunctionDoc us_year_doc{
"Extract US epidemiological year number",
("First week of US epidemiological year has the majority (4 or more) of\n"
"it's days in January. Last week of US epidemiological year has the\n"
"year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
"Null values emit null.\n"
"An error is returned if the values have a defined timezone but it\n"
"cannot be found in the timezone database."),
{"values"}};

const FunctionDoc iso_week_doc{
"Extract ISO week of year number",
("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
&iso_year_doc);
DCHECK_OK(registry->AddFunction(std::move(iso_year)));

auto us_year =
UnaryTemporalFactory<USYear, TemporalComponentExtract,
Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
&us_year_doc);
DCHECK_OK(registry->AddFunction(std::move(us_year)));

static const auto default_iso_week_options = WeekOptions::ISODefaults();
auto iso_week =
UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down
2 changes: 2 additions & 0 deletions docs/source/cpp/compute.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down
1 change: 1 addition & 0 deletions docs/source/python/api/compute.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
second
subsecond
us_week
us_year
week
year
year_month_day
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

from

 Closed


ARROW-14825: [C++] Temporal component extraction function for extracting epiyear
#12372
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c31c36e

Added Epiyear


rok Feb 9, 2022
a5ec857

Epiyear -> USEpiyear


rok Feb 9, 2022
35d00d0

USEpiyear -> USYear


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


1 change: 1 addition & 0 deletions
cpp/src/arrow/compute/api_scalar.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down

14 changes: 14 additions & 0 deletions
cpp/src/arrow/compute/api_scalar.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down

16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
 std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
 std::string day_of_year =
 "[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
 std::string us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 std::string iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
 "2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
 CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, sample, int64(), us_year);
 CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
 CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 ASSERT_RAISES(Invalid,
 IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 {"year": 2262, "month": 4, "day": 13}])");
 auto day_of_week = "[0, 6]";
 auto day_of_year = "[263, 103]";
 auto us_year = "[1677, 2262]";
 auto iso_year = "[1677, 2262]";
 auto iso_week = "[38, 15]";
 auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 std::string is_dst =
 "[false, false, false, false, false, false, false, false, false, false, false, "
 "false, false, false, false, false, null]";
 auto us_year =
 "[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2008, 2011, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
 "2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 std::string is_dst =
 "[false, true, false, false, true, true, true, true, true, true, true, true, "
 "true, true, true, true, null]";
 auto us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
 ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
 ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
 ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
 ASSERT_RAISES(Invalid, USYear(timestamp_array));
 ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
 ASSERT_RAISES(Invalid, Week(timestamp_array));
 ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down

42 changes: 42 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
 explicit USYear(const FunctionOptions* options, Localizer&& localizer)
 : localizer_(std::move(localizer)) {}

 template <typename T, typename Arg0>
 T Call(KernelContext*, Arg0 arg, Status*) const {
 const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
 auto y = year_month_day{t + days{3}}.year();
 auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
 if (t < start) {
 --y;
 }
 return static_cast<T>(static_cast<int32_t>(y));
 }

 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc us_year_doc{
 "Extract US epidemiological year number",
 ("First week of US epidemiological year has the majority (4 or more) of\n"
 "it's days in January. Last week of US epidemiological year has the\n"
 "year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
 "Null values emit null.\n"
 "An error is returned if the values have a defined timezone but it\n"
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc iso_week_doc{
 "Extract ISO week of year number",
 ("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
 &iso_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(iso_year)));

 auto us_year =
 UnaryTemporalFactory<USYear, TemporalComponentExtract,
 Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
 &us_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(us_year)));

 static const auto default_iso_week_options = WeekOptions::ISODefaults();
 auto iso_week =
 UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down

1 change: 1 addition & 0 deletions
docs/source/python/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
 second
 subsecond
 us_week
 us_year
 week
 year
 year_month_day
Expand Down

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

Skip to content
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

from

 Closed


ARROW-14825: [C++] Temporal component extraction function for extracting epiyear
#12372
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c31c36e

Added Epiyear


rok Feb 9, 2022
a5ec857

Epiyear -> USEpiyear


rok Feb 9, 2022
35d00d0

USEpiyear -> USYear


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


1 change: 1 addition & 0 deletions
cpp/src/arrow/compute/api_scalar.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down

14 changes: 14 additions & 0 deletions
cpp/src/arrow/compute/api_scalar.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down

16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
 std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
 std::string day_of_year =
 "[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
 std::string us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 std::string iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
 "2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
 CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, sample, int64(), us_year);
 CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
 CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 ASSERT_RAISES(Invalid,
 IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 {"year": 2262, "month": 4, "day": 13}])");
 auto day_of_week = "[0, 6]";
 auto day_of_year = "[263, 103]";
 auto us_year = "[1677, 2262]";
 auto iso_year = "[1677, 2262]";
 auto iso_week = "[38, 15]";
 auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 std::string is_dst =
 "[false, false, false, false, false, false, false, false, false, false, false, "
 "false, false, false, false, false, null]";
 auto us_year =
 "[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2008, 2011, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
 "2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 std::string is_dst =
 "[false, true, false, false, true, true, true, true, true, true, true, true, "
 "true, true, true, true, null]";
 auto us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
 ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
 ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
 ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
 ASSERT_RAISES(Invalid, USYear(timestamp_array));
 ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
 ASSERT_RAISES(Invalid, Week(timestamp_array));
 ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down

42 changes: 42 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
 explicit USYear(const FunctionOptions* options, Localizer&& localizer)
 : localizer_(std::move(localizer)) {}

 template <typename T, typename Arg0>
 T Call(KernelContext*, Arg0 arg, Status*) const {
 const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
 auto y = year_month_day{t + days{3}}.year();
 auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
 if (t < start) {
 --y;
 }
 return static_cast<T>(static_cast<int32_t>(y));
 }

 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc us_year_doc{
 "Extract US epidemiological year number",
 ("First week of US epidemiological year has the majority (4 or more) of\n"
 "it's days in January. Last week of US epidemiological year has the\n"
 "year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
 "Null values emit null.\n"
 "An error is returned if the values have a defined timezone but it\n"
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc iso_week_doc{
 "Extract ISO week of year number",
 ("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
 &iso_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(iso_year)));

 auto us_year =
 UnaryTemporalFactory<USYear, TemporalComponentExtract,
 Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
 &us_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(us_year)));

 static const auto default_iso_week_options = WeekOptions::ISODefaults();
 auto iso_week =
 UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down

1 change: 1 addition & 0 deletions
docs/source/python/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
 second
 subsecond
 us_week
 us_year
 week
 year
 year_month_day
Expand Down

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

Skip to content
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

from

 Closed


ARROW-14825: [C++] Temporal component extraction function for extracting epiyear
#12372
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c31c36e

Added Epiyear


rok Feb 9, 2022
a5ec857

Epiyear -> USEpiyear


rok Feb 9, 2022
35d00d0

USEpiyear -> USYear


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


1 change: 1 addition & 0 deletions
cpp/src/arrow/compute/api_scalar.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down

14 changes: 14 additions & 0 deletions
cpp/src/arrow/compute/api_scalar.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down

16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
 std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
 std::string day_of_year =
 "[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
 std::string us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 std::string iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
 "2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
 CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, sample, int64(), us_year);
 CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
 CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 ASSERT_RAISES(Invalid,
 IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 {"year": 2262, "month": 4, "day": 13}])");
 auto day_of_week = "[0, 6]";
 auto day_of_year = "[263, 103]";
 auto us_year = "[1677, 2262]";
 auto iso_year = "[1677, 2262]";
 auto iso_week = "[38, 15]";
 auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 std::string is_dst =
 "[false, false, false, false, false, false, false, false, false, false, false, "
 "false, false, false, false, false, null]";
 auto us_year =
 "[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2008, 2011, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
 "2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 std::string is_dst =
 "[false, true, false, false, true, true, true, true, true, true, true, true, "
 "true, true, true, true, null]";
 auto us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
 ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
 ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
 ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
 ASSERT_RAISES(Invalid, USYear(timestamp_array));
 ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
 ASSERT_RAISES(Invalid, Week(timestamp_array));
 ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down

42 changes: 42 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
 explicit USYear(const FunctionOptions* options, Localizer&& localizer)
 : localizer_(std::move(localizer)) {}

 template <typename T, typename Arg0>
 T Call(KernelContext*, Arg0 arg, Status*) const {
 const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
 auto y = year_month_day{t + days{3}}.year();
 auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
 if (t < start) {
 --y;
 }
 return static_cast<T>(static_cast<int32_t>(y));
 }

 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc us_year_doc{
 "Extract US epidemiological year number",
 ("First week of US epidemiological year has the majority (4 or more) of\n"
 "it's days in January. Last week of US epidemiological year has the\n"
 "year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
 "Null values emit null.\n"
 "An error is returned if the values have a defined timezone but it\n"
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc iso_week_doc{
 "Extract ISO week of year number",
 ("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
 &iso_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(iso_year)));

 auto us_year =
 UnaryTemporalFactory<USYear, TemporalComponentExtract,
 Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
 &us_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(us_year)));

 static const auto default_iso_week_options = WeekOptions::ISODefaults();
 auto iso_week =
 UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down

1 change: 1 addition & 0 deletions
docs/source/python/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
 second
 subsecond
 us_week
 us_year
 week
 year
 year_month_day
Expand Down

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

Skip to content
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

from

 Closed


ARROW-14825: [C++] Temporal component extraction function for extracting epiyear
#12372
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c31c36e

Added Epiyear


rok Feb 9, 2022
a5ec857

Epiyear -> USEpiyear


rok Feb 9, 2022
35d00d0

USEpiyear -> USYear


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


1 change: 1 addition & 0 deletions
cpp/src/arrow/compute/api_scalar.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down

14 changes: 14 additions & 0 deletions
cpp/src/arrow/compute/api_scalar.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down

16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
 std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
 std::string day_of_year =
 "[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
 std::string us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 std::string iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
 "2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
 CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, sample, int64(), us_year);
 CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
 CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 ASSERT_RAISES(Invalid,
 IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 {"year": 2262, "month": 4, "day": 13}])");
 auto day_of_week = "[0, 6]";
 auto day_of_year = "[263, 103]";
 auto us_year = "[1677, 2262]";
 auto iso_year = "[1677, 2262]";
 auto iso_week = "[38, 15]";
 auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 std::string is_dst =
 "[false, false, false, false, false, false, false, false, false, false, false, "
 "false, false, false, false, false, null]";
 auto us_year =
 "[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2008, 2011, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
 "2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 std::string is_dst =
 "[false, true, false, false, true, true, true, true, true, true, true, true, "
 "true, true, true, true, null]";
 auto us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
 ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
 ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
 ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
 ASSERT_RAISES(Invalid, USYear(timestamp_array));
 ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
 ASSERT_RAISES(Invalid, Week(timestamp_array));
 ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down

42 changes: 42 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
 explicit USYear(const FunctionOptions* options, Localizer&& localizer)
 : localizer_(std::move(localizer)) {}

 template <typename T, typename Arg0>
 T Call(KernelContext*, Arg0 arg, Status*) const {
 const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
 auto y = year_month_day{t + days{3}}.year();
 auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
 if (t < start) {
 --y;
 }
 return static_cast<T>(static_cast<int32_t>(y));
 }

 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc us_year_doc{
 "Extract US epidemiological year number",
 ("First week of US epidemiological year has the majority (4 or more) of\n"
 "it's days in January. Last week of US epidemiological year has the\n"
 "year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
 "Null values emit null.\n"
 "An error is returned if the values have a defined timezone but it\n"
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc iso_week_doc{
 "Extract ISO week of year number",
 ("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
 &iso_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(iso_year)));

 auto us_year =
 UnaryTemporalFactory<USYear, TemporalComponentExtract,
 Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
 &us_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(us_year)));

 static const auto default_iso_week_options = WeekOptions::ISODefaults();
 auto iso_week =
 UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down

1 change: 1 addition & 0 deletions
docs/source/python/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
 second
 subsecond
 us_week
 us_year
 week
 year
 year_month_day
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

from

 Closed


ARROW-14825: [C++] Temporal component extraction function for extracting epiyear
#12372
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c31c36e

Added Epiyear


rok Feb 9, 2022
a5ec857

Epiyear -> USEpiyear


rok Feb 9, 2022
35d00d0

USEpiyear -> USYear


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


1 change: 1 addition & 0 deletions
cpp/src/arrow/compute/api_scalar.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down

14 changes: 14 additions & 0 deletions
cpp/src/arrow/compute/api_scalar.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down

16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
 std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
 std::string day_of_year =
 "[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
 std::string us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 std::string iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
 "2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
 CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, sample, int64(), us_year);
 CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
 CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 ASSERT_RAISES(Invalid,
 IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 {"year": 2262, "month": 4, "day": 13}])");
 auto day_of_week = "[0, 6]";
 auto day_of_year = "[263, 103]";
 auto us_year = "[1677, 2262]";
 auto iso_year = "[1677, 2262]";
 auto iso_week = "[38, 15]";
 auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 std::string is_dst =
 "[false, false, false, false, false, false, false, false, false, false, false, "
 "false, false, false, false, false, null]";
 auto us_year =
 "[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2008, 2011, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
 "2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 std::string is_dst =
 "[false, true, false, false, true, true, true, true, true, true, true, true, "
 "true, true, true, true, null]";
 auto us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
 ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
 ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
 ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
 ASSERT_RAISES(Invalid, USYear(timestamp_array));
 ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
 ASSERT_RAISES(Invalid, Week(timestamp_array));
 ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down

42 changes: 42 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
 explicit USYear(const FunctionOptions* options, Localizer&& localizer)
 : localizer_(std::move(localizer)) {}

 template <typename T, typename Arg0>
 T Call(KernelContext*, Arg0 arg, Status*) const {
 const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
 auto y = year_month_day{t + days{3}}.year();
 auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
 if (t < start) {
 --y;
 }
 return static_cast<T>(static_cast<int32_t>(y));
 }

 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc us_year_doc{
 "Extract US epidemiological year number",
 ("First week of US epidemiological year has the majority (4 or more) of\n"
 "it's days in January. Last week of US epidemiological year has the\n"
 "year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
 "Null values emit null.\n"
 "An error is returned if the values have a defined timezone but it\n"
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc iso_week_doc{
 "Extract ISO week of year number",
 ("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
 &iso_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(iso_year)));

 auto us_year =
 UnaryTemporalFactory<USYear, TemporalComponentExtract,
 Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
 &us_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(us_year)));

 static const auto default_iso_week_options = WeekOptions::ISODefaults();
 auto iso_week =
 UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down

1 change: 1 addition & 0 deletions
docs/source/python/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
 second
 subsecond
 us_week
 us_year
 week
 year
 year_month_day
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

from

 Closed


ARROW-14825: [C++] Temporal component extraction function for extracting epiyear
#12372
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c31c36e

Added Epiyear


rok Feb 9, 2022
a5ec857

Epiyear -> USEpiyear


rok Feb 9, 2022
35d00d0

USEpiyear -> USYear


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


1 change: 1 addition & 0 deletions
cpp/src/arrow/compute/api_scalar.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down

14 changes: 14 additions & 0 deletions
cpp/src/arrow/compute/api_scalar.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down

16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
 std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
 std::string day_of_year =
 "[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
 std::string us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 std::string iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
 "2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
 CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, sample, int64(), us_year);
 CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
 CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 ASSERT_RAISES(Invalid,
 IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 {"year": 2262, "month": 4, "day": 13}])");
 auto day_of_week = "[0, 6]";
 auto day_of_year = "[263, 103]";
 auto us_year = "[1677, 2262]";
 auto iso_year = "[1677, 2262]";
 auto iso_week = "[38, 15]";
 auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 std::string is_dst =
 "[false, false, false, false, false, false, false, false, false, false, false, "
 "false, false, false, false, false, null]";
 auto us_year =
 "[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2008, 2011, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
 "2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 std::string is_dst =
 "[false, true, false, false, true, true, true, true, true, true, true, true, "
 "true, true, true, true, null]";
 auto us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
 ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
 ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
 ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
 ASSERT_RAISES(Invalid, USYear(timestamp_array));
 ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
 ASSERT_RAISES(Invalid, Week(timestamp_array));
 ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down

42 changes: 42 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
 explicit USYear(const FunctionOptions* options, Localizer&& localizer)
 : localizer_(std::move(localizer)) {}

 template <typename T, typename Arg0>
 T Call(KernelContext*, Arg0 arg, Status*) const {
 const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
 auto y = year_month_day{t + days{3}}.year();
 auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
 if (t < start) {
 --y;
 }
 return static_cast<T>(static_cast<int32_t>(y));
 }

 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc us_year_doc{
 "Extract US epidemiological year number",
 ("First week of US epidemiological year has the majority (4 or more) of\n"
 "it's days in January. Last week of US epidemiological year has the\n"
 "year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
 "Null values emit null.\n"
 "An error is returned if the values have a defined timezone but it\n"
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc iso_week_doc{
 "Extract ISO week of year number",
 ("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
 &iso_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(iso_year)));

 auto us_year =
 UnaryTemporalFactory<USYear, TemporalComponentExtract,
 Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
 &us_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(us_year)));

 static const auto default_iso_week_options = WeekOptions::ISODefaults();
 auto iso_week =
 UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down

1 change: 1 addition & 0 deletions
docs/source/python/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
 second
 subsecond
 us_week
 us_year
 week
 year
 year_month_day
Expand Down

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

Skip to content
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear#12372

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

from

 Closed


ARROW-14825: [C++] Temporal component extraction function for extracting epiyear
#12372
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c31c36e

Added Epiyear


rok Feb 9, 2022
a5ec857

Epiyear -> USEpiyear


rok Feb 9, 2022
35d00d0

USEpiyear -> USYear


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


1 change: 1 addition & 0 deletions
cpp/src/arrow/compute/api_scalar.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -786,6 +786,7 @@ SCALAR_EAGER_UNARY(Quarter, "quarter")
SCALAR_EAGER_UNARY(Second, "second")
SCALAR_EAGER_UNARY(Subsecond, "subsecond")
SCALAR_EAGER_UNARY(USWeek, "us_week")
SCALAR_EAGER_UNARY(USYear, "us_year")
SCALAR_EAGER_UNARY(Year, "year")

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
Expand Down

14 changes: 14 additions & 0 deletions
cpp/src/arrow/compute/api_scalar.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1199,6 +1199,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief USYear returns US epidemiological year number for each element of `values`.
/// First week of US epidemiological year has the majority (4 or more) of it's
/// days in January. Last week of US epidemiological year has the year's last
/// Wednesday in it. US epidemiological week starts on Sunday.
///
/// \param[in] values input to extract US epidemiological year from
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 8.0.0
/// \note API not yet finalized
ARROW_EXPORT
Result<Datum> USYear(const Datum& values, ExecContext* ctx = NULLPTR);

/// \brief ISOWeek returns ISO week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
/// ISO week starts on Monday. Year can have 52 or 53 weeks.
Expand Down

16 changes: 16 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@@ -166,6 +166,9 @@ class ScalarTemporalTest : public ::testing::Test {
 std::string day_of_week = "[3, 1, 6, 2, 2, 1, 0, 3, 4, 6, 0, 6, 5, 6, 0, 6, null]";
 std::string day_of_year =
 "[1, 60, 1, 138, 1, 365, 364, 365, 1, 3, 4, 1, 365, 363, 364, 1, null]";
 std::string us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 std::string iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, "
 "2005, 2008, 2009, 2011, null]";
Expand DownExpand Up@@ -411,6 +414,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionAllTemporalTypes) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, sample), year_month_day);
 CheckScalarUnary("day_of_week", unit, sample, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, sample, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, sample, int64(), us_year);
 CheckScalarUnary("iso_year", unit, sample, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, sample, int64(), iso_week);
 CheckScalarUnary("us_week", unit, sample, int64(), us_week);
Expand DownExpand Up@@ -477,6 +481,7 @@ TEST_F(ScalarTemporalTest, TestTemporalComponentExtractionWithDifferentUnits) {
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 ASSERT_RAISES(Invalid,
 IsDaylightSavings(ArrayFromJSON(unit, times_seconds_precision)));
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -505,6 +510,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 {"year": 2262, "month": 4, "day": 13}])");
 auto day_of_week = "[0, 6]";
 auto day_of_year = "[263, 103]";
 auto us_year = "[1677, 2262]";
 auto iso_year = "[1677, 2262]";
 auto iso_week = "[38, 15]";
 auto us_week = "[38, 16]";
Expand All@@ -528,6 +534,7 @@ TEST_F(ScalarTemporalTest, TestOutsideNanosecondRange) {
 CheckScalarUnary("year_month_day", ArrayFromJSON(unit, times), year_month_day);
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -575,6 +582,9 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 std::string is_dst =
 "[false, false, false, false, false, false, false, false, false, false, false, "
 "false, false, false, false, false, null]";
 auto us_year =
 "[1969, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2008, 2011, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2019, 2009, 2009, 2009, 2009, 2005, 2005, "
 "2008, 2008, 2011, null]";
Expand DownExpand Up@@ -610,6 +620,7 @@ TEST_F(ScalarTemporalTest, TestZoned1) {
 CheckScalarUnary("day_of_week", unit, times, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times, int64(), us_week);
Expand DownExpand Up@@ -653,6 +664,9 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 std::string is_dst =
 "[false, true, false, false, true, true, true, true, true, true, true, true, "
 "true, true, true, true, null]";
 auto us_year =
 "[1969, 2000, 1899, 2033, 2020, 2020, 2020, 2009, 2009, 2010, 2010, 2006, 2005, "
 "2008, 2008, 2012, null]";
 auto iso_year =
 "[1970, 2000, 1898, 2033, 2020, 2020, 2020, 2009, 2009, 2009, 2010, 2005, 2005, "
 "2008, 2009, 2011, null]";
Expand DownExpand Up@@ -689,6 +703,7 @@ TEST_F(ScalarTemporalTest, TestZoned2) {
 CheckScalarUnary("day_of_week", unit, times_seconds_precision, int64(), day_of_week);
 CheckScalarUnary("day_of_year", unit, times_seconds_precision, int64(), day_of_year);
 CheckScalarUnary("is_dst", unit, times_seconds_precision, boolean(), is_dst);
 CheckScalarUnary("us_year", unit, times_seconds_precision, int64(), us_year);
 CheckScalarUnary("iso_year", unit, times_seconds_precision, int64(), iso_year);
 CheckScalarUnary("iso_week", unit, times_seconds_precision, int64(), iso_week);
 CheckScalarUnary("us_week", unit, times_seconds_precision, int64(), us_week);
Expand DownExpand Up@@ -721,6 +736,7 @@ TEST_F(ScalarTemporalTest, TestNonexistentTimezone) {
 ASSERT_RAISES(Invalid, DayOfWeek(timestamp_array));
 ASSERT_RAISES(Invalid, DayOfYear(timestamp_array));
 ASSERT_RAISES(Invalid, IsDaylightSavings(timestamp_array));
 ASSERT_RAISES(Invalid, USYear(timestamp_array));
 ASSERT_RAISES(Invalid, ISOYear(timestamp_array));
 ASSERT_RAISES(Invalid, Week(timestamp_array));
 ASSERT_RAISES(Invalid, ISOCalendar(timestamp_array));
Expand Down

42 changes: 42 additions & 0 deletions
cpp/src/arrow/compute/kernels/scalar_temporal_unary.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,32 @@ struct ISOYear {
 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract US epidemiological year values from temporal types
//
// First week of US epidemiological year has the majority (4 or more) of it's
// days in January. Last week of US epidemiological year has the year's last
// Wednesday in it. US epidemiological week starts on Sunday.

template <typename Duration, typename Localizer>
struct USYear {
 explicit USYear(const FunctionOptions* options, Localizer&& localizer)
 : localizer_(std::move(localizer)) {}

 template <typename T, typename Arg0>
 T Call(KernelContext*, Arg0 arg, Status*) const {
 const auto t = floor<days>(localizer_.template ConvertTimePoint<Duration>(arg));
 auto y = year_month_day{t + days{3}}.year();
 auto start = localizer_.ConvertDays((y - years{1}) / dec / wed[last]) + (mon - thu);
 if (t < start) {
 --y;
 }
 return static_cast<T>(static_cast<int32_t>(y));
 }

 Localizer localizer_;
};

// ----------------------------------------------------------------------
// Extract week from temporal types
//
Expand DownExpand Up@@ -1351,6 +1377,16 @@ const FunctionDoc iso_year_doc{
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc us_year_doc{
 "Extract US epidemiological year number",
 ("First week of US epidemiological year has the majority (4 or more) of\n"
 "it's days in January. Last week of US epidemiological year has the\n"
 "year's last Wednesday in it. US epidemiological week starts on Sunday.\n"
 "Null values emit null.\n"
 "An error is returned if the values have a defined timezone but it\n"
 "cannot be found in the timezone database."),
 {"values"}};

const FunctionDoc iso_week_doc{
 "Extract ISO week of year number",
 ("First ISO week has the majority (4 or more) of its days in January.\n"
Expand DownExpand Up@@ -1557,6 +1593,12 @@ void RegisterScalarTemporalUnary(FunctionRegistry* registry) {
 &iso_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(iso_year)));

 auto us_year =
 UnaryTemporalFactory<USYear, TemporalComponentExtract,
 Int64Type>::Make<WithDates, WithTimestamps>("us_year", int64(),
 &us_year_doc);
 DCHECK_OK(registry->AddFunction(std::move(us_year)));

 static const auto default_iso_week_options = WeekOptions::ISODefaults();
 auto iso_week =
 UnaryTemporalFactory<Week, TemporalComponentExtractWeek, Int64Type>::Make<
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1408,6 +1408,8 @@ For timestamps inputs with non-empty timezone, localized timestamp components wi
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_week | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| us_year | Unary | Temporal | Int64 | | \(4) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| week | Unary | Timestamp | Int64 | :struct:`WeekOptions` | \(5) |
+--------------------+------------+-------------------+---------------+----------------------------+-------+
| year | Unary | Temporal | Int64 | | |
Expand Down

1 change: 1 addition & 0 deletions
docs/source/python/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,6 +404,7 @@ Temporal Component Extraction
 second
 subsecond
 us_week
 us_year
 week
 year
 year_month_day
Expand Down