Public Member Functions | List of all members
cudf::chrono_scalar< T > Class Template Reference

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

#include <scalar.hpp>

Inheritance diagram for cudf::chrono_scalar< T >:
cudf::detail::fixed_width_scalar< T > cudf::scalar cudf::duration_scalar< T > cudf::timestamp_scalar< T >

Public Member Functions

 chrono_scalar (chrono_scalar &&other)=default
 
 chrono_scalar (chrono_scalar const &other)=default
 
chrono_scalaroperator= (chrono_scalar const &other)=delete
 
chrono_scalaroperator= (chrono_scalar &&other)=delete
 
 chrono_scalar (T value, bool is_valid=true, rmm::cuda_stream_view stream=rmm::cuda_stream_default, 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=rmm::cuda_stream_default, 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
 
 fixed_width_scalar (fixed_width_scalar const &other)=default
 
fixed_width_scalaroperator= (fixed_width_scalar const &other)=delete
 
fixed_width_scalaroperator= (fixed_width_scalar &&other)=delete
 
void set_value (T value, rmm::cuda_stream_view stream=rmm::cuda_stream_default)
 Set the value of the scalar. More...
 
 operator value_type () const
 Implicit conversion operator to get the value of the scalar on the host.
 
value (rmm::cuda_stream_view stream=rmm::cuda_stream_default) const
 Get the value of the scalar. More...
 
T * data ()
 Returns a raw pointer to the value in device memory.
 
T const * data () const
 Returns a const raw pointer to the value in device memory.
 
- Public Member Functions inherited from cudf::scalar
 scalar (scalar &&other)=default
 
 scalar (scalar const &other)=default
 
scalaroperator= (scalar const &other)=delete
 
scalaroperator= (scalar &&other)=delete
 
data_type type () const noexcept
 Returns the scalar's logical value type.
 
void set_valid (bool is_valid, rmm::cuda_stream_view stream=rmm::cuda_stream_default)
 Updates the validity of the value. More...
 
bool is_valid (rmm::cuda_stream_view stream=rmm::cuda_stream_default) const
 Indicates whether the scalar contains a valid value. More...
 
bool * validity_data ()
 Returns a raw pointer to the validity bool in device memory.
 
bool const * validity_data () const
 Returns a const raw pointer to the validity bool in device memory.
 

Additional Inherited Members

- Public Types inherited from cudf::detail::fixed_width_scalar< T >
using value_type = T
 
- 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=rmm::cuda_stream_default, 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=rmm::cuda_stream_default, 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 (data_type type, bool is_valid=false, rmm::cuda_stream_view stream=rmm::cuda_stream_default, 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::chrono_scalar< T >

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

Template Parameters
Tthe data type of the timestamp/duration value
See also
cudf/wrappers/timestamps.hpp, cudf/wrappers/durations.hpp for a list of allowed types

Definition at line 489 of file scalar.hpp.

Constructor & Destructor Documentation

◆ chrono_scalar() [1/2]

template<typename T >
cudf::chrono_scalar< T >::chrono_scalar ( value,
bool  is_valid = true,
rmm::cuda_stream_view  stream = rmm::cuda_stream_default,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)
inline

Construct a new chrono scalar object.

Parameters
[in]valueThe initial value of the scalar
[in]is_validWhether the value held by the scalar is valid
[in]streamCUDA stream used for device memory operations.
[in]mrDevice memory resource to use for device memory allocation

Definition at line 508 of file scalar.hpp.

◆ chrono_scalar() [2/2]

template<typename T >
cudf::chrono_scalar< T >::chrono_scalar ( rmm::device_scalar< T > &&  data,
bool  is_valid = true,
rmm::cuda_stream_view  stream = rmm::cuda_stream_default,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)
inline

Construct a new chrono scalar object from existing device memory.

Parameters
[in]dataThe scalar's data in device memory
[in]is_validWhether the value held by the scalar is valid
[in]streamCUDA stream used for device memory operations.
[in]mrDevice memory resource to use for device memory allocation

Definition at line 524 of file scalar.hpp.


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