cudf::scalar 类参考

表示单个值的拥有类。 更多...

#include <scalar.hpp>

cudf::scalar 的继承图

Public 成员函数
scalar &	operator= (scalar const &other)=delete
scalar &	operator= (scalar &&other)=delete
data_type	type () const noexcept
	返回 scalar 的逻辑值类型。 更多...
void	set_valid_async (bool is_valid, rmm::cuda_stream_view stream=cudf::get_default_stream())
	更新值的有效性。 更多...
bool	is_valid (rmm::cuda_stream_view stream=cudf::get_default_stream()) const
	指示 scalar 是否包含有效值。 更多...
bool *	validity_data ()
	返回指向设备内存中有效性布尔值的原始指针。 更多...
bool const *	validity_data () const
	返回指向设备内存中有效性布尔值的常量原始指针。 更多...

Protected 成员函数
	scalar (scalar &&other)=default
	scalar 的移动构造函数。 更多...
	scalar (scalar const &other, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
	通过深拷贝另一个 scalar 对象构造新的 scalar 对象。 更多...
	scalar (data_type type, bool is_valid=false, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
	构造新的 scalar 对象。 更多...

Protected 属性
data_type	_type {type_id::EMPTY}
	scalar 中值的逻辑类型。
cudf::detail::device_scalar< bool >	_is_valid
	表示有效性的设备端布尔值。

详细描述

表示单个值的拥有类。

scalar 是 cudf 中任何支持数据类型的单个值。从此类派生的类用于表示 scalar。派生类的对象在传递给外部 libcudf API 时应向上转换为此类。

定义于文件 scalar.hpp 的第 51 行。

构造函数与析构函数文档

scalar() [1/3]

cudf::scalar::scalar ( scalar &&  other )

protecteddefault

scalar 的移动构造函数。

参数

other

要从中移动的另一个 scalar。

scalar() [2/3]

cudf::scalar::scalar ( scalar const &  other, rmm::cuda_stream_view  stream = cudf::get_default_stream(), rmm::device_async_resource_ref  mr = cudf::get_current_device_resource_ref()  )

protected

通过深拷贝另一个 scalar 对象构造新的 scalar 对象。

参数

other	要拷贝的 scalar。
stream	用于设备内存操作的 CUDA 流。
mr	用于设备内存分配的设备内存资源。

scalar() [3/3]

cudf::scalar::scalar ( data_type  type, bool  is_valid = false, rmm::cuda_stream_view  stream = cudf::get_default_stream(), rmm::device_async_resource_ref  mr = cudf::get_current_device_resource_ref()  )

protected

构造新的 scalar 对象。

注意

不要直接使用此构造函数。请改用诸如 make_numeric_scalar 或 make_string_scalar 等工厂方法。

参数

type	scalar 的数据类型。
is_valid	scalar 持有的值是否有效。
stream	用于设备内存操作的 CUDA 流。
mr	用于设备内存分配的设备内存资源。

成员函数文档

is_valid()

bool cudf::scalar::is_valid

(

rmm::cuda_stream_view

stream = cudf::get_default_stream()

)

const

指示 scalar 是否包含有效值。

注意

当 is_valid() == false 时使用该值是未定义行为。此外，此函数会进行流同步。

参数

stream

用于设备内存操作的 CUDA 流。

返回值

true 值有效

false 值无效/空

set_valid_async()

void cudf::scalar::set_valid_async	(	bool	is_valid,
		rmm::cuda_stream_view	stream = cudf::get_default_stream()
	)

更新值的有效性。

参数

is_valid	true: 将值设置为有效。 false: 将其设置为空/无效。
stream	用于设备内存操作的 CUDA 流。

type()

data_type cudf::scalar::type ( ) const

noexcept

返回 scalar 的逻辑值类型。

返回值

返回值

validity_data() [1/2]

bool* cudf::scalar::validity_data

(

)

返回指向设备内存中有效性布尔值的原始指针。

返回值

返回值

validity_data() [2/2]

bool const* cudf::scalar::validity_data

(

)

const

返回指向设备内存中有效性布尔值的常量原始指针。

返回值

返回值

---

此类的文档生成自以下文件

• scalar.hpp