Public Types | Public Member Functions | List of all members
cudf::string_scalar_device_view Class Reference

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

Inheritance diagram for cudf::string_scalar_device_view:
cudf::detail::scalar_device_view_base

Public Types

using ValueType = cudf::string_view
 The value type of the string scalar.
 

Public Member Functions

 string_scalar_device_view (data_type type, char const *data, bool *is_valid, size_type size)
 Construct a new string scalar device view object from string data, size and validity pointers. More...
 
ValueType value () const noexcept
 Returns string_view of the value of this scalar. More...
 
char const * data () const noexcept
 Returns a raw pointer to the value in device memory. More...
 
size_type size () const noexcept
 Returns the size of the string in bytes. 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

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

Definition at line 293 of file scalar_device_view.cuh.

Constructor & Destructor Documentation

◆ string_scalar_device_view()

cudf::string_scalar_device_view::string_scalar_device_view ( data_type  type,
char const *  data,
bool *  is_valid,
size_type  size 
)
inline

Construct a new string scalar device view object from string data, size and validity pointers.

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

Definition at line 307 of file scalar_device_view.cuh.

Member Function Documentation

◆ data()

char const* cudf::string_scalar_device_view::data ( ) const
inlinenoexcept

Returns a raw pointer to the value in device memory.

Returns
Raw pointer to the value in device memory

Definition at line 327 of file scalar_device_view.cuh.

◆ size()

size_type cudf::string_scalar_device_view::size ( ) const
inlinenoexcept

Returns the size of the string in bytes.

Returns
The size of the string in bytes

Definition at line 337 of file scalar_device_view.cuh.

◆ value()

ValueType cudf::string_scalar_device_view::value ( ) const
inlinenoexcept

Returns string_view of the value of this scalar.

Returns
string_view of the value of this scalar

Definition at line 317 of file scalar_device_view.cuh.


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