An owning class to represent a duration value in device memory. More...

#include <scalar.hpp>

Inheritance diagram for cudf::duration_scalar< T >:

Public Types
using	rep_type = typename T::rep
	The duration's underlying representation type.

Public Types inherited from cudf::detail::fixed_width_scalar< T >
using	value_type = T
	Type of the value held by the scalar.

Public Member Functions
	duration_scalar (duration_scalar &&other)=default
	Move constructor for duration_scalar. More...

	duration_scalar (duration_scalar const &other, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new duration scalar object by deep copying another. More...

	duration_scalar (rep_type value, bool is_valid, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new duration scalar object from tick counts. More...

rep_type	count (rmm::cuda_stream_view stream)
	Returns the duration in number of ticks. More...

Public Member Functions inherited from cudf::chrono_scalar< T >
	chrono_scalar (chrono_scalar &&other)=default
	Move constructor for chrono_scalar. More...

chrono_scalar &	operator= (chrono_scalar const &other)=delete

chrono_scalar &	operator= (chrono_scalar &&other)=delete

	chrono_scalar (chrono_scalar const &other, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new chrono scalar object by deep copying another. More...

	chrono_scalar (T value, bool is_valid=true, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new chrono scalar object. More...

	chrono_scalar (rmm::device_scalar< T > &&data, bool is_valid=true, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new chrono scalar object from existing device memory. More...

Public Member Functions inherited from cudf::detail::fixed_width_scalar< T >
	fixed_width_scalar (fixed_width_scalar &&other)=default
	Move constructor for fixed_width_scalar. More...

fixed_width_scalar &	operator= (fixed_width_scalar const &other)=delete

fixed_width_scalar &	operator= (fixed_width_scalar &&other)=delete

	fixed_width_scalar (fixed_width_scalar const &other, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new fixed-width scalar object by deep copying another. More...

void	set_value (T value, rmm::cuda_stream_view stream=cudf::get_default_stream())
	Set the value of the scalar. More...

	operator value_type () const
	Explicit conversion operator to get the value of the scalar on the host.

T	value (rmm::cuda_stream_view stream=cudf::get_default_stream()) const
	Get the value of the scalar. More...

T *	data ()
	Returns a raw pointer to the value in device memory. More...

T const *	data () const
	Returns a const raw pointer to the value in device memory. More...

Public Member Functions inherited from cudf::scalar
scalar &	operator= (scalar const &other)=delete

scalar &	operator= (scalar &&other)=delete

data_type	type () const noexcept
	Returns the scalar's logical value type. More...

void	set_valid_async (bool is_valid, rmm::cuda_stream_view stream=cudf::get_default_stream())
	Updates the validity of the value. More...

bool	is_valid (rmm::cuda_stream_view stream=cudf::get_default_stream()) const
	Indicates whether the scalar contains a valid value. More...

bool *	validity_data ()
	Returns a raw pointer to the validity bool in device memory. More...

bool const *	validity_data () const
	Return a const raw pointer to the validity bool in device memory. More...

Additional Inherited Members
Protected Member Functions inherited from cudf::detail::fixed_width_scalar< T >
	fixed_width_scalar (T value, bool is_valid=true, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new fixed width scalar object. More...

	fixed_width_scalar (rmm::device_scalar< T > &&data, bool is_valid=true, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new fixed width scalar object from existing device memory. More...

Protected Member Functions inherited from cudf::scalar
	scalar (scalar &&other)=default
	Move constructor for scalar. More...

	scalar (scalar const &other, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new scalar object by deep copying another. More...

	scalar (data_type type, bool is_valid=false, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
	Construct a new scalar object. More...

Protected Attributes inherited from cudf::detail::fixed_width_scalar< T >
rmm::device_scalar< T >	_data
	device memory containing the value

Protected Attributes inherited from cudf::scalar
data_type	_type {type_id::EMPTY}
	Logical type of value in the scalar.

rmm::device_scalar< bool >	_is_valid
	Device bool signifying validity.

Detailed Description

template<typename T>
class cudf::duration_scalar< T >

An owning class to represent a duration value in device memory.

Template Parameters

T	the data type of the duration value.

See also: cudf/wrappers/durations.hpp for a list of allowed types.

Definition at line 680 of file scalar.hpp.

Constructor & Destructor Documentation

◆ duration_scalar() [1/3]

template<typename T >

cudf::duration_scalar< T >::duration_scalar ( duration_scalar< T > && other )

default

Move constructor for duration_scalar.

Parameters

other The other duration_scalar to move from.

◆ duration_scalar() [2/3]

template<typename T >

cudf::duration_scalar< T >::duration_scalar	(	duration_scalar< T > const &	other,
		rmm::cuda_stream_view	stream = `cudf::get_default_stream()`,
		rmm::mr::device_memory_resource *	mr = `rmm::mr::get_current_device_resource()`
	)

Construct a new duration scalar object by deep copying another.

Parameters

other	The scalar to copy.
stream	CUDA stream used for device memory operations.
mr	Device memory resource to use for device memory allocation.

◆ duration_scalar() [3/3]

template<typename T >

cudf::duration_scalar< T >::duration_scalar	(	rep_type	value,
		bool	is_valid,
		rmm::cuda_stream_view	stream = `cudf::get_default_stream()`,
		rmm::mr::device_memory_resource *	mr = `rmm::mr::get_current_device_resource()`
	)

Construct a new duration scalar object from tick counts.

Parameters

value	Integer representing number of ticks since the UNIX epoch.
is_valid	Whether the value held by the scalar is valid.
stream	CUDA stream used for device memory operations.
mr	Device memory resource to use for device memory allocation.

Member Function Documentation

◆ count()

template<typename T >

rep_type cudf::duration_scalar< T >::count ( rmm::cuda_stream_view stream )

Returns the duration in number of ticks.

Parameters

stream CUDA stream used for device memory operations.

Returns: The duration in number of ticks

The documentation for this class was generated from the following file:

scalar.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class cudf::duration_scalar< T >

Constructor & Destructor Documentation

◆ duration_scalar() [1/3]

◆ duration_scalar() [2/3]

◆ duration_scalar() [3/3]

Member Function Documentation

◆ count()

template<typename T>
class cudf::duration_scalar< T >