Public Types | Public Member Functions | Protected Member Functions | List of all members
cudf::detail::fixed_width_scalar_device_view< T > Class Template Reference

A type of scalar_device_view where the value is a fixed width type. More...

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

Public Types

using value_type = T
 The value type of the scalar.
 

Public Member Functions

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...
 

Protected Member Functions

 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...
 

Additional Inherited Members

- 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::detail::fixed_width_scalar_device_view< T >

A type of scalar_device_view where the value is a fixed width type.

Definition at line 166 of file scalar_device_view.cuh.

Constructor & Destructor Documentation

◆ fixed_width_scalar_device_view()

template<typename T >
cudf::detail::fixed_width_scalar_device_view< T >::fixed_width_scalar_device_view ( data_type  type,
T *  data,
bool *  is_valid 
)
inlineprotected

Construct a new fixed width scalar device view object.

This constructor should not be used directly. get_scalar_device_view should be used to get the view of an existing scalar

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 223 of file scalar_device_view.cuh.

Member Function Documentation

◆ data() [1/2]

template<typename T >
T const* cudf::detail::fixed_width_scalar_device_view< T >::data ( ) const
inlinenoexcept

Returns a const raw pointer to the value in device memory.

Returns
Const raw pointer to the value in device memory

Definition at line 206 of file scalar_device_view.cuh.

◆ data() [2/2]

template<typename T >
T* cudf::detail::fixed_width_scalar_device_view< T >::data ( )
inlinenoexcept

Returns a raw pointer to the value in device memory.

Returns
Raw pointer to the value in device memory

Definition at line 199 of file scalar_device_view.cuh.

◆ set_value()

template<typename T >
void cudf::detail::fixed_width_scalar_device_view< T >::set_value ( value)
inline

Stores the value in scalar.

Parameters
valueThe value to store in scalar

Definition at line 192 of file scalar_device_view.cuh.

◆ value() [1/2]

template<typename T >
T const& cudf::detail::fixed_width_scalar_device_view< T >::value ( ) const
inlinenoexcept

Returns const reference to stored value.

Returns
Const reference to stored value

Definition at line 182 of file scalar_device_view.cuh.

◆ value() [2/2]

template<typename T >
T& cudf::detail::fixed_width_scalar_device_view< T >::value ( )
inlinenoexcept

Returns reference to stored value.

Returns
Reference to stored value

Definition at line 175 of file scalar_device_view.cuh.


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