libcudf  23.12.00
Public Types | Public Member Functions | List of all members
cudf::fixed_point_scalar_device_view< T > Class Template Reference

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

Inheritance diagram for cudf::fixed_point_scalar_device_view< T >:
cudf::detail::scalar_device_view_base

Public Types

using rep_type = typename T::rep
 The representation type of the fixed_point value.
 

Public Member Functions

 fixed_point_scalar_device_view (data_type type, rep_type *data, bool *is_valid)
 Construct a new fixed point scalar device view object from data and validity pointers. More...
 
void set_value (rep_type value)
 Stores the value in scalar. More...
 
rep_type const & rep () const noexcept
 Get the value of the scalar, as a rep_type. 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

- 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::scalar_device_view_base
data_type _type {type_id::EMPTY}
 Value data type.
 
bool * _is_valid {}
 

Detailed Description

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

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

Definition at line 255 of file scalar_device_view.cuh.

Constructor & Destructor Documentation

◆ fixed_point_scalar_device_view()

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

Construct a new fixed point 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 267 of file scalar_device_view.cuh.

Member Function Documentation

◆ rep()

template<typename T >
rep_type const& cudf::fixed_point_scalar_device_view< T >::rep ( ) const
inlinenoexcept

Get the value of the scalar, as a rep_type.

Returns
The value of the scalar, as a rep_type

Definition at line 284 of file scalar_device_view.cuh.

◆ set_value()

template<typename T >
void cudf::fixed_point_scalar_device_view< T >::set_value ( rep_type  value)
inline

Stores the value in scalar.

Parameters
valueThe value to store in scalar

Definition at line 277 of file scalar_device_view.cuh.


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