cudf::range_window_bounds 结构体参考

窗口边界大小的抽象，用于 grouped_range_rolling_window()。 更多...

#include <range__window__bounds.hpp>

公有类型
enum class	extent_type : int32_t { CURRENT_ROW = 0 , BOUNDED , UNBOUNDED }
	range_window_bounds 的类型。 更多...

公有成员函数
bool	is_current_row () const
	窗口是否限定在当前行。 更多...
bool	is_unbounded () const
	窗口是否是无界的。 更多...
scalar const &	range_scalar () const
	返回边界的底层标量值。 更多...
	range_window_bounds (range_window_bounds const &)=default
	复制构造函数。

静态公有成员函数
static range_window_bounds	get (scalar const &boundary, rmm::cuda_stream_view stream=cudf::get_default_stream())
	构建有界窗口边界的工厂方法。 更多...
static range_window_bounds	current_row (data_type type, rmm::cuda_stream_view stream=cudf::get_default_stream())
	构建限制在当前行值的窗口边界的工厂方法。 更多...
static range_window_bounds	unbounded (data_type type, rmm::cuda_stream_view stream=cudf::get_default_stream())
	构建无界窗口边界的工厂方法。 更多...

详细描述

窗口边界大小的抽象，用于 grouped_range_rolling_window()。

类似于 window_bounds 在 grouped_rolling_window() 中的作用，range_window_bounds 表示用于 grouped_range_rolling_window() 的窗口边界。窗口可以指定为以下形式之一：

1. 固定宽度的数值标量值。例如：a) 一个 DURATION_DAYS 标量，用于 TIMESTAMP_DAYS 排序（orderby）列 b) 一个 INT32 标量，用于 INT32 排序（orderby）列
2. "unbounded"（无界），表示边界延伸到组中的第一行/最后一行。
3. "current row"（当前行），表示边界结束于组中与当前行值匹配的第一行/最后一行。

定义于文件 range_window_bounds.hpp 的第 44 行。

成员枚举文档

extent_type

enum cudf::range_window_bounds::extent_type : int32_t

强类型

range_window_bounds 的类型。

枚举成员
BOUNDED	边界定义为与当前行匹配的第一行/最后一行。
UNBOUNDED	边界延伸到整个组中的第一行/最后一行。 边界定义为落在距当前行指定范围内的第一行/最后一行。

定义于文件 range_window_bounds.hpp 的第 49 行。

成员函数文档

current_row()

static range_window_bounds cudf::range_window_bounds::current_row ( data_type  类型, rmm::cuda_stream_view  流 = cudf::get_default_stream()  )

static

构建限制在当前行值的窗口边界的工厂方法。

参数

类型	窗口边界的数据类型
流	用于设备内存操作和内核启动的 CUDA 流

返回

一个“当前行”窗口边界对象

get()

static range_window_bounds cudf::range_window_bounds::get ( scalar const &  边界, rmm::cuda_stream_view  流 = cudf::get_default_stream()  )

static

构建有界窗口边界的工厂方法。

参数

边界	有限窗口边界
流	用于设备内存操作和内核启动的 CUDA 流

返回

一个有界窗口边界对象

is_current_row()

bool cudf::range_window_bounds::is_current_row ( ) const

inline

窗口是否限定在当前行。

返回

true 如果窗口限定在当前行

false 如果窗口未限定在当前行

定义于文件 range_window_bounds.hpp 的第 83 行。

is_unbounded()

bool cudf::range_window_bounds::is_unbounded ( ) const

inline

窗口是否是无界的。

返回

true 如果窗口是无界的

false 如果窗口是有限边界的

定义于文件 range_window_bounds.hpp 的第 101 行。

range_scalar()

scalar const& cudf::range_window_bounds::range_scalar ( ) const

inline

返回边界的底层标量值。

返回

边界的底层标量值

定义于文件 range_window_bounds.hpp 的第 108 行。

unbounded()

static range_window_bounds cudf::range_window_bounds::unbounded ( data_type  类型, rmm::cuda_stream_view  流 = cudf::get_default_stream()  )

static

构建无界窗口边界的工厂方法。

参数

类型	窗口边界的数据类型
流	用于设备内存操作和内核启动的 CUDA 流

返回

一个无界窗口边界对象

---

此结构体的文档生成自以下文件：

• range_window_bounds.hpp