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

A type of scalar_device_view that stores a pointer to a numerical value. More...

Inheritance diagram for cudf::numeric_scalar_device_view< T >:
cudf::detail::fixed_width_scalar_device_view< T > cudf::detail::fixed_width_scalar_device_view_base cudf::detail::scalar_device_view_base

Public Member Functions

 numeric_scalar_device_view (data_type type, T *data, bool *is_valid)
 Construct a new numeric scalar device view object from data and validity pointers. More...
 
- Public Member Functions inherited from cudf::detail::fixed_width_scalar_device_view< T >
T & value () noexcept
 Returns reference to stored value. More...
 
T const & value () const noexcept
 Returns const reference to stored value. More...
 
void set_value (T value)
 Stores the value in scalar. More...
 
T * data () noexcept
 Returns a raw pointer to the value in device memory. More...
 
T const * data () const noexcept
 Returns a const raw pointer to the value in device memory. More...
 
- Public Member Functions inherited from cudf::detail::fixed_width_scalar_device_view_base
template<typename T >
T & value () noexcept
 Returns reference to stored value. More...
 
template<typename T >
T const & value () const noexcept
 Returns const reference to stored value. More...
 
template<typename T >
void set_value (T value)
 Stores the value in scalar. More...
 
template<typename T >
T * data () noexcept
 Returns a raw pointer to the value in device memory. More...
 
template<typename T >
T const * data () const noexcept
 Returns a const raw pointer to the value in device memory. More...
 
- Public Member Functions inherited from cudf::detail::scalar_device_view_base
data_type type () const noexcept
 Returns the value type. More...
 
bool is_valid () const noexcept
 Returns whether the scalar holds a valid value (i.e., not null). More...
 
void set_valid (bool is_valid) noexcept
 Updates the validity of the value. More...
 

Additional Inherited Members

- Public Types inherited from cudf::detail::fixed_width_scalar_device_view< T >
using value_type = T
 The value type of the scalar.
 
- Protected Member Functions inherited from cudf::detail::fixed_width_scalar_device_view< T >
 fixed_width_scalar_device_view (data_type type, T *data, bool *is_valid)
 Construct a new fixed width scalar device view object. More...
 
- Protected Member Functions inherited from cudf::detail::fixed_width_scalar_device_view_base
 fixed_width_scalar_device_view_base (data_type type, void *data, bool *is_valid)
 Construct a new fixed width scalar device view object. More...
 
- Protected Member Functions inherited from cudf::detail::scalar_device_view_base
 scalar_device_view_base (data_type type, bool *is_valid)
 Construct a new scalar device view base object from a device pointer and a validity boolean. More...
 
- Protected Attributes inherited from cudf::detail::fixed_width_scalar_device_view_base
void * _data {}
 Pointer to device memory containing the value.
 
- Protected Attributes inherited from cudf::detail::scalar_device_view_base
data_type _type {type_id::EMPTY}
 Value data type.
 
bool * _is_valid {}
 

Detailed Description

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

A type of scalar_device_view that stores a pointer to a numerical value.

Definition at line 235 of file scalar_device_view.cuh.

Constructor & Destructor Documentation

◆ numeric_scalar_device_view()

template<typename T >
cudf::numeric_scalar_device_view< T >::numeric_scalar_device_view ( data_type  type,
T *  data,
bool *  is_valid 
)
inline

Construct a new numeric scalar device view object from data and validity pointers.

Parameters
typeThe data type of the value
dataThe pointer to the data in device memory
is_validThe pointer to the bool in device memory that indicates the validity of the stored value

Definition at line 245 of file scalar_device_view.cuh.


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