A type-erased scalar_device_view where the value is a fixed width type. More...
Public Member Functions | |
| 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_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 | |
| 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
A type-erased scalar_device_view where the value is a fixed width type.
Definition at line 80 of file scalar_device_view.cuh.
Constructor & Destructor Documentation
◆ fixed_width_scalar_device_view_base()
|
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
-
type The data type of the value data The pointer to the data in device memory is_valid The pointer to the bool in device memory that indicates the validity of the stored value
Definition at line 156 of file scalar_device_view.cuh.
Member Function Documentation
◆ data() [1/2]
|
inlinenoexcept |
Returns a const raw pointer to the value in device memory.
- Template Parameters
-
T The desired type
- Returns
- Const raw pointer to the value in device memory
Definition at line 137 of file scalar_device_view.cuh.
◆ data() [2/2]
|
inlinenoexcept |
Returns a raw pointer to the value in device memory.
- Template Parameters
-
T The desired type
- Returns
- Raw pointer to the value in device memory
Definition at line 125 of file scalar_device_view.cuh.
◆ set_value()
|
inline |
Stores the value in scalar.
- Template Parameters
-
T The desired type
- Parameters
-
value The value to store in scalar
Definition at line 113 of file scalar_device_view.cuh.
◆ value() [1/2]
|
inlinenoexcept |
Returns const reference to stored value.
- Template Parameters
-
T The desired type
- Returns
- Const reference to stored value
Definition at line 101 of file scalar_device_view.cuh.
◆ value() [2/2]
|
inlinenoexcept |
Returns reference to stored value.
- Template Parameters
-
T The desired type
- Returns
- Reference to stored value
Definition at line 89 of file scalar_device_view.cuh.
The documentation for this class was generated from the following file:
