Skip to content

Commit

Permalink
Deprecate cudf::grouped_time_range_rolling_window
Browse files Browse the repository at this point in the history
Since the range-based rolling window APIs were extended to support any
orderable column (rather than just time-based windows), this function
has been a thin forwarding wrapper to
cudf::grouped_range_rolling_window. It could have been deprecated at
the time, but was not. It seems there are no usages outside of the
libcudf test suite.

Partially addresses #13050.
  • Loading branch information
wence- committed Dec 17, 2024
1 parent becfacc commit f5366e5
Show file tree
Hide file tree
Showing 4 changed files with 645 additions and 565 deletions.
11 changes: 9 additions & 2 deletions cpp/include/cudf/rolling.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

#pragma once

#include <cudf/aggregation.hpp>
#include <cudf/rolling/range_window_bounds.hpp>
#include <cudf/types.hpp>
#include <cudf/utilities/export.hpp>
Expand Down Expand Up @@ -322,6 +323,8 @@ std::unique_ptr<column> grouped_rolling_window(
* @brief Applies a grouping-aware, timestamp-based rolling window function to the values in a
* column.
*
* @deprecated Since 25.02, to be removed in 25.04
*
* Like `rolling_window()`, this function aggregates values in a window around each
* element of a specified `input` column. It differs from `rolling_window()` in two respects:
* 1. The elements of the `input` column are grouped into distinct groups (e.g. the result of a
Expand Down Expand Up @@ -403,7 +406,8 @@ std::unique_ptr<column> grouped_rolling_window(
*
* @returns A nullable output column containing the rolling window results
*/
std::unique_ptr<column> grouped_time_range_rolling_window(
[[deprecated("Use cudf::grouped_range_rolling_window instead")]] std::unique_ptr<column>
grouped_time_range_rolling_window(
table_view const& group_keys,
column_view const& timestamp_column,
cudf::order const& timestamp_order,
Expand All @@ -419,6 +423,8 @@ std::unique_ptr<column> grouped_time_range_rolling_window(
* @brief Applies a grouping-aware, timestamp-based rolling window function to the values in a
* column,.
*
* @deprecated Since 25.02, to be removed in 25.04
*
* @details @copydetails grouped_time_range_rolling_window(
* table_view const& group_keys,
* column_view const& timestamp_column,
Expand All @@ -434,7 +440,8 @@ std::unique_ptr<column> grouped_time_range_rolling_window(
* The `preceding_window_in_days` and `following_window_in_days` are specified as a `window_bounds`
* and supports "unbounded" windows, if set to `window_bounds::unbounded()`.
*/
std::unique_ptr<column> grouped_time_range_rolling_window(
[[deprecated("Use cudf::grouped_range_rolling_window instead")]] std::unique_ptr<column>
grouped_time_range_rolling_window(
table_view const& group_keys,
column_view const& timestamp_column,
cudf::order const& timestamp_order,
Expand Down
Loading

0 comments on commit f5366e5

Please sign in to comment.