Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading
, '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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions cpp/src/arrow/compute/api_scalar.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,44 @@ struct EnumTraits<compute::CompareOperator>
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Ambiguous>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Ambiguous,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST,
compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Ambiguous"; }
static std::string value_name(compute::AssumeTimezoneOptions::Ambiguous value) {
switch (value) {
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE:
return "AMBIGUOUS_RAISE";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_EARLIEST:
return "AMBIGUOUS_EARLIEST";
case compute::AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_LATEST:
return "AMBIGUOUS_LATEST";
}
return "<INVALID>";
}
};
template <>
struct EnumTraits<compute::AssumeTimezoneOptions::Nonexistent>
: BasicEnumTraits<compute::AssumeTimezoneOptions::Nonexistent,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST,
compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST> {
static std::string name() { return "AssumeTimezoneOptions::Nonexistent"; }
static std::string value_name(compute::AssumeTimezoneOptions::Nonexistent value) {
switch (value) {
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE:
return "NONEXISTENT_RAISE";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_EARLIEST:
return "NONEXISTENT_EARLIEST";
case compute::AssumeTimezoneOptions::Nonexistent::NONEXISTENT_LATEST:
return "NONEXISTENT_LATEST";
}
return "<INVALID>";
}
};
} // namespace internal

namespace compute {
Expand DownExpand Up@@ -147,6 +185,10 @@ static auto kStrptimeOptionsType = GetFunctionOptionsType<StrptimeOptions>(
DataMember("unit", &StrptimeOptions::unit));
static auto kStrftimeOptionsType = GetFunctionOptionsType<StrftimeOptions>(
DataMember("format", &StrftimeOptions::format));
static auto kAssumeTimezoneOptionsType = GetFunctionOptionsType<AssumeTimezoneOptions>(
DataMember("timezone", &AssumeTimezoneOptions::timezone),
DataMember("ambiguous", &AssumeTimezoneOptions::ambiguous),
DataMember("nonexistent", &AssumeTimezoneOptions::nonexistent));
static auto kPadOptionsType = GetFunctionOptionsType<PadOptions>(
DataMember("width", &PadOptions::width), DataMember("padding", &PadOptions::padding));
static auto kTrimOptionsType = GetFunctionOptionsType<TrimOptions>(
Expand DownExpand Up@@ -250,6 +292,15 @@ StrftimeOptions::StrftimeOptions() : StrftimeOptions(kDefaultFormat) {}
constexpr char StrftimeOptions::kTypeName[];
constexpr const char* StrftimeOptions::kDefaultFormat;

AssumeTimezoneOptions::AssumeTimezoneOptions(std::string timezone, Ambiguous ambiguous,
Nonexistent nonexistent)
: FunctionOptions(internal::kAssumeTimezoneOptionsType),
timezone(std::move(timezone)),
ambiguous(ambiguous),
nonexistent(nonexistent) {}
AssumeTimezoneOptions::AssumeTimezoneOptions() : AssumeTimezoneOptions("UTC") {}
constexpr char AssumeTimezoneOptions::kTypeName[];

PadOptions::PadOptions(int64_t width, std::string padding)
: FunctionOptions(internal::kPadOptionsType),
width(width),
Expand DownExpand Up@@ -311,6 +362,7 @@ void RegisterScalarOptions(FunctionRegistry* registry) {
DCHECK_OK(registry->AddFunctionOptionsType(kSetLookupOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrptimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kStrftimeOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kAssumeTimezoneOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kPadOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kTrimOptionsType));
DCHECK_OK(registry->AddFunctionOptionsType(kSliceOptionsType));
Expand DownExpand Up@@ -512,6 +564,11 @@ Result<Datum> DayOfWeek(const Datum& arg, DayOfWeekOptions options, ExecContext*
return CallFunction("day_of_week", {arg}, &options, ctx);
}

Result<Datum> AssumeTimezone(const Datum& arg, AssumeTimezoneOptions options,
ExecContext* ctx) {
return CallFunction("assume_timezone", {arg}, &options, ctx);
}

Result<Datum> Strftime(const Datum& arg, StrftimeOptions options, ExecContext* ctx) {
return CallFunction("strftime", {arg}, &options, ctx);
}
Expand Down
51 changes: 51 additions & 0 deletions cpp/src/arrow/compute/api_scalar.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@
#include "arrow/result.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
#include "arrow/vendored/datetime.h"

namespace arrow {
namespace compute {
Expand DownExpand Up@@ -278,6 +279,40 @@ struct ARROW_EXPORT DayOfWeekOptions : public FunctionOptions {
uint32_t week_start;
};

/// Used to control timestamp timezone conversion and handling ambiguous/nonexistent
/// times.
struct ARROW_EXPORT AssumeTimezoneOptions : public FunctionOptions {
public:
/// \brief How to interpret ambiguous local times that can be interpreted as
/// multiple instants (normally two) due to DST shifts.
///
/// AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations.
/// AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations.
enum Ambiguous { AMBIGUOUS_RAISE, AMBIGUOUS_EARLIEST, AMBIGUOUS_LATEST };

/// \brief How to handle local times that do not exist due to DST shifts.
///
/// NONEXISTENT_EARLIEST emits the instant "just before" the DST shift instant
/// in the given timestamp precision (for example, for a nanoseconds precision
/// timestamp, this is one nanosecond before the DST shift instant).
/// NONEXISTENT_LATEST emits the DST shift instant.
enum Nonexistent { NONEXISTENT_RAISE, NONEXISTENT_EARLIEST, NONEXISTENT_LATEST };
Comment thread
pitrou marked this conversation as resolved.
Outdated

explicit AssumeTimezoneOptions(std::string timezone,
Ambiguous ambiguous = AMBIGUOUS_RAISE,
Nonexistent nonexistent = NONEXISTENT_RAISE);
AssumeTimezoneOptions();
constexpr static char const kTypeName[] = "AssumeTimezoneOptions";

/// Timezone to convert timestamps from
std::string timezone;

/// How to interpret ambiguous local times (due to DST shifts)
Ambiguous ambiguous;
/// How to interpret non-existent local times (due to DST shifts)
Nonexistent nonexistent;
};

/// @}

/// \brief Get the absolute value of a value.
Expand DownExpand Up@@ -1025,5 +1060,21 @@ ARROW_EXPORT Result<Datum> Subsecond(const Datum& values, ExecContext* ctx = NUL
ARROW_EXPORT Result<Datum> Strftime(const Datum& values, StrftimeOptions options,
ExecContext* ctx = NULLPTR);

/// \brief Converts timestamps from local timestamp without a timezone to a timestamp with
/// timezone, interpreting the local timestamp as being in the specified timezone for each
/// element of `values`
///
/// \param[in] values input to convert
/// \param[in] options for setting source timezone, exception and ambiguous timestamp
/// handling.
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
/// \since 6.0.0
/// \note API not yet finalized
ARROW_EXPORT Result<Datum> AssumeTimezone(const Datum& values,
AssumeTimezoneOptions options,
ExecContext* ctx = NULLPTR);

} // namespace compute
} // namespace arrow
12 changes: 9 additions & 3 deletions cpp/src/arrow/compute/function_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,18 @@
// specific language governing permissions and limitations
// under the License.

#include "arrow/compute/function.h"

#include <gtest/gtest.h>

#include <memory>
#include <string>
#include <vector>

#include <gtest/gtest.h>

#include "arrow/compute/api_aggregate.h"
#include "arrow/compute/api_scalar.h"
#include "arrow/compute/api_vector.h"
#include "arrow/compute/cast.h"
#include "arrow/compute/function.h"
#include "arrow/compute/kernel.h"
#include "arrow/datum.h"
#include "arrow/status.h"
Expand DownExpand Up@@ -80,6 +81,11 @@ TEST(FunctionOptions, Equality) {
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::MILLI));
options.emplace_back(new StrptimeOptions("%Y", TimeUnit::type::NANO));
options.emplace_back(new StrftimeOptions("%Y-%m-%dT%H:%M:%SZ", "C"));
#ifndef _WIN32
options.emplace_back(new AssumeTimezoneOptions(
"Europe/Amsterdam", AssumeTimezoneOptions::Ambiguous::AMBIGUOUS_RAISE,
AssumeTimezoneOptions::Nonexistent::NONEXISTENT_RAISE));
#endif
options.emplace_back(new PadOptions(5, " "));
options.emplace_back(new PadOptions(10, "A"));
options.emplace_back(new TrimOptions(" "));
Expand Down
11 changes: 7 additions & 4 deletions cpp/src/arrow/compute/kernel.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,9 +290,11 @@ class ARROW_EXPORT OutputType {
enum ResolveKind { FIXED, COMPUTED };

/// Type resolution function. Given input types and shapes, return output
/// type and shape. This function SHOULD _not_ be used to check for arity,
/// that is to be performed one or more layers above. May make use of kernel
/// state to know what type to output in some cases.
/// type and shape. This function MAY may use the kernel state to decide
/// the output type based on the functionoptions.
///
/// This function SHOULD _not_ be used to check for arity, that is to be
/// performed one or more layers above.
using Resolver =
std::function<Result<ValueDescr>(KernelContext*, const std::vector<ValueDescr>&)>;

Expand All@@ -304,7 +306,8 @@ class ARROW_EXPORT OutputType {
/// \brief Output the exact type and shape provided by a ValueDescr
OutputType(ValueDescr descr); // NOLINT implicit construction

explicit OutputType(Resolver resolver)
/// \brief Output a computed type depending on actual input types
OutputType(Resolver resolver) // NOLINT implicit construction
: kind_(COMPUTED), resolver_(std::move(resolver)) {}

OutputType(const OutputType& other) {
Expand Down
Loading